6 \fB\h'-\w'\\$1'u-1m'\\$1\h'1m'\fP\c
8 .TH space 1 "27 January 2007" "Straylight/Edgeware"
10 space \- check and fix whitespace in files
20 program identifies and fixes problematic use of whitespace in text
21 files. In particular, it will notice and (if you want) fix
23 .I trailing whitespace
24 \(en tabs and spaces just before a newline;
27 \(en which are obviously pointless;
29 .I end-of-file in mid-line
30 \(en which confuses a number of programs,
34 .I groups of spaces which could be replaced by tabs
35 \(en replacing them with the appropriate tab characters; or
38 \(en replacing them with appropriate numbers of spaces.
40 The program is capable of fixing files in place (leaving backups if you
43 The following command-line options are recognized.
46 Give a short help message describing the options available.
49 Just check files, exiting zero if they're all OK, or 1 if there are
50 whitespace problems with any of them; exit 32 if there are actual
51 errors. You may want the
53 option with this; without it,
60 in place. During processing, the fixed copy of the file is written to
61 some new name not currently in use. If the processing was successful,
66 and the new file is renamed to
68 If something very complicated goes wrong at just the right moment, it's
69 possible that you'll be left with just
71 but that's not very likely. The new file is created with the same
72 permissions as the old file, but no attempt is made to give it the same
73 owner or anything like that.
76 Worry about tabs in the middle of lines as well as tabs forming the
77 initial indentation. Normally, identify (and fix) tabs preceded by
78 spaces in the middle of lines; with
80 fix all groups of whitespace which could be turned into tabs.
83 Turn runs of horizontal whitespace into tabs where possible.
86 only complain about runs of space which could be turned into tabs but
87 don't actually do anything. By default, only runs of whitespace at the
88 starts of lines are affected. With
90 however, all runs of whitespace are considered to be fair game. The
91 rules for internal whitespace are as follows. A run at the start of a
92 line, or which contains a tab is always fair game; a run of two or more
99 character, either immediately or separated only by
103 characters, in which case three spaces are required. This is because
104 some typists (including the author) put two spaces after a full stop,
105 and don't want them randomly turning into tabs for no good reason.
108 Turn tabs into appropriate numbers of spaces. With
110 only complain about finding tabs, but don't actually do anything. All
111 tabs are considered fair game here and the
115 Tab stops are assumed to occur every eight columns, as is usual.
117 There's no way yet of controlling where the tab stops are.
119 This space program doesn't even attempt moon landings. The space man
120 page doesn't have wiggly antennae.
122 The jokes in the man page are somewhat lame.
124 Mark Wooding, <mdw@distorted.org.uk>