contrib/amd/fsinfo/fsinfo.8

   1 .\"
   2 .\" Copyright (c) 1997-2006 Erez Zadok
   3 .\" Copyright (c) 1993 Jan-Simon Pendry.
   4 .\" Copyright (c) 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgment:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     from: @(#)fsinfo.8      8.1 (Berkeley) 6/28/93
  36 .\"     $Id: fsinfo.8,v 1.13.2.1 2006/01/02 18:48:25 ezk Exp $
  37 .\"     $FreeBSD$
  38 .\"
  39 .Dd February 26, 2016
  40 .Dt FSINFO 8
  41 .Os
  42 .Sh NAME
  43 .Nm fsinfo
  44 .Nd co-ordinate site-wide file system information
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Op Fl qv
  48 .Op Fl a Ar autodir
  49 .Op Fl b Ar bootparams_prefix
  50 .Op Fl d Ar dumpsets_prefix
  51 .Op Fl e Ar exports_prefix
  52 .Op Fl f Ar fstabs_prefix
  53 .Op Fl h Ar hostname
  54 .Op Fl m Ar automounts_prefix
  55 .Op Fl I Ar dir
  56 .Oo
  57 .Fl D
  58 .Ar name Ns Op = Ns Ar string
  59 .Oc
  60 .Op Fl U Ar name
  61 .Ar config ...
  62 .Sh DESCRIPTION
  63 .Bf -symbolic
  64 This command is obsolete.
  65 Users are advised to use
  66 .Xr autofs 5
  67 instead.
  68 .Ef
  69 .Pp
  70 The
  71 .Nm
  72 utility takes a set of system configuration information, and generates
  73 a coordinated set of
  74 .Xr amd 8 ,
  75 .Xr mount 8
  76 and
  77 .Xr mountd 8
  78 configuration files.
  79 .Pp
  80 The following options are available:
  81 .Bl -tag -width Fl
  82 .It Fl a Ar autodir
  83 Specifies the directory name in which to place the automounter's
  84 mount points.
  85 This defaults to
  86 .Pa /a .
  87 .It Fl b Ar bootparams_prefix
  88 Specifies the prefix for the
  89 .Pa bootparams
  90 file.
  91 If it is not given, then the file will not be generated.
  92 The file will be constructed for the destination machine and will be
  93 placed into a file named
  94 .Pa bootparams
  95 and prefixed by the
  96 .Ar bootparams_prefix
  97 string.
  98 The file generated contains a list of entries describing each
  99 diskless client that can boot from the destination machine.
 100 .It Fl d Ar dumpsets_prefix
 101 Specifies the prefix for the
 102 .Pa dumpsets
 103 file.
 104 If it is not specified, then the file will not be generated.
 105 The file will be for the destination machine and will be placed into a file
 106 named
 107 .Pa dumpsets
 108 prefixed by the
 109 .Ar dumpsets_prefix
 110 string.
 111 This file is for use by
 112 .Tn Imperial College's
 113 local backup system.
 114 .It Fl e Ar exports_prefix
 115 Defines the prefix for the
 116 .Pa exports
 117 files.
 118 If it is not given, then the file will not be generated.
 119 For each machine defined in the configuration files as having disks,
 120 and
 121 .Pa exports
 122 file is constructed and given a file name determined by the name of the
 123 machine, prefixed with the
 124 .Ar exports_prefix
 125 string.
 126 If a machine is defined as diskless, then no
 127 file will be created for it.
 128 The files contain entries
 129 for directories on the machine that may be exported to clients.
 130 .It Fl f Ar fstabs_prefix
 131 This defines the prefix for the
 132 .Pa fstab
 133 files.
 134 The files will only be created if this prefix is defined.
 135 For each machine defined in the configuration files, a
 136 .Pa fstab
 137 file is created with the file name determined by prefixing this
 138 .Ar fstabs_prefix
 139 string with the name of the machine.
 140 These files contain entries
 141 for file systems and partitions to mount at boot time.
 142 .It Fl h Ar hostname
 143 Defines the hostname of the destination machine to process for.
 144 If this is not specified, it defaults to the local machine name,
 145 as returned by
 146 .Xr gethostname 3 .
 147 .It Fl m Ar automounts_prefix
 148 Defines the prefix for the automounter files.
 149 The maps will
 150 only be produced if this option is specified.
 151 The mount maps
 152 suitable for the network defined by the configuration files will
 153 be placed into files with names calculated by prefixing the
 154 .Ar automounts_prefix
 155 string to the name of each map.
 156 .It Fl q
 157 Selects quite mode.
 158 Only error messages that are generated will
 159 be displayed.
 160 .It Fl v
 161 Selects verbose mode.
 162 When this is activated, more messages
 163 will be displayed, and all information discovered when performing the semantic
 164 analysis phase will be displayed.
 165 Each verbose message
 166 is output to the standard output on a line starting with a `#'
 167 character.
 168 .It Fl D Xo
 169 .Ar name Ns Op = Ns Ar string
 170 .Xc
 171 Defines a symbol
 172 .Ar name
 173 for the preprocessor when reading the configuration files.
 174 Equivalent to the
 175 .Em #define
 176 directive.
 177 .It Fl I Ar dir
 178 This option is passed into the preprocessor for the configuration
 179 files.
 180 It specifies directories in which to find include files.
 181 .It Fl U Ar name
 182 Removes and initial definition of the symbol
 183 .Ar name .
 184 Inverse of the
 185 .Fl D
 186 option.
 187 .It Ar config
 188 One or more configuration files to be passed as input to
 189 .Nm .
 190 .El
 191 .Pp
 192 The
 193 .Nm
 194 command is fully described in the document
 195 .%T "Amd - The 4.4BSD Automounter" .
 196 .Sh SEE ALSO
 197 .Xr amd 8 ,
 198 .Xr mount 8 ,
 199 .Xr mountd 8
 200 .Pp
 201 .Dq am-utils
 202 .Xr info 1
 203 entry.
 204 .Rs
 205 .%A Erez Zadok
 206 .%B "Linux NFS and Automounter Administration"
 207 .%O ISBN 0-7821-2739-8
 208 .%I Sybex
 209 .%D 2001
 210 .Re
 211 .Pp
 212 .Pa http://www.am-utils.org/
 213 .Rs
 214 .%T Amd \- The 4.4 BSD Automounter
 215 .Re
 216 .Sh HISTORY
 217 The
 218 .Nm
 219 command first appeared in
 220 .Bx 4.4 .
 221 .Sh AUTHORS
 222 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
 223 Department of Computing, Imperial College, London, UK.
 224 .Pp
 225 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
 226 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
 227 .Pp
 228 Other authors and contributors to am-utils are listed in the
 229 .Pa AUTHORS
 230 file distributed with am-utils.