| 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 |
| 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. If only one is specified then the other is set to |
| 49 | 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. This is achieved by replacing special characters |
| 55 | with '_', prefixing device names with '_' and stripping trailing dots and |
| 56 | spaces. |
| 57 | .SS "File Selection" |
| 58 | .TP |
| 59 | .B --include\fI PATTERN\fR, \fB-i\fI PATTERN |
| 60 | Include filenames matching the glob pattern \fIPATTERN\fR. |
| 61 | .TP |
| 62 | .B --exclude\fI PATTERN\fR, \fB-e\fI PATTERN |
| 63 | Exclude filenames matching the glob pattern \fIPATTERN\fR. |
| 64 | .PP |
| 65 | These options may be used more than once. They will be checked in order and |
| 66 | the first that matches any given filename will determine whether that file is |
| 67 | included or excluded. |
| 68 | .PP |
| 69 | If none of the options match and \fB--include\fR was used at all then the file |
| 70 | is excluded. If none of the options match and \fB--include\fR was never used |
| 71 | then the file is included. |
| 72 | .SS "File Copying" |
| 73 | .TP |
| 74 | .B --link\fR, \fB-l |
| 75 | Files are hard-linked to their destination location. This is the default |
| 76 | action. |
| 77 | .TP |
| 78 | .B --symlink\fR, \fB-s |
| 79 | Symlinks are made in the destination location pointing back into the source |
| 80 | directory. |
| 81 | .TP |
| 82 | .B --copy\fR, \fB-c |
| 83 | Files are copied into their destination location. |
| 84 | .TP |
| 85 | .B --no-action\fR, \fB-n |
| 86 | The destination location is not modified in any way. Instead a report is |
| 87 | written to standard output saying what would be done. |
| 88 | .SS "Other" |
| 89 | .TP |
| 90 | .B --debug\fR, \fB-d |
| 91 | Enable debugging. |
| 92 | .TP |
| 93 | .B --help\fR, \fB-h |
| 94 | Display a usage message. |
| 95 | .TP |
| 96 | .B --version\fR, \fB-V |
| 97 | Display version number. |
| 98 | .\" Local Variables: |
| 99 | .\" mode:nroff |
| 100 | .\" fill-column:79 |
| 101 | .\" End: |