Return to prose.1 CVS log

Up to [Research Unix] / researchv10dc / man / manw

Annotation of researchv10dc/man/manw/prose.1, revision 1.1

1.1     ! root        1: .id NOTICE-NOT TO BE DISCLOSED OUTSIDE BELL SYS EXCEPT UNDER WRITTEN AGRMT
        !             2: .id Writer's Workbench version 2.2, February 24, 1981
        !             3: .TH PROSE 1
        !             4: .SH NAME
        !             5: prose \- describe style characteristics of text
        !             6: .SH SYNOPSIS
        !             7: .B prose
        !             8: [
        !             9: .B \-flags
        !            10: ][
        !            11: .B \-ver
        !            12: ]
        !            13: [
        !            14: .B \-tm
        !            15: |
        !            16: .B \-c
        !            17: |
        !            18: .B \-t
        !            19: |
        !            20: .B \-x
        !            21: standards-file
        !            22: ][
        !            23: .B \-mm
        !            24: |
        !            25: .B \-ms
        !            26: ] [
        !            27: .B \-li
        !            28: |
        !            29: .B \+li
        !            30: ][
        !            31: .B \-s
        !            32: ][
        !            33: .B \-f
        !            34: style-file | file ...]
        !            35: .SH DESCRIPTION
        !            36: .I Prose
        !            37: describes the writing style of a document
        !            38: as determined by 
        !            39: .IR style "(1),
        !            40: but the output is in prose form.
        !            41: The output describes readability, word and sentence lengths,
        !            42: sentence structure and variation.
        !            43: .PP
        !            44: The program checks that a document's scores on certain 
        !            45: .I style
        !            46: variables fall within the average range for documents of a specified type.
        !            47: Whenever the score for a variable is outside the average range,
        !            48: a warning message is printed with information
        !            49: about the variable,
        !            50: and commands that can be run to get further information.
        !            51: .PP
        !            52: .I Prose
        !            53: creates a file called
        !            54: .I styl.tmp
        !            55: that contains the table produced by
        !            56: .IR style .
        !            57: .PP
        !            58: .I Prose
        !            59: compares a document with standards
        !            60: for one of several document types,
        !            61: according to the following flags:
        !            62: .RS 5
        !            63: .TP 5
        !            64: .B \-tm
        !            65: Compare input text to good Bell Laboratories TM's.  (This is the default.)
        !            66: .TP
        !            67: .B \-c
        !            68: Evaluate input text for craft suitability.
        !            69: .TP
        !            70: .B \-t
        !            71: Compare input text with good training documents.
        !            72: .TP
        !            73: .BI \-x " standards-file"
        !            74: Compare input text with standards contained in user-specified
        !            75: .IR standards-file .
        !            76: See
        !            77: .IR mkstand (1)
        !            78: to set up the 
        !            79: .IR standards-file .
        !            80: .RE
        !            81: .PP
        !            82: Because 
        !            83: .I prose
        !            84: runs
        !            85: .IR deroff (1)
        !            86: before looking at the text,
        !            87: formatting header files should be included as part of the input.
        !            88: .PP
        !            89: Options affecting 
        !            90: .IR deroff (1)
        !            91: are:
        !            92: .RS 5
        !            93: .TP
        !            94: .B \-mm
        !            95: eliminate
        !            96: .IR mm (1)
        !            97: macros, and associated text that is not part of sentences
        !            98: (e.g. headings),
        !            99: from the analysis.
        !           100: This is the default.
        !           101: .TP
        !           102: .B \-ms
        !           103: eliminate
        !           104: .IR ms (1)
        !           105: macros, and associated text that is not part of sentences,
        !           106: from the analysis.
        !           107: The
        !           108: .B \-ms
        !           109: flag overrides the default,
        !           110: .BR \-mm .
        !           111: .TP
        !           112: .B \-li
        !           113: eliminate list items,
        !           114: as defined by 
        !           115: .I mm
        !           116: macros, from the analysis.
        !           117: This is the default.
        !           118: .TP
        !           119: .B \+li
        !           120: Include list items in the input text,
        !           121: in the analysis.
        !           122: This flag should be used if the text contains lists of sentences,
        !           123: but not if the text contains many lists of non-sentences.
        !           124: .RE
        !           125: .PP
        !           126: Other options are:
        !           127: .RS 5
        !           128: .TP
        !           129: .B \-s
        !           130: Produce a short (10 line) summary version of
        !           131: .IR prose .
        !           132: .TP
        !           133: .BI \-f " style-file"
        !           134: If a file containing the
        !           135: .I style
        !           136: table exists as output from the 
        !           137: .I style
        !           138: program,
        !           139: or from a previous 
        !           140: .I prose
        !           141: run,
        !           142: it may be specified so that 
        !           143: .I prose
        !           144: need not run
        !           145: .I style
        !           146: again.
        !           147: .I Styl.tmp
        !           148: can be used as the
        !           149: .IR style-file .
        !           150: The input text file should not be used with the
        !           151: .B \-f
        !           152: flag.
        !           153: .RE
        !           154: .PP
        !           155: Two options give information about the program:
        !           156: .RS 5
        !           157: .TP 7
        !           158: .B \-flags
        !           159: print the command synopsis line (see above)
        !           160: showing command flags and options,
        !           161: then exit.
        !           162: .TP
        !           163: .B \-ver
        !           164: print the Writer's Workbench version number of the command, then exit.
        !           165: .RE
        !           166: .PP
        !           167: .I Prose
        !           168: is one of the programs run under the 
        !           169: .IR wwb (1)
        !           170: command.
        !           171: .SH EXAMPLES
        !           172: The command:
        !           173: .PP
        !           174: .RS 5
        !           175: .B "prose \-t \+li filename"
        !           176: .RE
        !           177: .PP
        !           178: will describe how the style characteristics of
        !           179: .I filename
        !           180: compare with standards for training documents.
        !           181: Lists will be included in the analysis.
        !           182: The
        !           183: .IR style (1)
        !           184: table will be left in the file
        !           185: .IR styl.tmp .
        !           186: .br
        !           187: Then the command:
        !           188: .PP
        !           189: .RS 5
        !           190: .B "prose \-x standards-file \-f styl.tmp"
        !           191: .RE
        !           192: .PP
        !           193: will use the style statistics already gathered for
        !           194: .IR filename ,
        !           195: and describe how they compare with the user-defined
        !           196: standards contained in 
        !           197: .IR standards-file .
        !           198: .SH FILES
        !           199: .TP 21
        !           200: styl.tmp
        !           201: contains 
        !           202: .I style 
        !           203: table
        !           204: .TP
        !           205: wwb/lib/prosedoc
        !           206: contains all standards used for comparison,
        !           207: and stored
        !           208: .I prose 
        !           209: output text files
        !           210: .SH SEE ALSO
        !           211: style(1), wwb(1),
        !           212: deroff(1),
        !           213: match(1),
        !           214: wwbstand(1),
        !           215: mkstand(1),
        !           216: worduse(1).
        !           217: .SH SUPPORT
        !           218: .IR "COMPONENT NAME:  " "Writer's Workbench"
        !           219: .br
        !           220: .IR "APPROVAL AUTHORITY:  " "Div 452"
        !           221: .br
        !           222: .IR "STATUS:  " Standard
        !           223: .br
        !           224: .IR "SUPPLIER:  " "Dept 45271"
        !           225: .br
        !           226: .IR "USER INTERFACE:  " "Stacey Keenan, Dept 45271, PY x3733"
        !           227: .br
        !           228: .IR "SUPPORT LEVEL: " "Class B - unqualified support other than Div 452"

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