Annotation of researchv10dc/man/manw/mkstand.1, revision 1.1.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.1, January 1981
                      3: .TH MKSTAND 1
                      4: .SH NAME
                      5: mkstand \- compile style standards for prose program
                      6: .SH SYNOPSIS
                      7: .B mkstand
                      8: [
                      9: .B \-flags
                     10: ][
                     11: .B \-ver
                     12: ][
                     13: .B \-mm
                     14: |
                     15: .B \-ms
                     16: ][
                     17: .B \-li
                     18: |
                     19: .B \+li
                     20: ][
                     21: .B \-o
                     22: outfile ] file1 file2 ...
                     23: .SH DESCRIPTION
                     24: .I Mkstand
                     25: enables users to compile their own set of
                     26: .IR style (1)
                     27: standards for use by
                     28: .IR prose (1).
                     29: .I Prose
                     30: describes stylistic features of a text
                     31: and compares them to specified standards.
                     32: If a user or group, for example a writing group,
                     33: has many documents of a certain type
                     34: that they consider good,
                     35: those documents can be used as the basis for their own standards.
                     36: .I Mkstand
                     37: creates the standards,
                     38: which reflect the stylistic features
                     39: of the input documents.
                     40: Then the user can use
                     41: .I prose
                     42: to evaluate documents according to those standards.
                     43: .PP
                     44: .I Mkstand
                     45: runs
                     46: .I style
                     47: on a set of documents and computes the means
                     48: and standard deviations of certain
                     49: .I style 
                     50: statistics.
                     51: Then it puts these into 
                     52: .I outfile
                     53: .RI ( stand.out
                     54: is the default) in a format that
                     55: .I prose
                     56: can read.
                     57: Then if
                     58: .I prose
                     59: is run with the  command:
                     60: .PP
                     61: .RS 5
                     62: .BI "prose \-x " "outfile textfile" 
                     63: .RE
                     64: .PP
                     65: it compares
                     66: .I textfile
                     67: with the standards in
                     68: .IR outfile .
                     69: The command:
                     70: .PP
                     71: .RS 5
                     72: .BI "wwbstand \-x " "outfile"
                     73: .RE
                     74: .PP
                     75: will display the standards in a comprehensible form.
                     76: .PP
                     77: .I Mkstand
                     78: tries to produce valid standards by enforcing these requirements:
                     79: .RS 5
                     80: .TP
                     81: 1.
                     82: Input files must be at least 90 sentences or 1900 words long.
                     83: .TP
                     84: 2.
                     85: If an input file has 
                     86: .I style
                     87: scores that are more than 2 standard deviations from the mean,
                     88: scores for that file are excluded from the computation of the standards.
                     89: .RE
                     90: .PP
                     91: Although
                     92: .I mkstand
                     93: will compile standards for any number of documents (up to 75),
                     94: standards will be most reliable if at least 20 documents are used.
                     95: .PP
                     96: Because
                     97: .I mkstand
                     98: runs
                     99: .IR deroff (1)
                    100: on input files before computing scores,
                    101: formatting header files should be included as part of the input.
                    102: .PP
                    103: Four options affect
                    104: .IR deroff :
                    105: .RS 5
                    106: .TP
                    107: .B \-mm
                    108: eliminate
                    109: .IR mm (1)
                    110: macros, and associated text that is not part of sentences
                    111: (e.g. headings),
                    112: from the analysis.
                    113: This is the default.
                    114: .TP
                    115: .B \-ms
                    116: eliminate
                    117: .IR ms (1)
                    118: macros, and associated text that is not part of sentences,
                    119: from the analysis.
                    120: The
                    121: .B \-ms
                    122: flag overrides the default,
                    123: .BR \-mm .
                    124: .TP
                    125: .B \-li
                    126: eliminate list items,
                    127: as defined by 
                    128: .I mm
                    129: macros, from the analysis.
                    130: This is the default.
                    131: .TP
                    132: .B \+li
                    133: Include list items in the input text,
                    134: in the analysis.
                    135: This flag should be used if the texts contain lists of sentences,
                    136: but not if the texts contain many lists of non-sentences.
                    137: .RE
                    138: .PP
                    139: Other options are:
                    140: .RS 5
                    141: .TP 11
                    142: .BI \-o " outfile"
                    143: put standards in
                    144: .I outfile
                    145: instead of the default
                    146: .IR stand.out .
                    147: .RE
                    148: .PP
                    149: Two options give information about the program:
                    150: .RS 5
                    151: .TP 7
                    152: .B \-flags
                    153: print the command synopsis line (see above)
                    154: showing command flags and options,
                    155: then exit.
                    156: .TP
                    157: .B \-ver
                    158: print the Writer's Workbench version number of the command, then exit.
                    159: .RE
                    160: .PP
                    161: .I Mkstand
                    162: saves the
                    163: .I style
                    164: scores it used in computing the standards in a file named
                    165: .IR styl.scores .
                    166: Users should examine the scores in this file
                    167: for any scores that seem unusual or invalid.
                    168: If any are found,
                    169: .I mkstand
                    170: should be rerun without the unusual document.
                    171: .SH FILES
                    172: .TP 21
                    173: /tmp/$$stat.out
                    174: temporary file containing 
                    175: .I style
                    176: tables of input files
                    177: .TP
                    178: stand.out
                    179: default output file containing standards
                    180: .TP
                    181: styl.scores
                    182: output file containing
                    183: .I style
                    184: scores used in compiling standards
                    185: .SH SEE ALSO
                    186: prose(1),
                    187: style(1),
                    188: deroff(1),
                    189: wwbstand(1),
                    190: wwb(1).
                    191: .SH SUPPORT
                    192: .IR "COMPONENT NAME:  " "Writer's Workbench"
                    193: .br
                    194: .IR "APPROVAL AUTHORITY:  " "Div 452"
                    195: .br
                    196: .IR "STATUS:  " Standard
                    197: .br
                    198: .IR "SUPPLIER:  " "Dept 45271"
                    199: .br
                    200: .IR "USER INTERFACE:  " "Stacey Keenan, Dept 45271, PY x3733"
                    201: .br
                    202: .IR "SUPPORT LEVEL: " "Class B - unqualified support other than Div 452"

unix.superglobalmegacorp.com

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