contrib/amd/fsinfo/fsinfo.8

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