aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>1997-10-06 21:05:49 +0000
committerH. Peter Anvin <hpa@zytor.com>1997-10-06 21:05:49 +0000
commitbddd43e289c8b8b62d7cb3f1f7eb27ca67cae28e (patch)
treeaac5e4a4b924cb13a54cc0760e99f349ea36bd12 /man
downloadautofs3-bddd43e289c8b8b62d7cb3f1f7eb27ca67cae28e.tar.gz
autofs3-bddd43e289c8b8b62d7cb3f1f7eb27ca67cae28e.tar.xz
autofs3-bddd43e289c8b8b62d7cb3f1f7eb27ca67cae28e.zip
Initial revision
Diffstat (limited to 'man')
-rw-r--r--man/Makefile10
-rw-r--r--man/auto.master.567
-rw-r--r--man/autofs.5136
-rw-r--r--man/autofs.863
-rw-r--r--man/automount.891
5 files changed, 367 insertions, 0 deletions
diff --git a/man/Makefile b/man/Makefile
new file mode 100644
index 0000000..ba92087
--- /dev/null
+++ b/man/Makefile
@@ -0,0 +1,10 @@
+include ../Makefile.rules
+
+install:
+ install -c *.5 -m 644 $(mandir)/man5
+ install -c *.8 -m 644 $(mandir)/man8
+
+all:
+
+clean:
+
diff --git a/man/auto.master.5 b/man/auto.master.5
new file mode 100644
index 0000000..867bb6f
--- /dev/null
+++ b/man/auto.master.5
@@ -0,0 +1,67 @@
+.\" t
+.TH AUTO.MASTER 5 "9 Sep 1997"
+.SH NAME
+/etc/auto.master \- Master Map for automounter
+.SH "DESCRIPTION"
+The
+.B auto.master
+map is consulted when the
+.BR autofs (8)
+script is invoked to set up the necessary mount points for the automounter.
+Each line in this file describes a mount point and points to another file
+describing the file systems to be mounted under this mountpoint. The access
+to those maps is governed by a key.
+.P
+Access to an automounted file system is customarily done using the path scheme:
+.P
+.RI / mountpoint / key / path / file ,
+.P
+where the
+.I mountpoint
+will be listed in the
+.B auto.master
+configuration file. The
+.I key
+is matched in the map file pointed to by the
+master map (See
+.BR autofs (5)).
+The path and the file are referring to the file on the file system mounted.
+.SH "FORMAT"
+The file has three fields separated by an arbitrary number of blanks or
+tabs. Lines beginning with # are comments. The first field is the mount
+point. Second field is the map file to be consulted for this mount-point.
+The third field is optional and can contain options to be applied to all
+entries in the map. Options are cumulative which is a difference to the
+behavior of the SunOS automounter.
+
+The format of the map file and the options are described in
+.BR autofs (5).
+.SH EXAMPLE
+.sp
+.RS +.2i
+.ta 1.0i
+.nf
+/home /etc/auto.home
+/misc /etc/auto.misc
+.fi
+.RE
+.sp
+This will generate two mountpoints
+.I /home
+and
+.IR /misc .
+All accesses to
+.I /home
+will lead to the consultation of the map in
+.IR /etc/auto.home ,
+and all accesses to
+.I /misc
+will consult the map in
+.IR /etc/auto.misc .
+.SH "SEE ALSO"
+.BR automount (8),
+.BR autofs (5),
+.BR autofs (8).
+.SH AUTHOR
+This manual page was written by Christoph Lameter <chris@waterf.org>,
+for the Debian GNU/Linux system. Edited by <hpa@transmeta.com>.
diff --git a/man/autofs.5 b/man/autofs.5
new file mode 100644
index 0000000..fef8f39
--- /dev/null
+++ b/man/autofs.5
@@ -0,0 +1,136 @@
+.\" t
+.TH AUTOFS 5 "29 Sep 1997"
+.SH NAME
+autofs \- Format of the automounter maps
+.SH "DESCRIPTION"
+The automounter maps are files or NIS maps referred to by the master map of
+the automounter (see
+.BR auto.master (5)).
+The automounter maps describe how file systems below the mountpoint of the map
+(given in the auto.master file) are to be mounted.
+
+Maps can be changed on the fly and the automouter will recognize those
+changes on the next operation it performs on that map. This is not
+true for the
+.B auto.master
+map!
+.SH "FORMAT"
+This is a description of the text file format. Other methods of specifying
+these files may exist. All empty lines or lines beginning with # are
+ignored. The basic format of one line in such maps is:
+.P
+.B key [-options] location
+
+.SS key
+is the part of the pathname between the mountpoint and the path into the
+filesystem mounted. Usually you can think about the key as a subdirectory
+name below the mountpoint.
+
+.SS options
+Options are optional. Options can also be given in the
+.B auto.master
+file in which case both values are cumulative (Difference vs. SunOS!).
+The options are a list of comma separated options as customary for the
+.BR mount (8)
+command. There is a special option
+.I -fstype=
+used to specify a filesystem type if the filesystem is not of the default
+NFS type. This option is processed by the automounter and not by the mount
+command.
+
+.SS location
+The location specifies from where the file system is to be mounted. In the
+most cases this will be an NFS volume and the usual notation
+.I host:pathname
+is used to indicate the remote filesystem and path to be mounted. If
+the filesystem to be mounted begins with a / (such as local
+.I /dev
+entries or smbfs shares) a : needs to be prefixed (e.g.
+.IR :/dev/sda1 ).
+.SH EXAMPLE
+.sp
+.RS +.2i
+.ta 1.0i 3.0i
+.nf
+kernel -ro,soft,intr ftp.kernel.org:/pub/linux
+boot -fstype=ext2 :/dev/hda1
+windoze -fstype=smbfs ://windoze/c
+removable -fstype=ext2 :/dev/hdd
+cd -fstype=iso9660,ro :/dev/hdc
+floppy -fstype=auto :/dev/fd0
+.fi
+.RE
+.sp
+In the first line we have a NFS remote mount of the kernel directory on
+.IR ftp.kernel.org .
+This is mounted read-only. The second line mounts an ext2 volume on a
+local ide drive. The third makes a share exported from a Windows
+machine available for automounting. The rest should be fairly
+self-explanatory.
+.SH FEATURES
+.SS Map Key Substitution
+An & character in the
+.B location
+is expanded to the value of the
+.B key
+field that matched the line (which probably only makes sense together with
+a wildchard key).
+.SS Wildcard Key
+A * in the
+.B key
+field matches all keys. An example for the usefulness is the following entry:
+.sp
+.RS +.2i
+.ta 1.0i
+.nf
+* &:/home/&
+.fi
+.RE
+.sp
+This will enable you to access all the home directory of local hosts using
+the path
+.RI / mountpoint / hostname / local-path .
+.SS Variable Substitution
+The following special variables will be substituted in the key and location
+fields of an automounter map if prefixed with $ as customary from shell
+scripts (Curly braces can be used to separate the fieldname):
+.sp
+.RS +.2i
+.ta 1.5i
+.nf
+ARCH Architecture (uname -m)
+CPU Processor Type
+HOST Hostname (uname -n)
+OSNAME Operating System (uname -s)
+OSREL Release of OS (uname -r)
+OSVERS Version of OS (uname -v)
+.fi
+.RE
+.sp
+Additional entries can be defined with the -Dvariable=Value option to
+.BR automount (8).
+.SS Executable Maps
+A map can be marked as executable. Those will be called as a script with the
+key as an argument. The script needs to return one line of a map or no
+output at all if the key cannot be matched.
+.P
+To do this the
+.BR automount (8)
+daemon has to be started with the program type insted of the file
+type. This is implemented in the initialization script.
+.P
+A executable map can return an errorcode to indicate the failure in addition
+to no output at all. All output sent to stderr is logged into the system
+logs.
+.SH UNSUPPORTED
+The automounter does not support SunOS style replicated Filesystem and
+direct maps.
+.SH "SEE ALSO"
+.BR automount (8),
+.BR auto.master (5),
+.BR autofs(8),
+.BR mount(8).
+.SH AUTHOR
+This manual page was written by Christoph Lameter <chris@waterf.org>,
+for the Debian GNU/Linux system. Edited by H. Peter Anvin
+<hpa@transmeta.com>.
diff --git a/man/autofs.8 b/man/autofs.8
new file mode 100644
index 0000000..d2221ed
--- /dev/null
+++ b/man/autofs.8
@@ -0,0 +1,63 @@
+.TH AUTOFS 8 "9 Sep 1997"
+.SH NAME
+/etc/init.d/autofs \- Control Script for automounter
+.SH SYNOPSIS
+.B /etc/init.d/autofs
+.I start|stop|reload
+.SH "DESCRIPTION"
+.B autofs
+control the operation of the
+.BR automount (8)
+daemons running on the Linux system. Usually
+.B autofs
+is invoked at system boot time with the
+.I start
+parameter and at shutdown time with the
+.I stop
+parameter. The
+.B autofs
+script can also manually be invoked by the system administrator to shut
+down, restart or reload the automounters.
+.P
+.SH "OPERATION"
+.B autofs
+will consult a configuration file
+.I /etc/auto.master
+(see
+.BR auto.master (5))
+to find mount points on the system. For each of those mount points a
+.BR automount (8)
+process is started with the appropriate parameters. You can check the
+active mount points for the automounter with the
+.B /etc/init.d/autofs status
+command. After the
+.I auto.master
+configuration file is processed the
+.B autofs
+script will check for an NIS map with the same name. If such a map exists
+then that map will be processed in the same way as the auto.master map. The
+NIS map will be processed last.
+.P
+.B /etc/init.d/autofs reload
+will check the current auto.master map against running daemons. It will kill
+those daemons whose entries have changed and then start daemons for new or
+changed entries.
+.P
+If a map is modified then the change will become effective immediately. If
+the
+.I auto.master
+map is modified then the
+.B autofs
+script must be rerun to activate the changes.
+.P
+.B /etc/init.d/autofs status
+will display the current configuration and a list of currently running
+automount daemons.
+.SH "SEE ALSO"
+.BR automount (8),
+.BR autofs (5),
+.BR auto.master (5).
+.SH AUTHOR
+This manual page was written by Christoph Lameter <chris@waterf.org>,
+for the Debian GNU/Linux system. Edited by H. Peter Anvin
+<hpa@transmeta.com>.
diff --git a/man/automount.8 b/man/automount.8
new file mode 100644
index 0000000..3fa0544
--- /dev/null
+++ b/man/automount.8
@@ -0,0 +1,91 @@
+.\" Linux man page by B. James Phillippe, 1997 <bryan@Terran.ORG>
+.\"
+.\" This page was written to contribute to the Linux kernel autofs
+.\" implementation by H. Peter Anvin (1997). It is loosly based on
+.\" the documentation for mount(8) and amd(8) Linux manpages.
+.\"
+.\" This is free documentation.
+.\"
+.TH AUTOMOUNT 8 "17 Sep 1997"
+.SH NAME
+automount \- configure mount points for autofs
+.SH SYNOPSIS
+\fBautomount\fP [\fIoptions\fP] \fImount-point\fP \fImap-type\fP[,\fIformat\fP] \fImap\fP [\fImap-options\fP]
+.SH DESCRIPTION
+The \fBautomount\fP program is used to configure a mount point for
+autofs, the inlined Linux automounter. \fBautomount\fP works by
+taking a base \fImount-point\fP and \fImap\fP file, and using these
+(combined with other \fIoptions\fP) to automatically mount filesystems
+within the base \fImount-point\fP when they are accessed in any way.
+The filesystems are then autounmounted after a period of inactivity.
+.SH OPTIONS
+.TP
+.I "\-p, \-\-pid-file"
+Write the pid of the daemon to the specified file.
+.TP
+.I "\-t, \-\-timeout"
+Set the minimum timeout, in seconds, until directories are unmounted.
+The default is 5 minutes. Setting the timeout to zero disables
+unmounts completely.
+.TP
+.I "\-v, \-\-version"
+Display the version number, then exit.
+.SH ARGUMENTS
+\fBautomount\fP takes at least three arguments. Mandatory arguments
+include \fImount-point\fP, \fImap-type\fP and \fImap\fP. Both mandatory
+and optional arguments are described below.
+.TP
+\fBmount-point\fP
+Base location for autofs-mounted filesystems to be attached. This is a
+directory name which must already exist.
+.TP
+\fBmap-type\fP
+Type of map used for this invocation of \fBautomount\fP. The following are
+valid map types:
+.RS
+.TP
+.B file
+The map is a regular text file.
+.TP
+.B program
+The map is an executable program, which is passed a key on the command
+line and returns an entry on stdout if successful.
+.TP
+.B yp
+The map is an NIS (YP) database.
+.RE
+.TP
+\fBformat\fP
+Format of the map data; currently the only format
+recognized is \fBsun\fP, which is a subset of the Sun automounter map
+format. The default format is technically map type dependent,
+although currently all map types default to \fBsun\fP format.
+.TP
+\fBmap\fP
+Location of mapfile to use. This is an absolute UNIX pathname in the case
+for maps of types \fBfile\fP and \fBprogram\fP, and the name of an NIS
+database in the case for maps of type \fByp\fP.
+.TP
+\fBoptions\fP
+Any remaining command line arguments without leading dashes (\-) are
+taken as options (\fI\-o\fP) to \fBmount\fP. Arguments with leading
+dashes are considered options for the maps.
+.SH NOTES
+If the \fBautomount\fP daemon catches signal USR1, it will unmount all
+currently unused autofs-mounted filesystems and continue running
+(forced unmount.) If it catches signal USR2 it will unmount all
+unused autofs-mounted filesystems and exit if all filesystems were
+unmounted. Busy filesystems will not be unmounted.
+.SH "SEE ALSO"
+.BR autofs (5),
+.BR mount (8).
+.SH BUGS
+A whole slew of missing desirable features (see \fBTODO\fP file).
+
+The documentation leaves a lot to be desired.
+
+Please report other bugs along with a detailed description to
+<autofs@linux.kernel.org>. To join this mailing list, send a message
+with the line "subscribe autofs" to <majordomo@linux.kernel.org>.
+.SH AUTHOR
+H. Peter Anvin <hpa@transmeta.com>