[disorder] / doc / disorderfm.1.in

.\"
.\" Copyright (C) 2006 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
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
.\" USA
.\"
.TH disorderfm 1
.SH NAME
disorderfm \- DisOrder file management utility
.SH SYNOPSIS
.B disorderfm
.RI [ OPTIONS ]
.I SOURCE
.I DESTINATION
.SH DESCRIPTION
.B disorderfm
recursively links or copies files from
.I SOURCE
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
Specifies the filename encoding used below
.IR SOURCE .
.TP
.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.
.TP
.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
spaces.
.SS "File Selection"
.TP
.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
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.
.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.
.SS "File Copying"
.TP
.B --link\fR, \fB-l
Files are hard-linked to their destination location.
This is the default action.
.TP
.B --symlink\fR, \fB-s
Symlinks are made in the destination location pointing back into the source
directory.
.TP
.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.
.SS "Other"
.TP
.B --debug\fR, \fB-d
Enable debugging.
.TP
.B --help\fR, \fB-h
Display a usage message.
.TP
.B --version\fR, \fB-V
Display version number.
.\" Local Variables:
.\" mode:nroff
.\" fill-column:79
.\" End:
Commit	Line	Data
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
	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.
25ca855b RK	34	.PP
25ca855b RK	35	This program is not well-tested!
460b9539	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
c0c23a60 RK	48	translation is performed.
c0c23a60 RK	49	If only one is specified then the other is set to the current locale.
460b9539	50	.TP
	51	.B --windows-friendly\fR, \fB-w
	52	Specifies that filenames below
	53	.I DESTINATION
c0c23a60 RK	54	must be Windows-friendly.
	55	This is achieved by replacing special characters with '_', prefixing
	56	device names with '_' and stripping trailing dots and
460b9539	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
c0c23a60 RK	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.
460b9539	69	.PP
460b9539	70	If none of the options match and \fB--include\fR was used at all then the file
c0c23a60 RK	71	is excluded.
	72	If none of the options match and \fB--include\fR was never used then the file
	73	is included.
460b9539	74	.SS "File Copying"
	75	.TP
	76	.B --link\fR, \fB-l
c0c23a60 RK	77	Files are hard-linked to their destination location.
c0c23a60 RK	78	This is the default action.
460b9539	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
c0c23a60 RK	88	The destination location is not modified in any way.
c0c23a60 RK	89	Instead a report is written to standard output saying what would be done.
460b9539	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: