mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
e3dfba8e6c
This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.
223 lines
6.9 KiB
Plaintext
223 lines
6.9 KiB
Plaintext
=head1 NAME
|
|
|
|
fs exportafs - Reports or sets whether the machine can export AFS to clients of other file
|
|
systems
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
fs exportafs -type <I<exporter name>>
|
|
[B<-start> <I<start/stop translator (on | off)>>]
|
|
[-convert <I<convert from afs to unix mode (on | off)>>]
|
|
[-uidcheck <I<run on strict 'uid check' mode (on | off)>>]
|
|
[-submounts <I<allow nfs mounts to subdirs of /afs/.. (on | off)>>]
|
|
[-help]
|
|
|
|
fs exp -t <I<exporter name>>
|
|
[B<-st> <I<start/stop translator (on | off)>>]
|
|
[-c <I<convert from afs to unix mode (on | off)>>]
|
|
[-u <I<run on strict 'uid check' mode (on | off)>>]
|
|
[-su <I<allow nfs mounts to subdirs of /afs/.. (on | off)>>]
|
|
[-help]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<fs exportafs> command sets (if the -start argument
|
|
is provided) or reports (if it is omitted) whether the machine can reexport
|
|
the AFS filespace to clients of a non-AFS file system. To control
|
|
certain features of the translation protocol, use the following
|
|
arguments:
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
To control whether the UNIX B<group> and other mode
|
|
bits on an AFS file or directory are set to match the B<owner> mode
|
|
bits when it is exported to the non-AFS file system, use the
|
|
B<-convert> argument.
|
|
|
|
|
|
=item *
|
|
|
|
To control whether tokens can be placed in a credential structure
|
|
identified by a UID that differs from the local UID of the entity that is
|
|
placing the tokens in the structure, use the B<-uidcheck>
|
|
argument. The most common use is to control whether issuers of the
|
|
B<knfs> command can specify a value for its B<-id> argument
|
|
that does not match their local UID on the NFS/AFS translator machine.
|
|
|
|
|
|
=item *
|
|
|
|
To control whether users can create mounts in the non-AFS filespace to an
|
|
AFS directory other than B</afs>, use the B<-submounts>
|
|
argument.
|
|
|
|
|
|
=back
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -type
|
|
|
|
Names the alternate file system to which to reexport the AFS
|
|
filespace. The only acceptable value is B<nfs>, in lowercase
|
|
letters only.
|
|
|
|
=item -start
|
|
|
|
Enables the local machine to reexport the AFS filespace if the value is
|
|
B<on>, or disables it if the value is B<off>. Omit this
|
|
argument to report the current setting for all of the configurable
|
|
parameters.
|
|
|
|
=item -convert
|
|
|
|
Controls the setting of the UNIX B<group> and other
|
|
mode bits on AFS files and directories exported to the non-AFS file
|
|
system. If the value is B<on>, they are set to match the
|
|
B<owner> mode bits. If the value is B<off>, the bits
|
|
are not changed. If this argument is omitted, the default value is
|
|
B<on>.
|
|
|
|
=item -uidcheck
|
|
|
|
Controls whether tokens can be placed in a credential structure identified
|
|
by a UID that differs from the local UID of the entity that is placing the
|
|
tokens in the structure.
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
If the value is on, the UID that identifies the credential
|
|
structure must match the local UID.
|
|
|
|
|
|
With respect to the knfs command, this value means that the
|
|
value of B<-id> argument must match the issuer's local UID on the
|
|
translator machine. In practice, this setting makes it pointless to
|
|
include the B<-id> argument to the B<knfs> command, because
|
|
the only acceptable value (the issuer's local UID) is already used when
|
|
the B<-id> argument is omitted.
|
|
|
|
Enabling UID checking also makes it impossible to issue the klog
|
|
and B< pagsh> commands on a client machine of the non-AFS file system
|
|
even though it is a system type supported by AFS. For an explanation,
|
|
see the reference page for the B<klog> command.
|
|
|
|
=item *
|
|
|
|
If the value is off (the default), tokens can be assigned to a
|
|
local UID in the non-AFS file system that does not match the local UID of the
|
|
entity assigning the tokens.
|
|
|
|
|
|
With respect to the knfs command, it means that the issuer can
|
|
use the B<-id> argument to assign tokens to a local UID on the NFS
|
|
client machine that does not match his or her local UID on the translator
|
|
machine. (An example is assigning tokens to the MFS client
|
|
machine's local superuser B<root>.) This setting allows
|
|
more than one issuer of the B<knfs> command to make tokens available
|
|
to the same user on the NFS client machine. Each time a different user
|
|
issues the B<knfs> command with the same value for the B<-id>
|
|
argument, that user's tokens overwrite the existing ones. This can
|
|
result in unpredictable access for the user on the NFS client machine.
|
|
|
|
=back
|
|
|
|
=item -submounts
|
|
|
|
Controls whether a user of the non-AFS filesystem can mount any directory
|
|
in the AFS filespace other than the top-level B</afs>
|
|
directory. If the value is B<on>, such submounts are
|
|
allowed. If the value is off, only mounts of the B</afs>
|
|
directory are allowed. If this argument is omitted, the default value
|
|
is B<off>.
|
|
|
|
=item -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
If the machine is not even configured as a server of the non-AFS file
|
|
system, the following message appears:
|
|
|
|
Sorry, the I<file_system>-exporter type is currently not supported on
|
|
this AFS client
|
|
|
|
If the machine is configured as a server of the non-AFS file system but is
|
|
not currently enabled to reexport AFS to it (because the B<-start>
|
|
argument to this command is not set to B<on>), the message is as
|
|
follows:
|
|
|
|
'I<file_system>' translator is disabled
|
|
|
|
If the machine is enabled to reexport AFS, the following message precedes
|
|
messages that report the settings of the other parameters.
|
|
|
|
'I<file_system>' translator is enabled with the following options:
|
|
|
|
The following messages indicate that the -convert argument is
|
|
set to B<on> or B<off> respectively:
|
|
|
|
Running in convert owner mode bits to world/other mode
|
|
Running in strict unix mode
|
|
|
|
The following messages indicate that the -uidcheck argument is
|
|
set to B<on> or B<off> respectively:
|
|
|
|
Running in strict 'passwd sync' mode
|
|
Running in no 'passwd sync' mode
|
|
|
|
The following messages indicate that the -submounts argument is
|
|
set to B<on> or B<off> respectively:
|
|
|
|
Allow mounts of /afs/.. subdirs
|
|
Only mounts to /afs allowed
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following example shows that the local machine can export AFS to NFS
|
|
client machines.
|
|
|
|
% fs exportafs nfs
|
|
'nfs' translator is enabled with the following options:
|
|
Running in convert owner mode bits to world/other mode
|
|
Running in no 'passwd sync' mode
|
|
Only mounts to /afs allowed
|
|
|
|
The following example enables the machine as an NFS server and converts the
|
|
UNIX B<group> and B<other> mode bits on exported AFS
|
|
directories and files to match the UNIX B<owner> mode bits.
|
|
|
|
% fs exportafs -type nfs -start on -convert on
|
|
|
|
The following example disables the machine from reexporting AFS to NFS
|
|
client machines:
|
|
|
|
% fs exportafs -type nfs -start off
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be logged in as the local superuser root.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<klog(1)>,
|
|
L<knfs(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|