source: trunk/athena/bin/attach/attach.1 @ 20644

Revision 20644, 8.0 KB checked in by ghudson, 20 years ago (diff)
Add an example for attaching the read-write path to a locker which is a replicated AFS volume. Note that the -r and -w options do not work for AFS filesystems, and remove the example which tries to use them on AFS lockers.
1.\" $Id: attach.1,v 1.16 2004-08-11 15:20:17 ghudson Exp $
3.\" Copyright 1997 by the Massachusetts Institute of Technology.
5.\" Permission to use, copy, modify, and distribute this
6.\" software and its documentation for any purpose and without
7.\" fee is hereby granted, provided that the above copyright
8.\" notice appear in all copies and that both that copyright
9.\" notice and this permission notice appear in supporting
10.\" documentation, and that the name of M.I.T. not be used in
11.\" advertising or publicity pertaining to distribution of the
12.\" software without specific, written prior permission.
13.\" M.I.T. makes no representations about the suitability of
14.\" this software for any purpose.  It is provided "as is"
15.\" without express or implied warranty.
19attach \- attach a remote file system to your workstation
21.TP 8
23[-v | -q] [-y | -n] [-g | -a] [-z | -h] [-x | -e] [-N | -S]
24[-w | -r] [-p] [-L] [-O] [-o mountoptions] [-t type] [-m mountpoint] locker ...
27attach -l \fIfilesystem\fP
28attach [-H \fIhost\fP]
31.I attach
32is a filesystem-independent utility which allows you attach a
33filesystem to a directory hierarchy on your workstation. The following
34filesystems are currently supported: AFS, NFS, and UFS.
36Attach looks up \fIfilesystem\fP in
37.BR attach.conf (5)
38or by using
39.BR Hesiod (3)
40to retrieve the file system type, the server host, the name by which
41the file system is known to the server (e.g., an NFS server
42mountpoint), and the default mount point and mode (read-only,
43read-write). The user may also explicitly specify this information, as
44described below under the
45.I --explicit
48By default,
49.I attach
50will attempt to make sure the user is authenticated to the remote
51filesystem, by getting tokens in the appropriate cell for an AFS
52locker, or creating a Kerberos NFS mapping for an NFS locker.
54The following arguments to \fIattach\fP modify its behavior. Default
55options are marked as such. Unless otherwise marked, all arguments are
56processed \fIin order\fP. Thus, if a -v option is followed by a -q
57option, the -q option will take precedence (for any lockers that
58appear after the -q on the command line). The long and short forms of
59each option function identically.
61If no arguments are given to \fIattach\fP, a list of the currently
62attached filesystems will be printed.
64.TP 8
65.I --verbose (-v)
66Display verbose information about a mounted filesystem, such as the
67AFS path or NFS server and the server's filesystem name, if the attach
68is successful. This is the default. Use of this option automatically
69supresses the --printpath option.
70.TP 8
71.I --quiet (-q)
72Don't display verbose information.  Error messages will still be printed.
73.TP 8
74.I --printpath (-p)
75\fIattach\fP normally prints a status message on its standard output
76indicating the success or failure of the attach operation. This flag
77causes the pathname of the mounted filesystem to be printed instead.
78This was used by the old "add" aliases. Use of this option
79automatically surpresses the -verbose option.
80.TP 8
81.I --lookup (-l)
82This option causes \fIattach\fP to look up the filesystem definition
83using either
84.BR attach.conf (5)
86.BR Hesiod (3)
87and print out the definition, but not to actually attach the filesystem.
88.TP 8
89.I --map (-y)
90Attempt to authenticate the user with Kerberos to the filesystem
91server.  The authentication may be necessary in order to have the
92proper access to the filesystem.  This is the default.
93.TP 8
94.I --nomap (-n)
95Do not attempt to authenticate the user to the filesystem server.
96This implicitly invokes the -noremap option.
97.TP 8
98.I --remap (-g)
99Go ahead and reauthenticate the user even if the filesystem is already
100attached.  This is the default.
101.TP 8
102.I --noremap (-a)
103Don't reauthenticate the user if the filesystem is already attached.
104.TP 8
105.I --zephyr (-z)
106Subscribe to
107.BR Zephyr (1)
108messages about the server host.  This is the default.
109.TP 8
110.I --nozephyr (-h)
111Don't subscribe to
112.BR Zephyr (1)
113messages about the server host.
114.TP 8
115.I --readonly (-r), --write (-w)
116Overrides the default access mode for the next filesystem.  "-r"
117indicates read-only access, and "-w" indicates write access.  These
118options have no effect for AFS filesystems.
119.TP 8
120.I --mountpoint \fImount-point\fP (-m \fImount-point\fP)
121Overrides the default mount point for the next filesystem.
122.TP 8
123.I --master (-M)
124Attach the master copy of the locker even if a local copy of the
125locker exists.  Without this option, if a symlink exists in
126.B /var/athena/local-validated
127(or the value of local-dir in
128.BR attach.conf (5)
129if set) with the name of the locker, that symlink is copied to the
130mountpoint in place of attaching the locker.
131.TP 8
132.I --noexplicit (-x)
133Tell \fIattach\fP to interpret the \fIfilesystem\fP as a Hesiod name.
134This is the default.
135.TP 8
136.I --explicit (-e)
137Change the behavior of \fIattach\fP such that the \fIfilesystem\fP is
138now interpreted as an explicit description (\fIdirectory\fP in the
139case of AFS or \fIhost:directory\fP in the case of NFS) instead of as
140a Hesiod name. This allows arbitrary directories to be attached. When
141this option is used, the default mount point is determined by
142filesystem-specific code, but can be overridden by the -m option.
143.TP 8
144.I --type \fIfilesystem-type\fP (-t \fIfilesystem-type\fP)
145Used with the
146.I --explicit
147option to tell \fIattach\fP the type of the filesystem that's going to
148be attached. It defaults to NFS.
149.TP 8
150.I --mountoptions \fIoptions\fP (-o \fIoptions\fP)
151Specify options for the mounting of the filesystem.  The options are
152the same as the ones used by
153.BR mount (8)\fP.
154.TP 8
155.I --nosetuid \fPor\fI -nosuid (-N)
156With this option, \fIattach\fP will mount the filesystem with the
157nosuid option.  This causes the kernel not to honor setuid or setgid
158permission in the filesystem.  (This option does not have any
159effect with AFS filesystems.)
160.TP 8
161.I --setuid -suid (-S)
162This option can be used by a trusted user to forcibly mount a
163filesystem without the nosuid option.  This can be used to override
164the fact that the system administrator has made an entry such that the
165filesystem would normally be mounted nosuid.
166.TP 8
167.I --override (-O)
168\fIAttach\fP can be set up so that normal users cannot attach certain
169filsystems.  A trusted user can use this option to override these
170restrictions.  See
171.BR attach.conf (5)
172for more information.
173.TP 8
174.I --lock (-L)
175This option tells \fIattach\fP to lock the filesystem so that it cannot
176be unmounted except explicitly by one of the trusted users.  This
177command requires the user to be in the trusted users list.
178.TP 8
179.I --host \fIhostnames\fP (-H \fIhostnames\fP)
180This option causes \fIattach\fP to list all filesystems that are mounted
181from the given \fIhostnames\fP.  After this option appears on the
182command line, no more filesystems may be attached; only hostnames may be
185If the default mount-point for a filesystem (or the mount-point
186specified with the -m option) does not exist, it is created.  Any
187directories in the path that do not exist are also created.  If a
188directory can't be created, the attach fails.  When the filesystem is
189detached, any directories that were created during the attach are
190deleted, if possible.
194attach -t afs -m /mit/gnu -e /afs/
197Attach the read-write AFS path to the gnu locker to the mountpoint
201If \fIattach\fP is unable to initalize the locker library, it will
202exist with status 1. If \fIattach\fP encounters a problem attaching a
203locker, it will continue trying to attach any remaining lockers on the
204command line, but eventually exit with status 2.
214add(1), detach(1), nfsid(1), zinit(1), attach.conf(5)
217Dan Winship, MIT Information Systems
219based on the original attach by
221Robert French, Project Athena
223Theodore Ts'o, Project Athena
225John Carr, Project Athena
227Richard Basch, Project Athena
229Copyright 1988, 1990, 1998 Massachusetts Institute of Technology
Note: See TracBrowser for help on using the repository browser.