User Tools

Site Tools


packet:xrpi:manpages:hlppztdos

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
packet:xrpi:manpages:hlppztdos [2025/04/19 13:31] – created m0mzfpacket:xrpi:manpages:hlppztdos [2025/04/19 18:01] (current) – removed m0mzf
Line 1: Line 1:
-=======PZTDOS Help======= +
-=====CD.HLP===== +
-<code> +
-Synopsis: +
-   The CD command changes the current "working directory"+
-Syntax: +
-   CD [path/]<dirname> +
-Description: +
-   If [path] is omitted, the target <dirname> is interpreted relative +
-   to the current working directory. Forward (/) and backward (\) +
-   slashes may be used interchangeably. Pathnames are case-sensitive. +
-Examples: +
-   CD FRED       Change to subdirectory FRED of current directory +
-   CD ..         Change up one level to parent directory +
-   CD /          Change to root directory +
-   CD FRED\JIM   Change to JIM subdirectory of FRED directory. +
-   CD ..\docs    Change up to parent, and down to 'docs' subdir. +
-See also: +
-</code> +
----- +
-=====CDUP.HLP===== +
-<code> +
-Synopsis: +
-   CDUP -- Change to 'parent' directory. +
-Syntax: +
-   CDUP +
-Description: +
-   The CDUP command changes the current working directory up one level +
-   to the parent directory, i.e. it performs the function of "CWD .." +
-   This command takes no arguments, and if the current directory is +
-   the root directory, CDUP has no effect. +
-See also: +
-</code> +
----- +
-=====COPY.HLP===== +
-<code> +
-Synopsis: +
-   COPY -- Copy or create file(s) +
-Syntax: +
-   COPY <source> [dest] +
-Description: +
-   The COPY command copies the file(s) specified by the pathname +
-   <source> into the file(s) or directory specified by [dest]. +
-   <source> may be a directory, a single file, or multiple files +
-   specified using wildcards, and may contain a drive and path spec. +
-   If <source> is a directory, all the files in that directory are +
-   copied. If <source> contains wildcards, all matching files are +
-   copied. If <source> is "CON" (console) any further input from the +
-   keyboard goes into the file until receipt of Ctrl-Z or /EX on a +
-   fresh line. +
-   [dest] may be a directory, a single file, or blank. If [dest] is a +
-   directory, the source file(s) are copied into it as seperate files. +
-   If [dest] is a single file, the source file(s) are concatenated +
-   into it. If [dest] is not specified, the file is copied into the +
-   working directory, and retains the original filename.  +
-Examples: +
-   COPY ..\MYPROG.EXE  /progs/TESTPROG.EXE   +
-   COPY xrpi-backup/FWD.SYS                       +
-   COPY *.HLP HELP.DOC +
-   COPY CON fred.txt +
-Limitations: +
-   Concatenation using the "+" operator is not supported. +
-</code> +
----- +
-=====DEL.HLP===== +
-<code> +
-Synopsis: +
-   The DEL (delete) command deletes one or more files. +
-Syntax: +
-   DEL <filespec> +
-Description: +
-   <filespec> may describe either an absolute or relative path +
-   and/or filename. Forward (/) and backward (\) slashes may be used +
-   interchangeably. Pathnames are case-sensitive. +
-   If <filespec> contains wildcards ('*' and '?'), any matching file +
-   is deleted. +
-Examples: +
-   DEL JIM.TXT         Delete file JIM.TXT from current directory. +
-   DEL \FRED/DOG.EXE   Delete DOG.EXE from directory /FRED +
-   DEL ../*.LOG        Delete all log files in parent directory. +
-Caveats: +
-</code> +
----- +
-=====DF.HLP===== +
-<code> +
-Synopsis: +
-   DF -- Display free space on disk +
-Syntax: +
-   DF +
-Description: +
-   The DF command displays the free and total space in bytes on the +
-   drive containing XRouter, plus sector and cluster size information.  +
-Limitations: +
-   The DF command can not (yet) display information from any other +
-   disk drive. +
-Caveats: +
-   This is a work in progress, and may give incorrect information on +
-</code> +
----- +
-=====DIR.HLP===== +
-<code> +
-Synopsis: +
-   DIR -- List files in a directory +
-Syntax: +
-    DIR [path/][mask] +
-Description +
-    The DIR command lists the contents of the specified directory, in +
-    alphabetical order, using the optional specified mask. +
-    If [path] is not specified, the "current working directory" is +
-    assumed. Forward and back slashes can be freely mixed. If [mask] +
-    is not specified, "*.*" is assumed. If only the filename part is +
-    specified, the extension ".*" is assumed. +
-Examples +
-    DIR MSGHDR??.* +
-    dir LOG\ +
-    DIR /pub\DOCS\*.txt +
-Limitations +
-</code> +
----- +
-=====EDITCMDS.HLP===== +
-<code> +
-Line Editor Commands: +
-    In the following document, n1, n2 and n3 refer to line numbers. +
-    These must be greater than zero, and within the range of line +
-    numbers used in the file being edited. The space between the +
-    command and the first number may be omitted. The numbers may be +
-    separated by spaces, commas, colons, tabs etc. Parameters in square +
-    brackets [] are optional. When copying, moving or inserting lines, +
-    the "source" text is inserted at the "destination" line, i.e. +
-    "in front of" the original text. Commmands are not case sensitive. +
-? -- Displays a brief list of commands +
-A <text> -- Append line <text> to the file +
-    The editor ignores exactly one space between the A and the text +
-    to be inserted. If you want to enter a line which has leading +
-    spaces, add one extra space. +
-C n1 n2 [n3] -- Copy line(s) +
-    If n3 is omitted, line n1 is copied into line n2, otherwise the +
-    block n1 to n2 inclusive is copied into the position beginning at +
-    n3. Note: n3 must not be within the block being copied. +
-D n1 [n2] -- Delete line(s) +
-    If both n1 and n2 are specified, the block of lines between and +
-    including n1 and n2 will be deleted. If n2 is omitted, or is the +
-    same as n1, only n1 will be deleted. +
-H n1 -- Hash (comment-out) a line using the '#' symbol +
-    This is useful for disabling configuration entries without +
-    deleting them. They can be easily re-activated at a later date +
-    using the U)nhash command. If the line already begins with '#' +
-    another one is not prepended. +
-I n1 <text> -- Insert <text> into line n1 +
-L n1 [n2] -- List (display) line(s) +
-    If n2 is specified, lines n1 to n2 inclusive are displayed, +
-    otherwise it displays 10 lines beginning at n1. If n1 is omitted, +
-    it re-displays the same page, or if this is the first time the +
-    command has been used, the first 10 lines of text are displayed. +
-M n1 n2 [n3] -- Move line(s) +
-    If n3 is specified, the block of lines n1 to n2 inclusive are +
-    moved to the position beginning at n3, otherwise the single line +
-    n1 is moved to the n2 position. +
-N -- Next page +
-    Displays the next page (10 lines) of text. +
-P -- Previous page +
-    Displays the previous page (10 lines) of text. +
-Q -- Quit +
-    The text is abandoned and the original file is left intact, +
-    providing you hadn't used the W command. +
-S -- Save the text. +
-    Syntax and function identical to W)rite. +
-U n1 -- Unhash line n1 +
-    Removes a '#' symbol from start of line, if one is present +
-    (opposite of H)ash). +
-W [<file>] -- Write (save) file being edited to disk +
-    If <file> is specified, the work is written there instead of +
-    the original name, but will not overwrite an existing file. +
-W! <file> -- Write unconditionally. +
-    Writes the text being edited to <file>, overwriting any existing +
-    file of the same name. +
-WQ -- Write & Quit. +
-    Writes the modified text back to the original file and quits +
-    editor. (Same as ZZ) +
-</code> +
----- +
-=====EDIT.HLP===== +
-<code> +
-Synopsis: +
-   EDIT -- Edit a file using line editor +
-Syntax: +
-   E[dit] [path/]<filename> +
-Description: +
-   The EDIT command is used to create, view or edit text files. It uses +
-   a line-based text editor which is primarily of use to remote sysops. +
-   If the specified file doesn't exist, it is created. All editing is +
-   done in memory, and the original file is only created or modified +
-   when the sysop issues a write command.  +
-Examples: +
-   EDIT ../Stuff\Docs/Xrpi.txt +
-   EDIT XROUTER.CFG +
-   edit help/chat.hlp +
-See also: +
-</code> +
----- +
-=====EXIT.HLP===== +
-<code> +
-Synopsis: +
-   EXIT -- Exit DOS emulation mode +
-Syntax: +
-   EXIT +
-Description: +
-   The EXIT command is used to leave DOS emulation mode and return to +
-</code> +
----- +
-=====HEAD.HLP===== +
-<code> +
-Synopsis: +
-   HEAD -- Display the first few lines of a text file +
-Syntax: +
-   HE[ad] [n] [path/]<filename> +
-Description: +
-   The first 'n' lines of the file are displayed, where n is a number +
-   between 1 and 99. If n is not specified, the default is 10 lines. +
-   If the file contains fewer than 'n' lines, the entire file is +
-   displayed. +
-Examples: +
-   HEAD mydoc.txt        Display first 10 lines of mydoc.txt +
-   HEAD 20 ../fred.doc   Display first 20 lines of ../fred.doc +
-Limitations: +
-   For text files only! +
-See Also: +
-</code> +
----- +
-=====HELP.HLP===== +
-<code> +
-Synopsis: +
-   HELP -- Show help for DOS emulator commands +
-Syntax: +
-   H[elp] [<command> | *] +
-Description: +
-   If the DOS help files are installed in HELP/DOS, the HELP command +
-   can be used to list and display them.  +
-Examples: +
-   HELP            Instructions +
-   H *             Displays a list of help topics +
-   H M             List topics beginning with 'M' +
-   H MOVE          Display help for the MOVE command +
-See Also: +
-   '? <cmd>' and '<cmd> ?'  Shows basic syntax help for <cmd>+
-   '<cmd> -h'               Shows a brief description of <cmd>+
-   '? *'                    Lists all DOS emulator commands in brief. +
-</code> +
----- +
-=====MD.HLP===== +
-<code> +
-Synopsis: +
-   MD -- (Make Directory) creates a new directory  +
-Syntax: +
-   MD [path/]<dirname> +
-Description: +
-   The MD command has exactly the same action as MKDIR. +
-   if [path] is not specified, the current directory is assumed. +
-   The specified pathname may be absolute, or relative to the +
-   current directory. Back and forward slashes are equivalent. +
-Examples: +
-   MD FRED           Create directory FRED in current directory +
-   MD /JIM/BILL      Create directory BILL in the /JIM directory +
-See also: +
-   MKDIR  Make Directory +
-</code> +
----- +
-=====MKDIR.HLP===== +
-<code> +
-Synopsis: +
-   MKDIR -- (Make Directory) creates a new directory  +
-Syntax: +
-   MK[dir] [path/]<dirname> +
-Description: +
-   The MKDIR command has exactly the same action as MD. +
-   if [path] is not specified, the current directory is assumed. +
-   The specified pathname may be absolute, or relative to the +
-   current directory. Back and forward slashes are equivalent. +
-Examples: +
-   MKDIR FRED        Create directory FRED in current directory +
-   MK /JIM\BILL      Create directory BILL in the /JIM directory +
-See also: +
-   MD     Make Directory +
-</code> +
----- +
-=====MORE.HLP===== +
-<code> +
-Synopsis: +
-   MORE -- Read a text file with pagination +
-Syntax: +
-   MO[re] [path/]<filename>  +
-Description: +
-   The specified text file is displayed one page at a time. There are +
-   no limitations on the size of file which can be displayed. The next +
-   page is displayed by hitting the RETURN (Enter) key. +
-Examples: +
-   MORE ../DOCS/FRED.TXT +
-Limitations: +
-   Text files only. Wildcards are not accepted in filenames. +
-See also: +
-   TYPE    Display text file without pagination. +
-   HEAD    Display first few lines of a text file. +
-</code> +
----- +
-=====MOVE.HLP===== +
-<code> +
-Synopsis: +
-   MOVE -- Move file(s). +
-Syntax: +
-   MOVE [path1/]<filename1> [path2/][filename2] +
-Description: +
-   Moves file(s) specified by the first argument (source) to the new +
-   location and/or name(s) specified by second argument (target). +
-   Both filenames may contain wildcards. If source and target +
-   filenames are different the file(s) are renamed at the same time. +
-   "source" MUST NOT be a directory. If it doesn't contain a path, the +
-   current directory is assumed. "target" MAY BE a directory. If a +
-   filename is not specified, the original name(s) are used. If target +
-   is a single file, the source must also be a single file. +
-Examples: +
-   MOVE fred.doc test.doc                Rename only. +
-   MOVE test.txt /mystuff                Move only. +
-</code> +
----- +
-=====REN.HLP===== +
-<code> +
-Synopsis: +
-   REN -- Rename file(s) +
-Syntax: +
-   REN [path/]<oldname> [path/]<newname> +
-Description: +
-   Renames one or more file(s) from <oldname> to <newname>. The +
-   filenames may contain wildcards. +
-   If the source path is not specified, the current directory is +
-   assumed. If the destination path is not specified, the renamed +
-   file(s) remain(s) in the source directory. +
-   If you specify two different paths, the file is moved. +
-Examples: +
-   REN  FWD.SYS  FWD.OLD                ; Simple rename +
-   REN  XRNODES backups/XRNODES         ; Move only  +
-   REN  TMP\FRED.DOC  junk/jill.txt     ; Rename and move +
-</code> +
----- +
-=====RMDIR.HLP===== +
-<code> +
-Synopsis: +
-   RMDIR -- (Remove Directory) deletes a directory.  +
-Syntax: +
-   RM[dir] [path/]<name> +
-Description: +
-   The RMDIR command deletes the specified directory. Paths may be +
-   absolute or relative. Forward and backward slashes are treated +
-   identically.  +
-Examples: +
-   RMDIR FRED        Delete subdirectory FRED from current directory +
-   RM /JIM/BILL      Delete subdirectory BILL from /JIM directory +
-Limitations: +
-   Non-empty directories cannot be deleted. +
-See also: +
-   MKDIR  (Make directory) +
-</code> +
----- +
-=====TAIL.HLP===== +
-<code> +
-Synopsis: +
-   TAIL -- Display the last few lines of a text file +
-Syntax: +
-   T[ail] [n] [path/]<filename> +
-Description: +
-   The last 'n' lines of the file are displayed, where n is a number +
-   between 1 and 99. If n is not specified, the default is 10 lines. +
-   If the file contains fewer than 'n' lines, the entire file is +
-   displayed. +
-Examples: +
-   TAIL mydoc.txt        Display last 10 lines of mydoc.txt +
-   TAIL 20 ../fred.doc   Display last 20 lines of ../fred.doc +
-Limitations: +
-   For text files only! +
-See Also: +
-</code> +
----- +
-=====TYPE.HLP===== +
-<code> +
-Synopsis: +
-   TYPE -- Displays a text file +
-Syntax: +
-   TY[pe] [path/]<filename> +
-Description: +
-   The specified text file is displayed without pagination. There are +
-   no limitations on the size of file which can be displayed. +
-Examples: +
-   TYPE ../DOCS/FRED.TXT +
-Limitations: +
-    Text files only. TYPE does not (yet) allow concatenation of files, +
-    and the output may not (yet) be redirected to a file. Wildcards +
-    are not accepted.  +
-See Also: +
-   HEAD   Display first few lines of a text file +
-</code> +
-----+
packet/xrpi/manpages/hlppztdos.1745069478.txt.gz · Last modified: 2025/04/19 13:31 by m0mzf