changeset 905:1f6c644006f1

Major overhaul, attempting documentation consistency
author boisy
date Sat, 18 Jan 2003 15:49:52 +0000
parents ce3cd4f19b18
children 81584f82ee74
files level1/sys/asm.hp level1/sys/attr.hp level1/sys/backup.hp level1/sys/build.hp level1/sys/cmp.hp level1/sys/cobbler.hp level1/sys/date.hp level1/sys/dcheck.hp level1/sys/del.hp level1/sys/deldir.hp level1/sys/dir.hp level1/sys/dsave.hp level1/sys/dump.hp level1/sys/edit.hp level1/sys/error.hp level1/sys/free.hp level1/sys/help.hp level1/sys/ident.hp level1/sys/iniz.hp level1/sys/list.hp level1/sys/load.hp level1/sys/makdir.hp level1/sys/mdir.hp level1/sys/merge.hp level1/sys/os9gen.hp level1/sys/procs.hp level1/sys/rename.hp level1/sys/save.hp level1/sys/setime.hp level1/sys/sleep.hp level1/sys/tee.hp level1/sys/tmode.hp level1/sys/touch.hp level1/sys/tuneport.hp level1/sys/verify.hp
diffstat 35 files changed, 35 insertions(+), 35 deletions(-) [+]
line wrap: on
line diff
--- a/level1/sys/asm.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/asm.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @ASM
-Syntax: Asm filename [opt][>list]
+Syntax: Asm filename [<opts>] [>list]
 Usage : Standard OS-9 Assembler
--- a/level1/sys/attr.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/attr.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @ATTR
-Syntax: Attr filename [permissions]
+Syntax: Attr filename [<opts>] [<perms>]
 Usage : Examine or change the security permissions of a file
 Opts  :
   -perm = turn off specified permission
--- a/level1/sys/backup.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/backup.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @BACKUP
-Syntax: Backup [e][s][-v][dev][dev]
+Syntax: Backup [<opts>] [<srcdev>] [<destdev>]
 Usage : Copies all data from one device to another
 Opts  :
   e = exit if read error occurs
--- a/level1/sys/build.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/build.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @BUILD
-Syntax: Build filename
+Syntax: Build <path>
 Usage : Builds short text files from standard input
--- a/level1/sys/cmp.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/cmp.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @CMP
-Syntax: Cmp filename1 filename2
+Syntax: Cmp <path1> <path2>
 Usage : File comparison utility
--- a/level1/sys/cobbler.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/cobbler.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @COBBLER
-Syntax: Cobbler devname
+Syntax: Cobbler <devname>
 Usage : Creates OS-9 bootstrap file from current boot
--- a/level1/sys/date.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/date.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DATE
-Syntax: Date [-t]
+Syntax: Date [<opts>]
 Usage : Displays current system date
 Opts  :
   -t = display time also
--- a/level1/sys/dcheck.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/dcheck.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DCHECK
-Syntax: Dcheck [-opts] <devname>
+Syntax: Dcheck [<opts>] <devname>
 Usage : Check disk file structure
 Opts  :
   -w=path = pathlist to directory for work files
--- a/level1/sys/del.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/del.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DEL
-Syntax: Del [-x] <path> {<path>} [-x]
+Syntax: Del [<opts>] <path> [<path>] [<opts>]
 Usage : Deletes the specified file(s)
 Opts  :
   -x = delete relative to execution directory
--- a/level1/sys/deldir.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/deldir.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @DELDIR
-Syntax: Deldir directory name
+Syntax: Deldir <path>
 Usage : Deletes entire directories
--- a/level1/sys/dir.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/dir.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DIR
-Syntax: Dir [opts] [path]
+Syntax: Dir [<opts>] [<path>]
 Usage : Displays formatted list of the file names in a directory
 Opts  :
   -e = extended dir
--- a/level1/sys/dsave.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/dsave.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DSAVE
-Syntax: Dsave [-opts][dev][pathname]
+Syntax: Dsave [<opts>] [<dev>] [<pathlist>]
 Usage : Generates procedure file to copy all files in a directory system
 Opts  :
   -b = make a system disk by using OS9boot if present
--- a/level1/sys/dump.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/dump.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @DUMP
-Syntax: Dump [opts] [<path>] [opts]
+Syntax: Dump [<opts>] [<path>] [<opts>]
 Usage : Formatted File Dump in Hexadecimal and ASCII
 Opts  :
   -h = no header
--- a/level1/sys/edit.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/edit.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @EDIT
-Syntax: Edit {<path>}
+Syntax: Edit [<path>]
 Usage : Standard line oriented text editor
--- a/level1/sys/error.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/error.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @ERROR
-Syntax: Error errno [...]
+Syntax: Error <errno> [<errno> [...]]
 Usage : Outputs text error messages for given error numbers
--- a/level1/sys/free.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/free.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @FREE
-Syntax: Free [devname]
+Syntax: Free [<devname>]
 Usage : Displays number of free sectors on a device
--- a/level1/sys/help.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/help.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @HELP
-Syntax: Help [subject] [-?]
+Syntax: Help [<subject>] [<opts>]
 Usage : Give on-line help to users
         will prompt if no subjects given
 Opts  :
--- a/level1/sys/ident.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/ident.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @IDENT
-Syntax: Ident [-opts] <path> [-opts]
+Syntax: Ident [<opts>] <path> [<opts>]
 Usage : Displays header information from OS-9 memory modules
 Opts  :
   -m = module in memory
--- a/level1/sys/iniz.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/iniz.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @INIZ
-Syntax: Iniz <devname> {<devname>}
+Syntax: Iniz <devname> [<devname> [...]]
 Usage : Attach a device
--- a/level1/sys/list.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/list.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @LIST
-Syntax: List filename [...]
+Syntax: List <path> [<path> [...]]
 Usage : Lists the contents of text files
--- a/level1/sys/load.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/load.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @LOAD
-Syntax: Load <pathname> [...]
+Syntax: Load <pathlist> [<pathlist> [...]]
 Usage : Loads modules into memory 
--- a/level1/sys/makdir.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/makdir.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @MAKDIR
-Syntax: Makdir <pathname>
+Syntax: Makdir <pathlist>
 Usage : Creates a new directory file 
--- a/level1/sys/mdir.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/mdir.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @MDIR
-Syntax: Mdir [-e]
+Syntax: Mdir [<opts>]
 Usage : Displays the present memory module directory
 Opts  :
   -e = print extended module directory
--- a/level1/sys/merge.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/merge.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @MERGE
-Syntax: Merge <path> [...]
+Syntax: Merge <path> [<path> [...]]
 Usage : Copies multiple input files to standard output
--- a/level1/sys/os9gen.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/os9gen.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @OS9GEN
-Syntax: OS9Gen devname [-s]
+Syntax: OS9Gen devname [<opts>]
 Usage : Creates and links an OS-9 bootstrap file
 Opts  :
   -s = single drive option
--- a/level1/sys/procs.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/procs.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @PROCS
-Syntax: Procs [-e]
+Syntax: Procs [<opts>]
 Usage : Displays a list of processes running in the system
 Opts  :
   -e = display all processes in the system
--- a/level1/sys/rename.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/rename.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @RENAME
-Syntax: Rename <filename> <new filename>
+Syntax: Rename <pathlist> <filename>
 Usage : Gives the file or directory a new name
--- a/level1/sys/save.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/save.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @SAVE
-Syntax: <path><modname>{<modname>}
+Syntax: <path> <modname> [<modname> [...]]
 Usage : Save memory module(s) in a file
--- a/level1/sys/setime.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/setime.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @SETIME
-Syntax: Setime [yyyy/mm/dd/hh:mm:ss]
+Syntax: Setime [yyyy/mm/dd hh:mm:ss]
 Usage : Sets and activates the system clock
--- a/level1/sys/sleep.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/sleep.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @SLEEP
-Syntax: Sleep <tick count>
+Syntax: Sleep <ticks>
 Usage : Suspend process for a period of time
--- a/level1/sys/tee.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/tee.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @TEE
-Syntax: Tee {<path>}        
+Syntax: Tee [<path>]        
 Usage : Copy standard input to multiple output paths
--- a/level1/sys/tmode.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/tmode.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @TMODE
-Syntax: Tmode [.pathname] [params]
+Syntax: Tmode [.<pathname>] [<params>]
 Usage : Displays or changes the operating parameters of the terminal
--- a/level1/sys/touch.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/touch.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @TOUCH
-Syntax: Touch [<opts>] {<path> [<opts>]}
+Syntax: Touch [<opts>] <path> [<opts>]
 Usage : update the date of a file
 Opts  :
   -c = don't create files
--- a/level1/sys/tuneport.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/tuneport.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,3 +1,3 @@
 @TUNEPORT
-Tuneport </t1 or /p> [value]
+Tuneport <device> [value]
 Adjust the baud value for the serial port
--- a/level1/sys/verify.hp	Sat Jan 18 15:34:55 2003 +0000
+++ b/level1/sys/verify.hp	Sat Jan 18 15:49:52 2003 +0000
@@ -1,5 +1,5 @@
 @VERIFY
-Syntax: Verify [u]
+Syntax: Verify [<opts>]
 Usage : Verify or update module header and CRC 
 Opts  :
   u = update module during check