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

Revision 24391, 4.2 KB checked in by jdreed, 14 years ago (diff)
In attach: * Fix the attach man page
Line 
1.\" $Id: attach.1,v 1.16 2004-08-11 15:20:17 ghudson Exp $
2.\"
3.\" Copyright 1997 by the Massachusetts Institute of Technology.
4.\"
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.
16.\"
17.TH ATTACH 1
18.SH NAME
19attach \- attach a remote file system to your workstation
20.SH SYNOPSIS
21.TP 8
22attach
23[-v | -q | -p] [-z | -h] locker ...
24.PP
25.nf
26attach -l \fIfilesystem\fP
27.fi
28.SH DESCRIPTION
29.I attach
30is a filesystem-independent utility which allows you attach a
31filesystem to a directory hierarchy on your workstation. Currently,
32the only supported filesystem type is AFS.
33
34.B NOTE:
35.I attach
36is provided mainly for compatibility with previous versions of Athena.
37With Debathena, \fI/mit\fP is auto-mounted, so you can access any path
38under \fI/mit\fP without explicitly attaching the locker.
39
40Attach looks up the \fIfilesystem\fP in
41.BR Hesiod (3)
42to retrieve the file system type, the server host, the name by which
43the file system is known to the server (e.g., an NFS server
44mountpoint), and the default mount point and mode (read-only,
45read-write).
46
47By default,
48.I attach
49will attempt to make sure the user is authenticated to the remote
50filesystem, by getting tokens in the appropriate cell for an AFS
51locker.
52
53The following arguments to \fIattach\fP modify its behavior. Default
54options are marked as such. Unless otherwise marked, all arguments are
55processed \fIin order\fP. Thus, if a -v option is followed by a -q
56option, the -q option will take precedence (for any lockers that
57appear after the -q on the command line). The long and short forms of
58each option function identically.
59
60If no arguments are given to \fIattach\fP, a list of the currently
61attached filesystems will be printed.
62
63.TP 8
64.I --verbose (-v)
65Display verbose information about a mounted filesystem, such as the
66AFS path or NFS server and the server's filesystem name, if the attach
67is successful. This is the default. Use of this option automatically
68supresses the --printpath option.
69.TP 8
70.I --quiet (-q)
71Don't display verbose information.  Error messages will still be printed.
72.TP 8
73.I --printpath (-p)
74\fIattach\fP normally prints a status message on its standard output
75indicating the success or failure of the attach operation. This flag
76causes the pathname of the mounted filesystem to be printed instead.
77This was used by the old "add" aliases. Use of this option
78automatically surpresses the -verbose option.
79.TP 8
80.I --zephyr (-z)
81Subscribe to
82.BR Zephyr (1)
83messages about the server host.  This is the default.
84.TP 8
85.I --nozephyr (-h)
86Don't subscribe to
87.BR Zephyr (1)
88messages about the server host.
89.PP
90If the default mount-point for a filesystem (or the mount-point
91specified with the -m option) does not exist, it is created.  Any
92directories in the path that do not exist are also created.  If a
93directory can't be created, the attach fails.  When the filesystem is
94detached, any directories that were created during the attach are
95deleted, if possible.
96
97.SH DIAGNOSTICS
98If \fIattach\fP is unable to initalize the locker library, it will
99exit with status 1. If \fIattach\fP encounters a problem attaching a
100locker, it will continue trying to attach any remaining lockers on the
101command line, but eventually exit with status 2.
102
103.SH FILES
104/etc/athena/attach.conf
105.br
106/var/athena/attachtab/
107.br
108
109.SH BUGS
110NFS and RVD lockers are no longer supported.
111
112.SH FEATURES
113NFS and RVD lockers are no longer supported.
114
115.SH "SEE ALSO"
116add(1), detach(1)
117
118.SH AUTHORS
119SIPB Debathena Project
120.PP
121Previous versions by:
122.br
123Dan Winship, MIT Information Systems
124.br
125Robert French, Project Athena
126.br
127Theodore Ts'o, Project Athena
128.br
129John Carr, Project Athena
130.br
131Richard Basch, Project Athena
132.PP
133Copyright 1988, 1990, 1998 Massachusetts Institute of Technology
Note: See TracBrowser for help on using the repository browser.