Annotation of 43BSDTahoe/new/help/src/wwb, revision 1.1.1.1

1.1       root        1: .TI WWB
                      2: Text Analysis with the Writer's Workbench System
                      3: 
                      4: Writer's Workbench (WWB) is a collection of programs to
                      5: do proofreading and stylistic analysis of text files,
                      6: together with checks for spelling, punctuation, diction,
                      7: and doubled words.
                      8: 
                      9: The WWB programs are not automatically available to users since
                     10: they are located in a non-standard command directory, /usr/wwb/bin.
                     11: To make them accessible to you, you can edit your ".login" file
                     12: and add /usr/wwb/bin to your "path" variable.
                     13: If the following example is too brief, type "help .login"
                     14: and "help searchpath" for more information.
                     15: As an example, your ".login" file might contain the path definition
                     16: 
                     17:        set path = (/usr/ucb /bin /usr/bin .)
                     18: 
                     19: which you could change to
                     20: 
                     21:        set path = (/usr/ucb /usr/wwb/bin /bin /usr/bin .)
                     22: 
                     23: This would give you access to the WWB commands, which are:
                     24: 
                     25: .nf
                     26:        abst        match       prosestand  splitrules  wwbaid
                     27:        acro        mkstand     punct       style       wwbhelp
                     28:        deroff      org         punctrules  syl         wwbinfo
                     29:        dictadd     parts       sexist      topic       wwbman
                     30:        diction     proofer     spelladd    wc          
                     31:        double      proofr      spelltell   worduse     
                     32:        findbe      prose       spellwwb    wwb         
                     33: .fi
                     34: 
                     35: Manual pages for these commands are available on-line via
                     36: the "wwbman" command (once your path has been set correctly),
                     37: and hardcopies are available from the Academic
                     38: Computing Services Library, 218 Evans.
                     39: Currently we provide no consulting or bug-fixing support for WWB.
                     40: The WWB system also comes with its own on-line
                     41: documentation system consisting of the three commands:  wwbaid,
                     42: wwbhelp, and wwbinfo.
                     43: 
                     44: As you experiment with them and the rest of the WWB system,
                     45: you may notice a different style of presentation from
                     46: the one to which you are accustomed.
                     47: For example, sometimes the output pauses after each screenful
                     48: and requires you to type RETURN to continue (not SPACE, with
                     49: which most users at Berkeley are familiar).
                     50: Sometimes the output does not pause at all; in these cases
                     51: you may want to redo the last command adding "| more" to
                     52: the end in order to read the output conveniently.
                     53: Also, references to BREAK mean the command-kill character
                     54: (or interrupt character), often Control-C.
                     55: The next two pages are taken from the manual pages for wwbaid.
                     56: 
                     57: jak
                     58: .bp
                     59: .de PP
                     60: .LP
                     61: ..
                     62: .de I
                     63: \fI\\$1\fP
                     64: ..
                     65: .de B
                     66: \fB\\$1\fP
                     67: ..
                     68: 
                     69: .SH GETTING STARTED
                     70: 
                     71: All users of the Writer's Workbench system will find the user's aid helpful.
                     72: For the old hand, it has many good memory-jogging features.
                     73: For the newcomer, the user's aid can be used as a learning aid.
                     74: .PP
                     75: On occasion, you may want a list of all the Writer's Workbench system commands.
                     76: To get a list, type:
                     77: .PP
                     78: .ce
                     79: .B "wwbaid cmds"
                     80: .PP
                     81: If you are not familiar with the Writer's Workbench system
                     82: or the user's aid, 
                     83: you might find it convenient to use the on-line instruction session
                     84: as an introduction.
                     85: You can access it by typing:
                     86: .PP
                     87: .ce
                     88: .B "wwbaid instruct"
                     89: .PP
                     90: When you are familiar with the seven 
                     91: .I topics
                     92: that answer questions about Writer's Workbench system commands,
                     93: use the 
                     94: .B index
                     95: .I topic
                     96: to explore some of the features
                     97: of the Writer's Workbench system.
                     98: If you type:
                     99: .PP
                    100: .ce
                    101: .B "wwbaid open"
                    102: .PP
                    103: and press RETURN,
                    104: the program will answer you with:
                    105: .IP
                    106: .sp
                    107: For which Writer's Workbench system command do you want information?
                    108: .br
                    109: Type 
                    110: help
                    111: if you need a list.  Type
                    112: .B quit
                    113: to end this session.
                    114: .sp
                    115: At the prompt, type a command-name, help, or quit.
                    116: .br
                    117: =>
                    118: .PP
                    119: ``=>'' is a prompt for you to type a Writer's Workbench system
                    120: .I command-name.
                    121: Suppose you type
                    122: .B proofr.
                    123: The program will next ask you to enter a 
                    124: .I topic.
                    125: (Your choices are:  
                    126: .BR "bugs, description, example, index, options, format," " and " "uses" ".)"
                    127: If you chose 
                    128: .B description
                    129: as your
                    130: .I topic,
                    131: the program would respond by  printing a short passage
                    132: describing the 
                    133: .I proofr 
                    134: program.
                    135: Requests for other 
                    136: .I topics
                    137: and other Writer's Workbench
                    138: system command-names
                    139: will be handled similarly.
                    140: Typing 
                    141: .B quit
                    142: will end the session.
                    143: .PP
                    144: You can type the word 
                    145: .B all
                    146: as your response to a request for a 
                    147: .I topic
                    148: and as a response to a request for a 
                    149: .I command-name,
                    150: or as a response to both.
                    151: You will get:
                    152: .IP a)
                    153: all information on one command, if you type
                    154: .B all
                    155: instead of a 
                    156: .I topic.
                    157: .IP b)
                    158: all commands on one topic, if you type
                    159: .B all
                    160: instead of a
                    161: .I command-name.
                    162: .IP c)
                    163: all information on all commands, if you type
                    164: .B "all all" .
                    165: .PP
                    166: When you have become familiar with the Writer's Workbench system
                    167: and the user's aid,
                    168: you may want to use a more direct route to information.
                    169: .PP
                    170: For example, the command:
                    171: .PP
                    172: .ce 3
                    173: .B "wwbaid index all"
                    174: .sp
                    175: or
                    176: .sp
                    177: .B "wwbaid i all"
                    178: .PP
                    179: will print the complete index, and then exit.
                    180: .PP
                    181: Since every detail about the Writer's Workbench system
                    182: cannot be covered by the user's aid,
                    183: the command:
                    184: .PP
                    185: .ce
                    186: .B "wwbaid map"
                    187: .PP
                    188: will print a list of papers, reprints of talks, 
                    189: and related references about the Writer's Workbench system.
                    190: .PP
                    191: Whenever you need a memory-jogger, type 
                    192: .PP
                    193: .ce
                    194: .B wwbaid
                    195: .PP
                    196: for a list of the user's aid commands.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.