1 05/27/88  canonicalize, canon
 2 
 3 Syntax as a command:  canon path1 {path2} {-control_args}
 4 
 5 
 6 Function:  ensures that the contents of a single segment (SSF) or
 7 a multisegment file (MSF) are in canonical form.
 8 
 9 
10 Arguments:
11 path1
12    is the pathname of the input single segment or multisegment file.
13 path2
14    is the pathname of the output single segment or multisegment file.
15    If path2 is omitted, path1 is overwritten with the canonicalized
16    contents of the input single segment or multisegment file.
17 
18 
19 Control arguments:
20 -force, -fc
21    causes the output file to be overwritten without querying.
22 -no_force, -nfc
23    causes canonicalize to query before overwriting an existing
24    segment.  (Default)
25 -input_tabs -every X, -itabs -ev X
26    replaces tabs with the appropriate number of spaces, assuming that
27    tabs stops are at 1+n*X (where n= 1, 2, 3, ...).
28 -input_tabs n1,n2,...,n20, -itabs n1,n2,...,n20
29    replaces tabs with the appropriate number of spaces, assuming that
30    tab stops are as specified.
31 
32 
33 -output_tabs -every X, -otabs -ev X
34    inserts tabs at 1+n*X (where n= 1, 2, 3, ...).
35 -output_tabs n1,n2,...,n20, -otabs n1,n2,...,n20
36    inserts tabs at the tab stops specified.  Up to 20 tab stops can be
37    given.  No spaces are allowed in the list.
38 -no_output_tabs, -notabs
39    does not insert tabs into output.  (Default)
40 
41 
42 -temp_file PATH, -tf PATH
43    specifies the temporary file used to build the canonicalized data
44    during operation of the command.  By default, canon uses a uniquely
45    named file in the process directory.  However, when canonicalizing
46    a large file, there may not be enough quota in the process directory
47    to hold a copy of the file.  This control argument allows selection
48    of a directory with more quota, and naming of the temporary file.
49    If canonicalization is interrupted (by quitting, by a process
50    failure or system crash), the temporary file may contain the only
51    consistent copy of the data.  The equal convention may be used to
52    specify a temporary file name similar to the original file name.
53    For example, "-tf ===.canon" creates a temporary file in the working
54    directory named after the original file, with a .canon suffix.
55 
56 
57 Notes:  The command ensures that all characters in a print position are
58 sorted in the proper order and removes all ASCII carriage return (015)
59 characters.  When the -otabs control argument is specified, the
60 canonicalize command replaces blank spaces with the appropriate tab
61 stops.  Conversely, if the -otabs argument is not specified, horizontal
62 tab stops are replaced by the correct number of blank spaces.