chiark / gitweb /
document login window
[disorder] / doc / disorderfm.1.in
CommitLineData
460b9539 1.\"
2.\" Copyright (C) 2006 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
21disorderfm \- 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
29recursively links or copies files from
30.I SOURCE
31to
32.IR DESTINATION ,
33transforming filenames along the way.
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. If only one is specified then the other is set to
47the current locale.
48.TP
49.B --windows-friendly\fR, \fB-w
50Specifies that filenames below
51.I DESTINATION
52must be Windows-friendly. This is achieved by replacing special characters
53with '_', prefixing device names with '_' and stripping trailing dots and
54spaces.
55.SS "File Selection"
56.TP
57.B --include\fI PATTERN\fR, \fB-i\fI PATTERN
58Include filenames matching the glob pattern \fIPATTERN\fR.
59.TP
60.B --exclude\fI PATTERN\fR, \fB-e\fI PATTERN
61Exclude filenames matching the glob pattern \fIPATTERN\fR.
62.PP
63These options may be used more than once. They will be checked in order and
64the first that matches any given filename will determine whether that file is
65included or excluded.
66.PP
67If none of the options match and \fB--include\fR was used at all then the file
68is excluded. If none of the options match and \fB--include\fR was never used
69then the file is included.
70.SS "File Copying"
71.TP
72.B --link\fR, \fB-l
73Files are hard-linked to their destination location. This is the default
74action.
75.TP
76.B --symlink\fR, \fB-s
77Symlinks are made in the destination location pointing back into the source
78directory.
79.TP
80.B --copy\fR, \fB-c
81Files are copied into their destination location.
82.TP
83.B --no-action\fR, \fB-n
84The destination location is not modified in any way. Instead a report is
85written to standard output saying what would be done.
86.SS "Other"
87.TP
88.B --debug\fR, \fB-d
89Enable debugging.
90.TP
91.B --help\fR, \fB-h
92Display a usage message.
93.TP
94.B --version\fR, \fB-V
95Display version number.
96.\" Local Variables:
97.\" mode:nroff
98.\" fill-column:79
99.\" End: