.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "AutomountFile 3pm"
.TH AutomountFile 3pm "2021-08-21" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Unix::AutomountFile \- Perl interface to automounter files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Unix::AutomountFile;
\&
\&  $am = new Unix::AutomountFile "/etc/auto_home";
\&  $am\->automount("newuser", "fileserver:/export/home/&");
\&  $am\->options("newuser", "\-rw,nosuid");
\&  $am\->delete("olduser");
\&  $am\->commit();
\&  undef $am;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Unix::AutomountFile module provides an abstract interface to automounter
files.  It automatically handles file locking, getting colons and commas in
the right places, and all the other niggling details.  \s-1WARNING:\s0 This module is
probably Solaris specific at this point.  I have only looked at Solaris format
automount files thus far.  Also, you cannot edit /etc/auto_master with this
module, since it is in a different format than the other automount files.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "add_server( \s-1MOUNT,\s0 @SERVERS )"
.el .SS "add_server( \s-1MOUNT,\s0 \f(CW@SERVERS\fP )"
.IX Subsection "add_server( MOUNT, @SERVERS )"
This method will add additional servers to an existing automount point.  It
returns 1 on success and 0 on failure.
.SS "automount( \s-1MOUNT\s0 [,@SERVERS] )"
.IX Subsection "automount( MOUNT [,@SERVERS] )"
This method can add, modify, or return information about a mount point.
Supplied with a single mount parameter, it will return a list of the server
entries for that mount point, or undef if no such mount exists.  If you supply
more than one parameter, the mount point will be created or modified if it
already exists.  The list is also returned to you in this case.
.SS "automounts( )"
.IX Subsection "automounts( )"
This method returns a list of all existing mount points, sorted
alphabetically.  In scalar context, this method returns the total number of
mount points.
.SS "commit( [\s-1BACKUPEXT\s0] )"
.IX Subsection "commit( [BACKUPEXT] )"
See the Unix::ConfigFile documentation for a description of this method.
.SS "delete( \s-1MOUNT\s0 )"
.IX Subsection "delete( MOUNT )"
This method will delete the named mount point.  It has no effect if the
supplied mount point does not exist.
.SS "new( \s-1FILENAME\s0 [,OPTIONS] )"
.IX Subsection "new( FILENAME [,OPTIONS] )"
See the Unix::ConfigFile documentation for a description of this method.
.SS "options( \s-1MOUNT\s0 [,OPTIONS] )"
.IX Subsection "options( MOUNT [,OPTIONS] )"
Read or modify the mount options associated with a mount point.  Returns the
options in either case.
.SS "rename( \s-1OLDNAME, NEWNAME\s0 )"
.IX Subsection "rename( OLDNAME, NEWNAME )"
Renames a mount point.  If \s-1NEWNAME\s0 corresponds to an existing mount point,
that mount point is overwritten.  Returns 0 on failure and 1 on success.
.SH "AUTHOR"
.IX Header "AUTHOR"
Steve Snodgrass, ssnodgra@fore.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Unix::AliasFile, Unix::ConfigFile, Unix::GroupFile, Unix::PasswdFile