home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / PROG / UTILITY / SMUT100.ZIP / SMUT.HLP < prev    next >
Encoding:
Text File  |  1991-03-14  |  16.8 KB  |  429 lines
  1. #COMPARE
  2. Format:      COMPARE <file1> <file2>
  3.  
  4. Priority:    1
  5.  
  6. Description: Compare the files <file1> and <file2> for equality. Both <file1>
  7.          and <file2> can be either a generation or a DOS file. SMUT
  8.          scans the field for a semicolon (;) to determine which.
  9. #CREATE CLASS
  10. Format:      CREATE CLASS <class name> [<remark>]
  11.  
  12. Priority:    2
  13.  
  14. Description: Create a class of the specified name.
  15. #CREATE ELEMENT
  16. Format:      CREATE ELEMENT <element name> [<remark>] {-F<file>|-K}
  17.  
  18. Priority:    2
  19.  
  20. Description: Create the named element at generation 1 from an input file.
  21.  
  22.              By default the input file is the file in the current working
  23.              directory with the same name as the element. Alternatively this
  24.              can be overridden by including the F flag and specifying a
  25.              different input file.
  26.  
  27.              Normally the input file is deleted after the element is 
  28.              created. This can be suppressed by specifying the K flag.
  29. #CREATE GROUP
  30. Format:      CREATE GROUP <group name> [<remark>]
  31.  
  32. Priority:    2
  33.  
  34. Description: Create a group of the specified name.
  35. #CREATE LIBRARY
  36. Format:      CREATE LIBRARY <library directory> <user name> [<remark>]
  37.  
  38. Priority:    0
  39.  
  40. Description: Create a library in the specified directory. Create a user of 
  41.              the specified name in the new library. The users password will 
  42.              be set to be identical to its name and the user priority to 3. 
  43.              The newly created library and user become the current library
  44.              and user. If the specified library directory exists then it 
  45.              must be empty; if it does not exist it will be created 
  46.              providing it is a subdirectory of an existing directory.
  47. #CREATE USER
  48. Format:      CREATE USER <user name> [<remark>] [-P<priority>]
  49.  
  50. Priority:    3
  51.  
  52. Description: Create a user of the specified name. Associate the specified 
  53.              remark with the user. The user priority will default to 1 
  54.              unless overridden by the P flag. The user password will be 
  55.              prompted twice. Input of the password will not be echoed and 
  56.              only if both inputs match will the user be created.
  57. #DELETE CLASS
  58. Format:      DELETE CLASS <class name> [<remark>] [-R]
  59.  
  60. Priority:    2
  61.  
  62. Description: Delete the specified class. If the -R flag is specified then 
  63.              any generations contained in the class are first removed. If 
  64.              the -R flag is not specified then deletion will only be 
  65.              allowed if the class is already empty.
  66. #DELETE ELEMENT
  67. Format:      DELETE ELEMENT <element name> [<remark>]
  68.  
  69. Priority:    2
  70.  
  71. Description: Delete the specified element. If the element is contained in a 
  72.              group, any of its generations are contained in a class, or any 
  73.              of its generations are reserved then deletion will be 
  74.              disallowed.
  75. #DELETE GROUP
  76. Format:      DELETE GROUP <group name> [<remark>] [-R]
  77.  
  78. Priority:    2
  79.  
  80. Description: Delete the specified group. If the -R flag is specified then 
  81.              any elements contained in the group are first removed. If the 
  82.              -R flag is not specified then deletion will only be allowed if 
  83.              the group is already empty.
  84. #DELETE HISTORY
  85. Format:      DELETE HISTORY [<before date>]
  86.  
  87. Priority:    3
  88.  
  89. Description: Delete all or part of the contents of the history file. If 
  90.              <before date> is specified then all history records on or 
  91.              before that date are deleted. If <before date> is not 
  92.              specified then all history records are deleted.
  93. #DELETE LIBRARY
  94. Format:      DELETE LIBRARY
  95.  
  96. Priority:    3
  97.  
  98. Description: Delete the current library. The operator is asked to input the 
  99.              present users password again to confirm that library deletion 
  100.              is required. Following deletion the current library and user 
  101.              become unset.
  102. #DELETE USER
  103. Format:      DELETE USER <user name> [<remark>]
  104.  
  105. Priority:    3
  106.  
  107. Description: Delete the specified user. Deletion is only allowed if the 
  108.              specified user has no outstanding reservations. It is not 
  109.              possible to delete the current user, hence the library can 
  110.              never contain less than one priority 3 user.
  111. #DIFFERENCE
  112. Format:      DIFFERENCE <file1> <file2> [<remark>]
  113.                 {-F<output file>|-H|-N|-W<window size>|-M<max differences>}
  114.  
  115. Priority:    1
  116.  
  117. Description: Find the differences between text files <file1> and <file2>. The
  118.          output is either sent to file <output file> if the F flag is
  119.          specified or the screen if it is not. Both <file1> and <file2>
  120.              can be either a generation or a DOS file. SMUT scans the field 
  121.          for a semicolon (;) to determine which. Normally line numbers
  122.              are generated in the output, this can be suppressed by 
  123.              specifying the N flag. The difference process can be caused to 
  124.              terminate after a certain number of differences have been 
  125.              encountered using the M flag. If the M flag is not specified 
  126.              then the difference process will run until all differences are 
  127.              found.
  128.  
  129.              The difference process is achieved by scanning a window across 
  130.              both files and looking for a match. The default window size is 
  131.              3 however this can be overridden using the W flag.
  132.  
  133.              This command will only be recorded in the history file if the
  134.              H flag is specified.
  135. #FETCH GENERATION
  136. Format:      FETCH GENERATION <generation> [<remark>] {-F<filename>|-H}
  137.  
  138. Priority:    1
  139.  
  140. Description: Fetch a specific generation but do not mark it as reserved.
  141.              Normally the generation is copied into the current working
  142.              directory and given the same name as the generation. This can be
  143.              overriden with the F flag which will allow the generation to be
  144.              copied to any directory and be given any name.
  145.  
  146.              This command will only be recorded in the history file if the
  147.              H flag is specified.
  148. #FETCH CLASS
  149. Format:      FETCH CLASS <class name> [<remark>] [-H]
  150.  
  151. Priority:    1
  152.  
  153. Description: Fetch all the generations contained in a specific class but do
  154.              not mark them as reserved. The generations are copied to files in
  155.              the current working directory which are given the same name as
  156.              the generation.
  157.  
  158.              This command will only be recorded in the history file if the
  159.              H flag is specified.
  160. #HELP
  161. Format:      HELP [<command>]
  162.  
  163. Priority:    0
  164.  
  165. Description: If a command is specified then display the help text for that
  166.              command. If no command is specified then list all the available
  167.              commands.
  168. #INSERT ELEMENT
  169. Format:      INSERT ELEMENT <element name> <group name> [<remark>]
  170.  
  171. Priority:    2
  172.  
  173. Description: Insert the specified element into the specified group.
  174. #INSERT GENERATION
  175. Format:      INSERT GENERATION <generation name> <class name> [<remark>]
  176.  
  177. Priority:    2
  178.  
  179. Description: Insert the specified generation into the specified class.
  180. #LOCK LIBRARY
  181. Format:      LOCK LIBRARY
  182.  
  183. Priority:    3
  184.  
  185. Description: Lock the library thereby preventing other NET users from 
  186.              gaining access.
  187. #MODIFY GROUP
  188. Format:      MODIFY GROUP <old group name> <new group name> [<remark>]
  189.  
  190. Priority:    2
  191.  
  192. Description: Modify the name and optionally the remark associated with the 
  193.              specified group.
  194. #MODIFY CLASS
  195. Format:      MODIFY CLASS <old class name> <new class name> [<remark>]
  196.  
  197. Priority:    2
  198.  
  199. Description: Modify the name and optionally the remark associated with the 
  200.              specified class.
  201. #MODIFY ELEMENT
  202. Format:      MODIFY ELEMENT <old element name> <new element name> [<remark>]
  203.  
  204. Priority:    2
  205.  
  206. Description: Modify the name and optionally the remark associated with the 
  207.              specified element
  208. #MODIFY LIBRARY
  209. Format:      MODIFY LIBRARY <remark>
  210.  
  211. Priority:    3
  212.  
  213. Description: Modify the remark associated with the current library.
  214. #MODIFY PASSWORD
  215. Format:      MODIFY PASSWORD [<remark>]
  216.  
  217. Priority:    1
  218.  
  219. Description: Prompt the operator for a new password for the current user. 
  220.              The password is input (without echo) twice, and only if both 
  221.              inputs match is the password changed.
  222. #MODIFY USER
  223. Format:      MODIFY USER <user name> [<remark>] {-P<priority>|-W}
  224.  
  225. Priority:    3
  226.  
  227. Description: Optionally modify the priority, password and remark associated 
  228.              with the specified user. The remark is modified if it is 
  229.              specified. The priority is modified if the P flag is specified. 
  230.              If the W flag is specified then a new password is prompted for. 
  231.              The password is input (without echo) twice, and only if both 
  232.              inputs match is it password changed.
  233. #QUIT
  234. Format:      QUIT
  235.  
  236. Priority:    0
  237.  
  238. Description: Terminate SMUT and return to DOS.
  239. #REMARK
  240. Format:      REMARK <remark>
  241.  
  242. Priority:    1
  243.  
  244. Description: Enter a remark into the history file.
  245. #REMOVE ELEMENT
  246. Format:      REMOVE ELEMENT <element name> <group name> [<remark>]
  247.  
  248. Priority:    2
  249.  
  250. Description: Remove the specified element from the specified group.
  251. #REMOVE GENERATION
  252. Format:      REMOVE GENERATION <generation name> <class name> [<remark>]
  253.  
  254. Priority:    2
  255.  
  256. Description: Remove the specified generation from the specified class.
  257. #REPLACE
  258. Format:      REPLACE <generation> [<remark>] {-F<filename>|-K|-V<id>}
  259.  
  260. Priority:    2 providing the generation was originally reserved by the
  261.              current user, else 3.
  262.  
  263. Description: Replace a reserved generation. Normally from a file with the
  264.              same name as the element unless overridden by the F flag.
  265.              Delete the input file unless suppressed by the K flag.
  266.              Normally generate the next generation in the main line of
  267.              decent unless overridden by the V flag.
  268. #RESERVE
  269. Format:      RESERVE <generation> [<remark>] {-F<filename>|-D}
  270.  
  271. Priority:    2
  272.  
  273. Description: Unless the D flag is specified, copy the contents of the
  274.          specified generation to a file. Mark the generation as reserved
  275.          by the current user. Normally the output file is that with the
  276.          same name as the element in the current working directory,
  277.          however this can be overridden using the F flag. If the D flag is
  278.          specified then the output is discarded.
  279. #SET DIRECTORY
  280. Format:      SET DIRECTORY <directory>
  281.  
  282. Priority:    0
  283.  
  284. Description: Set the current working directory and drive.
  285. #SET LIBRARY
  286. Format:      SET LIBRARY <directory> [<user name>]
  287.  
  288. Priority:    0
  289.  
  290. Description: Set the current library and optionally prompt for the
  291.              specified users password and if correct set that user to be
  292.              the current user. This command is actioned in two parts so
  293.              that if setting the user fails (because the user name does
  294.              not exist or the password is incorrect) the new library will
  295.              still be set.
  296. #SET USER
  297. Format:      SET USER <user name>
  298.  
  299. Priority:    0
  300.  
  301. Description: Prompt for the specified users password and if correct set
  302.              that user to be the current user.
  303. #SHOW CLASS
  304. Format:      SHOW CLASS [<class name>] {-L<filename>|-A<filename>}
  305.  
  306. Priority:    0
  307.  
  308. Description: If a class name is specified, show the generations contained
  309.              in that class. If no class name is specified then list all
  310.              the classes. If neither the L nor A flag is specified output
  311.              is to the screen; if the L flag is specified then a new file
  312.              (of the given file name) is created and the output sent to
  313.              that; if the A flag is specified then the output is appended
  314.              to the given existing named file.
  315. #SHOW DIRECTORY
  316. Format:      SHOW DIRECTORY {-L<filename>|-A<filename>}
  317.  
  318. Priority:    0
  319.  
  320. Description: Show the current working drive and directory and all the
  321.              files contained therein. If neither the L nor A flag is specified
  322.              output is to the screen; if the L flag is specified then a new
  323.              file (of the given file name) is created and the output sent to
  324.              that; if the A flag is specified then the output is appended
  325.              to the given existing named file.
  326. #SHOW ELEMENT
  327. Format:      SHOW ELEMENT [<element name>] {-T|-L<filename>|-A<filename>}
  328.  
  329. Priority:    0
  330.  
  331. Description: If the element name is specified, show the generations of
  332.              that element. If the element name is not specified then list
  333.          all elements. If an element is specified then the -T flag can
  334.          optionally be given. If given the generations are displayed in
  335.          a tree form; if not given they are listed. If neither the L nor
  336.          A flag is specified output is to the screen; if the L flag is
  337.          specified then a new file (of the given file name) is created
  338.          and the output sent to that; if the A flag is specified then
  339.          the output is appended to the given existing named file.
  340. #SHOW GROUP
  341. Format:      SHOW GROUP [<group name>] {-L<filename>|-A<filename>}
  342.  
  343. Priority:    0
  344.  
  345. Description: If a group name is specified, show the elements contained in
  346.              that group. If no group name is specified then list all the
  347.              groups. If neither the L nor A flag is specified output
  348.              is to the screen; if the L flag is specified then a new file
  349.              (of the given file name) is created and the output sent to
  350.              that; if the A flag is specified then the output is appended
  351.              to the given existing named file.
  352. #SHOW HISTORY
  353. Format:      SHOW HISTORY [<date1> [<date2>]] {-L<filename>|-A<filename>}
  354.  
  355. Priority:    0
  356.  
  357. Description: Show the contents of the history file. If no dates are specified
  358.              then show the whole file. If one date is specified then show
  359.              only entries after that date. If two dates are specified
  360.              then show entries between the two dates. If neither the L nor A
  361.              flag is specified output is to the screen; if the L flag is
  362.              specified then a new file (of the given file name) is created
  363.              and the output sent to that; if the A flag is specified then the
  364.              output is appended to the given existing named file.
  365. #SHOW LIBRARY
  366. Format:      SHOW LIBRARY {-L<filename>|-A<filename>}
  367.  
  368. Priority:    0
  369.  
  370. Description: Show the current library, current user and current working
  371.              directory. If neither the L nor A flag is specified output
  372.              is to the screen; if the L flag is specified then a new file
  373.              (of the given file name) is created and the output sent to
  374.              that; if the A flag is specified then the output is appended
  375.              to the given existing named file.
  376. #SHOW RESERVATIONS
  377. Format:      SHOW RESERVATIONS {-L<filename>|-A<filename>}
  378.  
  379. Priority:    0
  380.  
  381. Description: Show all the reserved generations and the users that have
  382.              reserved them. If neither the L nor A flag is specified output
  383.              is to the screen; if the L flag is specified then a new file
  384.              (of the given file name) is created and the output sent to
  385.              that; if the A flag is specified then the output is appended
  386.              to the given existing named file.
  387. #SHOW USER
  388. Format:      SHOW USER [<user name>] {-L<filename>|-A<filename>}
  389.  
  390. Priority:    0
  391.  
  392. Description: If the user name is specified show information about that
  393.              user. If the user name is not specified then list all the
  394.              users. If neither the L nor A flag is specified output
  395.              is to the screen; if the L flag is specified then a new file
  396.              (of the given file name) is created and the output sent to
  397.              that; if the A flag is specified then the output is appended
  398.              to the given existing named file.
  399. #SHOW VERSION
  400. Format:      SHOW VERSION {-L<filename>|-A<filename>}
  401.  
  402. Priority:    0
  403.  
  404. Description: Show the current version of SMUT and additional registration
  405.          information. If neither the L nor A flag is specified output
  406.          is to the screen; if the L flag is specified then a new file
  407.          (of the given file name) is created and the output sent to
  408.          that; if the A flag is specified then the output is appended
  409.          to the given existing named file.
  410. #UNLOCK LIBRARY
  411. Format:      UNLOCK LIBRARY
  412.  
  413. Priority:    1
  414.  
  415. Description: Allow library access by other NET users.
  416. #UNRESERVE
  417. Format:      UNRESERVE <generation> [<remark>]
  418.  
  419. Priority:    2 providing the generation was originally reserved by the
  420.              current user, else 3.
  421.  
  422. Description: Unreserve a reserved generation.
  423. #UNSET USER
  424. Format:      UNSET USER
  425.  
  426. Priority:    1
  427.  
  428. Description: Unset the current user. The priority will hence become 0.
  429.