home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / WW4SHARE / WWIV430.ZIP / menu.doc < prev    next >
Text File  |  2000-03-06  |  11KB  |  649 lines

  1. Menu commands are called by there name and a number of options parameters.
  2.  
  3. The following forms are valid syntax
  4.  
  5. command without parameters  : menucmd
  6. command with one parameter  : menucmd "xyz"
  7. command with two parameters : menucmd 123, "abc def"
  8. command with two parameters : menucmd(456,"abc")
  9.  
  10.  
  11.  
  12. You can stack multiple menu commands by seperating them with the ~ key.
  13.  
  14. The following code ...
  15.  
  16. menucmd1 ~ menucmd2("abc") ~ menucmd3 "abc", 123
  17.  
  18. ... will execute menucmd1 (without any parameters), menucmd2 with abc as a
  19. parameter, and finally, menucmd3 with "abc" and 123 as parameters.
  20.  
  21.  
  22. Most menu commands run without any parameters at all, and most are taken
  23. straight from the main and xfer menus.  Additional commands are added to
  24. manage the menu system as well as a few commands which will help you to
  25. emulate other BBSes.
  26.  
  27.  
  28. MENU <menu>
  29.  
  30.   Loads up and starts running a new menu set, where <menu> equals the name of
  31.   the menu to load.
  32.  
  33.  
  34. ReturnFromMenu
  35.  
  36.   Unloads the current menu and goes back to the menu that loaded the current
  37.   one.  If you try to return from the very first menu, it will just be reloaded
  38.  
  39.  
  40. EditMenuSet
  41.  
  42.   This command will take you into the menu editor.  Keep carefull to keep this
  43.   command tied down as anyone with access to the menu editor will have 100%
  44.   access to your system.
  45.  
  46.  
  47.  
  48. DLFreeFile <dirfname> <filename>
  49.  
  50.   This will download a file, but not check ratios or charge a download charge.
  51.   You must specify the dirfilename, which is the name of the data file in
  52.   the transfer editor.  filename is the name of the file being downloaded.
  53.  
  54.  
  55.  
  56. DLFile
  57.  
  58.   This will download a file, with a check for ratios and will update the
  59.   kb downloaded and number of files downloaded.
  60.   You must specify the dirfilename, which is the name of the data file in
  61.   the transfer editor.  filename is the name of the file being downloaded.
  62.  
  63.  
  64. RunDoor <doorname>
  65.  
  66.   Runs a door (chain) with doorname matching, exactly, the description you have
  67.   given the door in //CHEDIT
  68.  
  69.  
  70. RunDoorFree <doorname>
  71.  
  72.   Runs a door (chain) with doorname matching, exactly, the description you have
  73.   given the door in //CHEDIT, but this function bypasses the check to see if
  74.   the user is allowed to run the door.
  75.  
  76. RunDoorNumber <door#>
  77.  
  78.   Like RunDoor, but you must specify the #1 in //CHEDIT instead of the
  79.   description.
  80.  
  81. RunDoorNumberFree
  82.  
  83.   Like RunDoorFree, but you must specify the #1 in //CHEDIT instead of the
  84.   description.
  85.  
  86. PrintFile <filename>
  87.  
  88.   Prints a file, first checking to see if you specified an absolute path,
  89.   then the language dir, then the gfilesdir.  It will use the usual checks to
  90.   determin .ANS, or .MSG if not specified.
  91.  
  92. PrintFileNA <filename>
  93.  
  94.   Just like PrintFile, but the user can not abort it with the space bar.
  95.  
  96.  
  97.  
  98. SetSubNumber <key>
  99.  
  100.   Equivalent to typing in a number at the main menu, it sets the current sub
  101.   number.
  102.  
  103. SetDirNumber <key>
  104.  
  105.   Equivalent to typing in a number at the xfer menu, it sets the current dir
  106.   number.
  107.  
  108. SetMsgConf <key>
  109.  
  110.   Sets the subboards conference to key
  111.  
  112. SetDirConf <key>
  113.  
  114.   Sets the xfer section conference to key
  115.  
  116.  
  117. EnableConf
  118.  
  119.   Turns conferencing on
  120.  
  121. DisableConf
  122.  
  123.   Turns conferencing off
  124.  
  125. Pause
  126.  
  127.   Pauses the screen, like 'pausescr()' in C code
  128.  
  129. ConfigUserMenuSet
  130.  
  131.   Takes the user into the user menu config so they can select which menuset
  132.   they want to use, etc...
  133.  
  134. DisplayHelp <filename>
  135.  
  136.   Prints the 'novice menus' for the current menu set, or if one doesn't exist,
  137.   it will generate one using the menu definitions.
  138.  
  139. SelectSub
  140.  
  141.   This will prompt the user to enter a sub to change to.  However, it does not
  142.   first show the subs (like Renegade).  However, you can stack a sublist and
  143.   then this command to mimic the action.
  144.  
  145. SelectDir
  146.  
  147.   Like SelectSub, but for the xfer section.
  148.  
  149.  
  150. SubList
  151.  
  152.   List the subs available
  153.  
  154.  
  155. UpSubConf
  156.  
  157.   Increment ()) to the previous conference number
  158.  
  159.  
  160. DownSubConf
  161.  
  162.   Decrement ({) to the next sub conference
  163.  
  164. UpSub
  165.  
  166.   Increment the current sub# (+)
  167.  
  168. DownSub
  169.  
  170.   Decrement the current sub number (-)
  171.  
  172. ValidateUser
  173.  
  174.   Validate a new users.  I think this '!'
  175.  
  176. Doors
  177.  
  178.   Enter the doors, or chains section.  Like '.'
  179.  
  180.  
  181. TimeBank
  182.  
  183.   Enter the time bank
  184.  
  185.  
  186. AutoMessage
  187.  
  188.   Read the auto message
  189.  
  190. BBSList
  191.  
  192.   Read the bbslist
  193.  
  194.  
  195. RequestChat
  196.  
  197.   Request chat from the sysop
  198.  
  199. Defaults
  200.  
  201.   Enter the normal 'defaults' section
  202.  
  203.  
  204. SendEMail
  205.  
  206.   Enter and send email 'E' from the main menu
  207.  
  208. Feedback
  209.  
  210.   Leave feedback to the syosp.  'F'
  211.  
  212. Bulletins
  213.  
  214.   Enter the bulletins (or 'gfiles') section.  'G'
  215.  
  216.  
  217. HopSub
  218.  
  219.   Hop to another sub.  'H'
  220.  
  221.  
  222. SystemInfo
  223.  
  224.   View the system info
  225.  
  226. JumpSubConf
  227.  
  228.   Jump to another sub conference.
  229.  
  230. KillEMail
  231.  
  232.   Kill email that you have sent 'K'
  233.  
  234.  
  235. LastCallers
  236.  
  237.   View the last few callers
  238.  
  239. ReadEMail
  240.  
  241.   Read your email
  242.  
  243. NewMessageScan
  244.  
  245.   Do a new message scan
  246.  
  247. Goodbye
  248.  
  249.   Normal logoff 'O'
  250.  
  251. PostMessage
  252.  
  253.   Post a message in the current sub
  254.  
  255. NewMsgScanCurSub
  256.  
  257.   Scan new messages in the current message sub
  258.  
  259. RemovePost
  260.  
  261.   Remove a post
  262.  
  263. TitleScan
  264.  
  265.   Scan the titles of the messages in the current sub
  266.  
  267. ListUsers
  268.  
  269.   List users who have access to the current sub
  270.  
  271. Vote
  272.  
  273.   Enter the voting both
  274.  
  275. ToggleExpert
  276.  
  277.   Turn 'X'pert mode on or off (toggle)
  278.  
  279.  
  280. YourInfo
  281.  
  282.   Display the yourinfo screen
  283.  
  284. ExpressScan
  285.  
  286.   I think this will scan all new messages without pausing.
  287.  
  288. WWIVVer
  289.  
  290.   Get the wwiv version
  291.  
  292. InstanceEdit
  293.  
  294.   Sysop command to edit the instances
  295.  
  296. ConferenceEdit
  297.  
  298.   Sysop command ot edit the conferences
  299.  
  300. SubEdit
  301.  
  302.   Sysop command to edit the subboards
  303.  
  304. ChainEdit
  305.  
  306.   Sysop command to edit the doors or chains
  307.  
  308. ToggleAvailable
  309.  
  310.   Toggle the sysop availability for chat
  311.  
  312. ChangeUser
  313.  
  314.   Sysop command equal to //CHUSER, to change into another users
  315.  
  316. CLOUT
  317.  
  318.   Who knows, sopposed to do a callout
  319.  
  320. Debug
  321.  
  322.   Who knows, some debug mode
  323.  
  324. DirEdit
  325.  
  326.   Sysop command to edit the directory records
  327.  
  328. ShellDOS
  329.  
  330.   Sysop command to shell to dos
  331.  
  332. Edit
  333.  
  334.   Sysop command to edit a text file
  335.  
  336. BulletinEdit
  337.  
  338.   Sysop command to edit the bulletins 'gfiles'
  339.  
  340. LoadText
  341.  
  342.   Sysop command to load a text file that will be edited in the text editor
  343.  
  344. ReadAllMail
  345.  
  346.   Sysop command to read all mail
  347.  
  348. Reboot
  349.  
  350.   Sysop command to reboot the machine
  351.  
  352. ReloadMenus
  353.  
  354.   This is probably obsolete.
  355.  
  356. ResetUserIndex
  357.  
  358.   Rebuild the user index.  //RESETF if I am not mistaken
  359.  
  360. ResetQScan
  361.  
  362.   Set all messages to read (I think)
  363.  
  364. MemStat
  365.  
  366.   Show memory stats. //STAT
  367.  
  368. PackMsgs
  369.  
  370.   Pack message bases.
  371.  
  372. VoteEdit
  373.  
  374.   Sysop command to edit the voting both
  375.  
  376. Log
  377.  
  378.   Syosp command to view the log file
  379.  
  380. NetLog
  381.  
  382.   Sysop command to view the network log
  383.  
  384. Pending
  385.  
  386.   Shows which net files are ready to be sent
  387.  
  388. Status
  389.  
  390.   Who knows...
  391.  
  392. TextEdit
  393.  
  394.   Edit a text file
  395.  
  396. UserEdit
  397.  
  398.   Sysop command to edit users
  399.  
  400. VotePrint
  401.  
  402.   Show the voting statistics
  403.  
  404. YLog
  405.  
  406.   View yesterdays log
  407.  
  408. ZLog
  409.  
  410.   View the ZLog
  411.  
  412. ViewNetDataLog
  413.  
  414.   View the net data logs
  415.  
  416. UploadPost
  417.  
  418.   Allow a user to upload a post that will be posted
  419.  
  420. CLS
  421.  
  422.   Clear the screen
  423.  
  424. NetListing
  425.  
  426.   Show networks
  427.  
  428. WHO
  429.  
  430.   Show who else is online
  431.  
  432. NewMsgsAllConfs
  433.  
  434.   Do a new message scan for all subs in all conferences '/A'
  435.  
  436. MultiEMail
  437.  
  438.   Send multi-email
  439.  
  440. NewMsgScanFromHere
  441.  
  442.   Read new messages starting from the current sub
  443.  
  444.  
  445. ValidatePosts
  446.  
  447.   Sysop command to validate unvalidated posts
  448.  
  449. ChatRoom
  450.  
  451.   Go into the multiuser chat room
  452.  
  453. DownloadPosts
  454.  
  455.   Download all new posts in a text file
  456.  
  457. DownloadFileList
  458.  
  459.   Download the file list in a text file
  460.  
  461. ClearQScan
  462.  
  463.   Makes all message unread???
  464.  
  465. FastGoodBye
  466.  
  467.   Logoff fast '/O'
  468.  
  469. NewFilesAllConfs
  470.  
  471.   New file scan in all directories in all conferences
  472.  
  473.  
  474. ReadIDZ
  475.  
  476.   Sysop command to read the file_id.diz and add it to the extended description
  477.  
  478. UploadAllDirs
  479.  
  480.   Syosp command to add any files sitting in the directories, but not in
  481.   the file database to wwiv's file database
  482.  
  483. UploadCurDir
  484.  
  485.   Sysop command to scan the current directory for any files that are not in
  486.   wwiv's file database and adds them to it.
  487.  
  488. RenameFiles
  489.  
  490.   Sysop command to edit and rename files
  491.  
  492. MoveFiles
  493.  
  494.   Sysop command to move files
  495.  
  496. SortDirs
  497.  
  498.   Sort the directory by date or name
  499.  
  500. ReverseSortDirs
  501.  
  502.   Sort the directory by date or name, backwards.
  503.  
  504. AllowEdit
  505.  
  506.   Sysop command to enter the 'ALLOW.DAT' editor.
  507.  
  508. ReadINI
  509.  
  510.   Re-read the INI files
  511.  
  512. UploadFilesBBS
  513.  
  514.   Import a files.bbs (probably a CD) into the wwiv's file database
  515.  
  516. DirList
  517.  
  518.   List the directory names in the xfer section
  519.  
  520. UpDirConf
  521.  
  522.   Go to the next directory conference '}'
  523.  
  524. UpDir
  525.  
  526.   Go to the next directory number '+'
  527.  
  528. DownDirConf
  529.  
  530.   Go to the prior directory conference '{'
  531.  
  532. DownDir
  533.  
  534.   Go to the prior directory number '-'
  535.  
  536. ListUsersDL
  537.  
  538.   List users with access to the current xfer sub
  539.  
  540. PrintDSZLog
  541.  
  542.   View the DSZ log
  543.  
  544. PrintDevices
  545.  
  546.   Show the 'devices'.  I have no idea why.
  547.  
  548. ViewArchive
  549.  
  550.   List an archive's contents
  551.  
  552. BatchMenu
  553.  
  554.   Enter the batch menu 'B'
  555.  
  556. Download
  557.  
  558.   Download a file 'D'
  559.  
  560. TempExtract
  561.  
  562.   Extract an archive to the temp directory
  563.  
  564. FindDescription
  565.  
  566.   Search for a file by description
  567.  
  568. ArchiveMenu
  569.  
  570.   Enter the archive menu
  571.  
  572. HopDir
  573.  
  574.   Hop to another directory number 'H'
  575.  
  576. JumpDirConf
  577.  
  578.   Jump to another directory conference 'J'
  579.  
  580. ListFiles
  581.  
  582.   List the file in the current directory
  583.  
  584. NewFileScan
  585.  
  586.   List files that are new since your 'New Scan Date (usually last call)' 'N'
  587.  
  588. SetNewFileScanDate
  589.  
  590.   Set the 'New Scan Data' to a new date
  591.  
  592. RemoveFiles
  593.  
  594.   Remove a file you uploaded
  595.  
  596. SearchAllFiles
  597.  
  598.   Search all files???
  599.  
  600. XferDefaults
  601.  
  602.   Enter the xfer section defaults
  603.  
  604. Upload
  605.  
  606.   User upload a file
  607.  
  608. YourInfoDL
  609.  
  610.   Prints user info for downloads
  611.  
  612. UploadToSysop
  613.  
  614.   Upload a file into dir#0, the sysop dir.
  615.  
  616. ReadAutoMessage
  617.  
  618.   Read the auto message
  619.  
  620. SetNewScanMsg
  621.  
  622.   Enter the menu so that a user can set which subs he want to scan when doing
  623.   a new message scan
  624.  
  625. ReadMessages
  626.  
  627.   Read messages in the current sub
  628.  
  629. RUN
  630.  
  631.   In a future version, this will run a script file
  632.  
  633. EventEdit
  634.  
  635.   Sysop command to enter the event editor
  636.  
  637. LoadTextFile
  638.  
  639.   Looks like a duplicate to 'LoadText'
  640.  
  641. GuestApply
  642.  
  643.   Allows a guest to apply for access
  644.  
  645.  
  646. ConfigFileList
  647.  
  648.   Enter the List+ configurator so the user can set it up to look like he wants
  649.