/*****************************************************************************/ /* Copyright (C) 2004 NORMAN MEGILL nm at alum.mit.edu */ /* License terms: GNU General Public License */ /*****************************************************************************/ /*34567890123456 (79-character line to adjust editor window) 2345678901234567*/ /* Part 1 of help file for Metamath */ /* To add a new help entry, you must add the command syntax to mmcmdl.c as well as adding it here. */ #include #include #include "mmvstr.h" #include "mmdata.h" #include "mmcmds.h" #include "mmhlpa.h" /* help0 is for listMode */ void help0(vstring helpCmd) { printHelp = !strcmp(helpCmd, "HELP"); H("This utility assists with some common file manipulations."); H("Most commands will perform an identical operation on each line of a file."); H("Use HELP ? to see list of help topics."); H("Note: When an output file is created, any previous version is renamed,"); H( "with ~1 appended, and any ~1 renamed to ~2, etc. (up to ~9, which is lost)."); H("Note: All string-matching command arguments are case-sensitive."); H(""); H("Line-by-line editing commands:"); H(" ADD - Add a specified string to each line in a file"); H(" CLEAN - Trim spaces and tabs on each line in a file; convert characters"); H(" DELETE - Delete a section of each line in a file"); H(" INSERT - Insert a string at a specified column in each line of a file"); H(" SUBSTITUTE - Make a simple substitution on each line of the file"); /*H(" LSUBSTITUTE - Substitute according to a match-and-substitute list");*/ H(" SWAP - Swap the two halves of each line in a file"); H("Other file processing commands:"); H(" BREAK - Break up (parse) a file into a list of tokens (one per line)"); H(" BUILD - Build a file with multiple tokens per line from a list"); H(" COUNT - Count the occurrences in a file of a specified string"); /*H(" FORMAT - Produce a formatted list of tokens for documentation");*/ H(" NUMBER - Create a list of numbers"); H(" PARALLEL - Put two files in parallel"); H(" REVERSE - Reverse the order of the lines in a file"); H(" RIGHT - Right-justify lines in a file (useful before sorting numbers)"); H(" TAG - Tag edit updates in a program for revision control"); H(" SORT - Sort the lines in a file with key starting at specified string"); H(" MATCH - Extract lines containing (or not) a specified string"); /*H(" LEXTRACT - Extract lines containing (or not) strings from a list");*/ H(" UNDUPLICATE - Eliminate duplicate occurrences of lines in a file"); H(" DUPLICATE - Extract first occurrence of any line occurring more than"); H(" once in a file, discarding lines occurring exactly once"); H(" UNIQUE - Extract lines occurring exactly once in a file"); H( " (UNDUPLICATE, DUPLICATE, and UNIQUE also sort the lines as a side effect.)"); H(" TYPE (10 lines) - Similar to Unix \"head\""); /*H(" COPY, RENAME - Similar to Unix cat, mv but with backups created");*/ H( " COPY - Similar to Unix \"cat\" but safe (same input & output name allowed)"); H(" SUBMIT - Run a script containing Tools commands."); H(""); if (listMode) { H("Command syntax ([] means optional):"); H(" From TOOLS prompt: Tools> [ ...]"); H(" From VMS shell: $ DO TOOLS [] [ ...]"); H(" From Unix/DOS shell: tools [] [ ...]"); H("You need to type only as many characters of the command as are needed to"); H("uniquely specify it. Any arguments will answer questions automatically"); H("until the argument list is exhausted; the remaining questions will be"); H("prompted. An argument may be optionally enclosed in quotes. Use \"\" for"); H("default or null argument. [Note: VMS does not allow single quotes (')"); H("around DCL arguments; use double quotes (\"). Single quotes are OK in"); H("immediate mode.] [Note: Quotes MUST be put around Unix pathname arguments"); H("with a \"/\" in them, except they may be omitted in direct response to"); H("an argument prompt.]"); H(""); H("Notes:"); H("(1) The commands are not case sensitive. File names and match strings"); H("are case sensitive."); H("(2) Output files are created only after a command finishes running."); H("Therefore it is usually safe to hit ^C before a command is completed."); H("(3) The file \"zztools.tmp\", which is always created, can be used as a"); H("command file to re-run the command sequence with the SUBMIT command."); H("(4) Previous versions of output files (except under VMS) are renamed with"); H("~1 (most recent), ~2,...,~9 (oldest) appended to file name. Purge them"); H("periodically."); H("(5) The command B(EEP) will make the terminal beep. It can be useful to"); H("type it ahead to let you know when the current command is finished."); H("(6) It is suggested you use a \".tmp\" file extension for intermediate"); H("results to eliminate directory clutter."); H(""); H("Please see NDM if you have any suggestions for this program."); } /* if listMode */ printHelp = !strcmp(helpCmd, "HELP ADD"); H("This command adds a character string prefix and/or suffix to each"); H("line in a file."); H("Syntax: ADD "); printHelp = !strcmp(helpCmd, "HELP DELETE"); H("This command deletes the part of a line between (and including)"); H("two specified strings for all lines in a file."); H("Syntax: DELETE "); printHelp = !strcmp(helpCmd, "HELP CLEAN"); H("This command processes spaces and tabs in each line of a file"); H("according to the following subcommands:"); H(" D - Delete all spaces and tabs"); H(" B - Delete spaces and tabs at the beginning of each line"); H(" E - Delete spaces and tabs at the end of each line"); H(" R - Reduce multiple spaces and tabs to one space"); H(" Q - Do not alter characters in quotes (ignored by T and U)"); H(" T - (Tab) Convert spaces to equivalent tabs"); H(" U - (Untab) Convert tabs to equivalent spaces"); H("Some other subcommands are also available:"); H(" P - Trim parity (8th) bit from each character"); H(" G - Discard garbage characters CR,FF,ESC,BS"); H(" C - Convert to upper case"); H(" L - Convert to lower case"); H(" V - Convert VT220 screen print frame graphics to -,|,+ characters"); H("Subcommands may be joined with commas (but no spaces), e.g., \"B,E,R,Q\""); H("Syntax: CLEAN "); printHelp = !strcmp(helpCmd, "HELP SUBSTITUTE") || !strcmp(helpCmd, "HELP S"); H("This command performs a simple string substitution in each line of a file."); H("If the string to be replaced is \"\\n\", then every other line will"); H("be joined to the one below it. If the replacement string is \"\\n\", then"); H("each line will be split into two if there is a match."); H("The specifies a string that must also exist on a line"); H("before the substitution takes place; null means match any line."); H("Syntax: SUBSTITUTE "); H("Note: The SUBSTITUTE command may be abbreviated by S."); printHelp = !strcmp(helpCmd, "HELP SWAP"); H("This command swaps the parts of each line before and after a"); H("specified string."); printHelp = !strcmp(helpCmd, "HELP INSERT"); H("This command inserts a string at a specifed column in each line"); H("in a file. It is intended to aid further processing of column-"); H("sensitive files."); H("Syntax: INSERT "); printHelp = !strcmp(helpCmd, "HELP BREAK"); H("This command breaks up a file into tokens, one per line, breaking at"); H("whitespace and any special characters you specify as delimiters."); H("Syntax: BREAK "); printHelp = !strcmp(helpCmd, "HELP BUILD"); H("This command combines a list of tokens into multiple tokens per line,"); H("as many as will fit per line, separating them with spaces."); H("Syntax: BUILD "); printHelp = !strcmp(helpCmd, "HELP MATCH"); H("This command extracts from a file those lines containing (Y) or not"); H("containing (N) a specified string."); H("Syntax: MATCH "); printHelp = !strcmp(helpCmd, "HELP SORT"); H("This command sorts a file, comparing lines starting at a key string."); H("If the key string is blank, the line is compared starting at column 1."); H("If a line doesn't contain the key, it is compared starting at column 1."); H("Syntax: SORT "); printHelp = !strcmp(helpCmd, "HELP UNDUPLICATE"); H("This command sorts a file then removes any duplicate lines from the output."); H("Syntax: UNDUPLICATE "); printHelp = !strcmp(helpCmd, "HELP DUPLICATE"); H("This command finds all duplicate lines in a file and places them, in"); H("sorted order, into the output file."); H("Syntax: DUPLICATE "); printHelp = !strcmp(helpCmd, "HELP UNIQUE"); H("This command finds all unique lines in a file and places them, in"); H("sorted order, into the output file."); H("Syntax: UNIQUE "); printHelp = !strcmp(helpCmd, "HELP REVERSE"); H("This command reverses the order of the lines in a file."); H("Syntax: REVERSE "); printHelp = !strcmp(helpCmd, "HELP RIGHT"); H("This command right-justifies the lines in a file by putting spaces in"); H("front of them so that they end in the same column as the longest line"); H("in the file."); H("Syntax: RIGHT "); printHelp = !strcmp(helpCmd, "HELP PARALLEL"); H("This command puts two files side-by-side."); H("The two files should have the same number of lines; if not, a warning is"); H("issued and the longer file paralleled with empty strings at the end."); H("Syntax: PARALLEL "); printHelp = !strcmp(helpCmd, "HELP NUMBER"); H("This command creates a list of numbers. Hint: Use the RIGHT command to"); H("right-justify the list after creating it."); H("Syntax: NUMBER "); printHelp = !strcmp(helpCmd, "HELP COUNT"); H("This command counts the occurrences of a string in a file and displays"); H("some other statistics about the file. The sum of the lines is obtained"); H("by extracting digits and is only valid if the file consists of genuine"); H("numbers."); H("Syntax: COUNT "); printHelp = !strcmp(helpCmd, "HELP TYPE") || !strcmp(helpCmd, "HELP T"); H("This command displays (i.e. types out) the first n lines of a file on the"); H("terminal screen. If n is not specified, it will default to 10. If n is"); H( "the string \"ALL\" then the whole file will be typed. T is an abbreviation"); H("for TYPE."); H("Syntax: TYPE "); printHelp = !strcmp(helpCmd, "HELP COPY") || !strcmp(helpCmd, "HELP C"); H("This command copies (concatenates) all input files in a comma-separated"); H("list (no blanks allowed) to an output file. The output file may have"); H("the same name as an input file. Any previous version of the output"); H("file is renamed with a ~1 extension. C is an abbreviation for COPY."); H("Syntax: COPY "); printHelp = !strcmp(helpCmd, "HELP TAG"); H("This command tags edits made to a program source. The idea is to keep"); H("all past history of a file in the file itself, in the form of comments."); H("TAG was written for a proprietary language that allowed nested C-style"); H("comments, and it may not be generally useful without some modification."); H("Essentially a (Unix) diff-like algorithm looks for changes between an"); H("original and a revised file and puts the original lines into the revised"); H("file in the form of comments. Currently it is not well documented and it"); H("may be easiest just to type TAG and answer the questions. Try"); H("it on an original and edited version of a test file to see if you find it"); H("useful."); H("Syntax: TAG "); printHelp = !strcmp(helpCmd, "HELP CLI"); H("Each command line is an English-like word followed by arguments separated"); H("by spaces, as in SUBMIT abc.cmd. Commands are not case sensitive, and"); H("only as many letters are needed as are necessary to eliminate ambiguity;"); H("for example, \"a\" would work for the command ADD. Command arguments"); H("which are file names and match strings are case-sensitive (although file"); H("names may not be on some operating systems)."); H(""); H("A command line is entered typing it in then pressing the key."); H(""); H("To find out what commands are available, type ? at the \"TOOLS>\" prompt."); H(""); H("To find out the choices at any point in a command, press and you"); H("will be prompted for them. The default choice (the one selected if you"); H("just press ) is shown in brackets (<>)."); H(""); H("You may also type ? in place of a command word to tell"); H("you what the choices are. The ? method won't work, though, if a"); H("non-keyword argument such as a file name is expected at that point,"); H("because the CLI will think the ? is the argument."); H(""); H("Some commands have one or more optional qualifiers which modify the"); H("behavior of the command. Qualifiers are indicated by a slash (/), such as"); H("in ABC xyz / IJK. Spaces are optional around the /. If you need"); H("to use a slash in a command argument, as in a Unix file name, put single"); H("or double quotes around the command argument."); H(""); H("If the response to a command is more than a screenful, you will be"); H("prompted to \" to continue, Q to quit, or S to scroll to end\"."); H("Q will complete the command internally but suppress further output until"); H("the next \"TOOLS>\" prompt. S will suppress further pausing until the next"); H("\"TOOLS>\" prompt."); H(""); H("A command line enclosed in quotes is executed by your operating system."); H("See HELP SYSTEM."); H(""); H("Some other commands you may want to review with HELP are:"); H(" SUBMIT"); H(""); printHelp = !strcmp(helpCmd, "HELP SUBMIT"); H("Syntax: SUBMIT "); H(""); H("This command causes further command lines to be taken from the specified"); H("file. Note that any line beginning with an exclamation point (!) is"); H("treated as a comment (i.e. ignored). Also note that the scrolling"); H("of the screen output is continuous."); printHelp = !strcmp(helpCmd, "HELP SYSTEM"); H("A line enclosed in quotes will be executed by your computer's operating"); H("system, if it has such a feature. For example, on a VAX/VMS system,"); H(" Tools> 'dir'"); H("will print disk directory contents. Note that this feature will not work"); H("on the Macintosh, which does not have a command line interface."); H(""); H("For your convenience, the trailing quote is optional."); H(""); } /* help0 */ /* Note: help1 should contain Metamath help */ void help1(vstring helpCmd) { printHelp = !strcmp(helpCmd, "HELP LANGUAGE"); H("The language is best learned by reading the book and studying a few proofs"); H("with the Metamath program. This is a brief summary for reference."); H(""); H("The database contains a series of tokens separated by whitespace (spaces,"); H("tabs, returns). A token is a keyword, a