chiark / gitweb /
Ask for -std=gnu99 if necessary to get full <limits.h>.
[disorder] / doc / disorderfm.1.in
index 81b48f37296ae9037e7eb359d03aa5529c865a87..822a36698949b789f9c109cda9d373adced88fdd 100644 (file)
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (C) 2006 Richard Kettlewell
+.\" Copyright (C) 2006-2008 Richard Kettlewell
 .\"
 .\" This program is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
@@ -31,70 +31,73 @@ recursively links or copies files from
 to
 .IR DESTINATION ,
 transforming filenames along the way.
+.PP
+This program is not well-tested!
 .SH OPTIONS
 .SS "Filename Format"
 .TP
-.B --from\fI ENCODING\fR, \fB-f\fI ENCODING
+.B \-\-from\fI ENCODING\fR, \fB\-f\fI ENCODING
 Specifies the filename encoding used below
 .IR SOURCE .
 .TP
-.B --to\fI ENCODING\fR, \fB-t\fI ENCODING
+.B \-\-to\fI ENCODING\fR, \fB\-t\fI ENCODING
 Specifies the filename encoding used below
 .IR DESTINATION .
 .PP
-If neither of \fB--from\fR or \fB--to\fR are specified then no encoding
-translation is performed.  If only one is specified then the other is set to
-the current locale.
+If neither of \fB\-\-from\fR or \fB\-\-to\fR are specified then no encoding
+translation is performed.
+If only one is specified then the other is set to the current locale.
 .TP
-.B --windows-friendly\fR, \fB-w
+.B \-\-windows\-friendly\fR, \fB\-w
 Specifies that filenames below
 .I DESTINATION
-must be Windows-friendly.  This is achieved by replacing special characters
-with '_', prefixing device names with '_' and stripping trailing dots and
+must be Windows-friendly.
+This is achieved by replacing special characters with '_', prefixing
+device names with '_' and stripping trailing dots and
 spaces.
 .SS "File Selection"
 .TP
-.B --include\fI PATTERN\fR, \fB-i\fI PATTERN
+.B \-\-include\fI PATTERN\fR, \fB\-i\fI PATTERN
 Include filenames matching the glob pattern \fIPATTERN\fR.
 .TP
-.B --exclude\fI PATTERN\fR, \fB-e\fI PATTERN
+.B \-\-exclude\fI PATTERN\fR, \fB\-e\fI PATTERN
 Exclude filenames matching the glob pattern \fIPATTERN\fR.
 .PP
-These options may be used more than once.  They will be checked in order and
-the first that matches any given filename will determine whether that file is
-included or excluded.
+These options may be used more than once.
+They will be checked in order and the first that matches any given
+filename will determine whether that file is included or excluded.
 .PP
-If none of the options match and \fB--include\fR was used at all then the file
-is excluded.  If none of the options match and \fB--include\fR was never used
-then the file is included.
+If none of the options match and \fB\-\-include\fR was used at all then the file
+is excluded.
+If none of the options match and \fB\-\-include\fR was never used then the file
+is included.
 .SS "File Copying"
 .TP
-.B --link\fR, \fB-l
-Files are hard-linked to their destination location.  This is the default
-action.
+.B \-\-link\fR, \fB\-l
+Files are hard-linked to their destination location.
+This is the default action.
 .TP
-.B --symlink\fR, \fB-s
+.B \-\-symlink\fR, \fB\-s
 Symlinks are made in the destination location pointing back into the source
 directory.
 .TP
-.B --copy\fR, \fB-c
+.B \-\-copy\fR, \fB\-c
 Files are copied into their destination location.
 .TP
-.B --no-action\fR, \fB-n
-The destination location is not modified in any way.  Instead a report is
-written to standard output saying what would be done.
+.B \-\-no\-action\fR, \fB\-n
+The destination location is not modified in any way.
+Instead a report is written to standard output saying what would be done.
 .SS "Other"
 .TP
-.B --debug\fR, \fB-d
+.B \-\-debug\fR, \fB\-d
 Enable debugging.
 .TP
-.B --help\fR, \fB-h
+.B \-\-help\fR, \fB\-h
 Display a usage message.
 .TP
-.B --version\fR, \fB-V
+.B \-\-version\fR, \fB\-V
 Display version number.
 .\" Local Variables:
 .\" mode:nroff
 .\" fill-column:79
 .\" End:
-.\" arch-tag:HqblI8GXJamh2oeBBgb1Ug