chiark / gitweb /
Doxygen file headers for most files
[disorder] / doc / disorderfm.1.in
... / ...
CommitLineData
1.\"
2.\" Copyright (C) 2006-2008 Richard Kettlewell
3.\"
4.\" This program is free software: you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation, either version 3 of the License, or
7.\" (at your option) any later version.
8.\"
9.\" This program is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
16.\"
17.TH disorderfm 1
18.SH NAME
19disorderfm \- DisOrder file management utility
20.SH SYNOPSIS
21.B disorderfm
22.RI [ OPTIONS ]
23.I SOURCE
24.I DESTINATION
25.SH DESCRIPTION
26.B disorderfm
27recursively links or copies files from
28.I SOURCE
29to
30.IR DESTINATION ,
31transforming filenames along the way.
32.PP
33This program is not well-tested!
34.SH OPTIONS
35.SS "Filename Format"
36.TP
37.B \-\-from\fI ENCODING\fR, \fB\-f\fI ENCODING
38Specifies the filename encoding used below
39.IR SOURCE .
40.TP
41.B \-\-to\fI ENCODING\fR, \fB\-t\fI ENCODING
42Specifies the filename encoding used below
43.IR DESTINATION .
44.PP
45If neither of \fB\-\-from\fR or \fB\-\-to\fR are specified then no encoding
46translation is performed.
47If only one is specified then the other is set to the current locale.
48.TP
49.B \-\-windows\-friendly\fR, \fB\-w
50Specifies that filenames below
51.I DESTINATION
52must be Windows-friendly.
53This is achieved by replacing special characters with '_', prefixing
54device names with '_' and stripping trailing dots and
55spaces.
56.SS "File Selection"
57.TP
58.B \-\-include\fI PATTERN\fR, \fB\-i\fI PATTERN
59Include filenames matching the glob pattern \fIPATTERN\fR.
60.TP
61.B \-\-exclude\fI PATTERN\fR, \fB\-e\fI PATTERN
62Exclude filenames matching the glob pattern \fIPATTERN\fR.
63.PP
64These options may be used more than once.
65They will be checked in order and the first that matches any given
66filename will determine whether that file is included or excluded.
67.PP
68If none of the options match and \fB\-\-include\fR was used at all then the file
69is excluded.
70If none of the options match and \fB\-\-include\fR was never used then the file
71is included.
72.SS "File Copying"
73.TP
74.B \-\-link\fR, \fB\-l
75Files are hard-linked to their destination location.
76This is the default action.
77.TP
78.B \-\-symlink\fR, \fB\-s
79Symlinks are made in the destination location pointing back into the source
80directory.
81.TP
82.B \-\-copy\fR, \fB\-c
83Files are copied into their destination location.
84.TP
85.B \-\-no\-action\fR, \fB\-n
86The destination location is not modified in any way.
87Instead a report is written to standard output saying what would be done.
88.SS "Other"
89.TP
90.B \-\-debug\fR, \fB\-d
91Enable debugging.
92.TP
93.B \-\-help\fR, \fB\-h
94Display a usage message.
95.TP
96.B \-\-version\fR, \fB\-V
97Display version number.
98.\" Local Variables:
99.\" mode:nroff
100.\" fill-column:79
101.\" End: