.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH FADFIXPERMS 1 "1 January 2003"
.ne 5
.SH NAME
fadfixperms \- Fix the permissions of a set of files
.br
.ne 5
.SH SYNOPSIS
.B fadfixperms
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] [
.B \-n
|
.B \-\-simulate 
]
.I cfgfile
.br
.ne 5
.SH DESCRIPTION
This manual page documents version SPPSYM_RELEASE_ID of 
.B fadfixperms\fR.
.PP 
.B Fadfixperms
sets the permission of a hierarchy of files and directories according
to the rules specified in a configuration file.
.br
.ne 5
.SH CONFIGURATION
The configuration file, which is the only required argument consists of 
blank and hash-led lines, which are ignored, root path specifiers and
permission specifiers.
.PP
The root specifiers are of the form:
.IP "" 5
.B r \fIrootdir
.PP
which indicates that files and directories under
.I rootdir
should have their permissions fixed. Multiple 
.B r
entries are permitted. 
.PP
The permission specifiers are of the form:
.IP "" 5
.I permission pattern
.PP
Files and directories which match
.I pattern
(according to 
.B perlre\fR(1))
will have the permissions changed according to
.I permission\fR.
In turn,
.I permission
is a sequence of nine characters representing the read, write and execute
permissions for the file's owner and the file's group (giving nine characters
for all combinations, just as is displayed by 
.B ls\fR(1))
with the 
.B \-l
option. The characters may be:
.RS 5
.TP 5
.B r
the individual read permission addressed by the position of this character (position 1 
for the owner, position 4 for the group, position 7 for others) will be set
on.
.TP
.B w
the individual write permission addressed by the position of this character (position 2
for the owner, position 5 for the group, position 8 for others) will be set
on.
.TP
.B x
the individual execute permission addressed by the position of this character (position 3
for the owner, position 6 for the group, position 9 for others) will be set
on.
.TP
.B \-
the individual permission addressed by the position of this character will
not be set.
.TP
.B c
the individual permission addressed by the position of this character will be
copied from the corresponding permission for the owner of the file. This character
is only valid in positions for the group (4-6) and others (7-9)
.TP
.B !
the individual permission addressed by the position of this character will
not be changed from its current value.
.RE
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR,\fB \-\-debug=\fIlevel\fR
Determines how verbose
.B fadfixperms
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-h\fR,\fB \-\-help
Displays a brief usage message.
.TP
.B \-n\fR,\fB \-\-simulate
.B Fadfixperms
displays the actions it would take but does not do anything.
.TP
.B \-p\fR,\fB \-\-list\-paths
List the compiled-in paths of various files and directories that
.B fadfixperms
uses.
.TP 
.B \-v\fR,\fB \-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR,\fB \-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B fadfixperms
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following configuration would allow other users access to user
fbloggs's \(oqwork' directory, while keeping everything else private:
.IP
.nf
.fam C
r /home/fbloggs
!!!c-cc-c .*/work(|/.*)
!!!------ .*
.fam T
.fi
.PP
Alternatively, the following would keep the directory \(oqmail'
private, while opening everything else up:
.IP
.nf
.fam C
r /home/fbloggs
!!!------ .*/mail(|/.*)
!!!c-cc-c .*
.fam T
.fi
.PP
.br
.ne 5
.SH CAVEATS
When a file is to be made accessible to the group or others, there is an implied
requirement to make the directories between the root (specified in
the configuration file) and the file readable and executable too. 
.PP
.B Fadfixperms
ignores symlinks. If you make extensive use of symlinks, then things 
can get very confusing.
.br
.ne 5
.SH SEE ALSO
perlre(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2002-SPPSYM_RELEASE_YEAR SPPSYM_AUTHOR_NAME
.PP
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.
.PP
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.
.PP
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., 675 Mass Ave, Cambridge, MA 02139, USA.