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