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 January 2, 2006
  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 The
  64 .Nm
  65 utility takes a set of system configuration information, and generates
  66 a coordinated set of
  67 .Xr amd 8 ,
  68 .Xr mount 8
  69 and
  70 .Xr mountd 8
  71 configuration files.
  72 .Pp
  73 The following options are available:
  74 .Bl -tag -width Fl
  75 .It Fl a Ar autodir
  76 Specifies the directory name in which to place the automounter's
  77 mount points.
  78 This defaults to
  79 .Pa /a .
  80 .It Fl b Ar bootparams_prefix
  81 Specifies the prefix for the
  82 .Pa bootparams
  83 file.
  84 If it is not given, then the file will not be generated.
  85 The file will be constructed for the destination machine and will be
  86 placed into a file named
  87 .Pa bootparams
  88 and prefixed by the
  89 .Ar bootparams_prefix
  90 string.
  91 The file generated contains a list of entries describing each
  92 diskless client that can boot from the destination machine.
  93 .It Fl d Ar dumpsets_prefix
  94 Specifies the prefix for the
  95 .Pa dumpsets
  96 file.
  97 If it is not specified, then the file will not be generated.
  98 The file will be for the destination machine and will be placed into a file
  99 named
 100 .Pa dumpsets
 101 prefixed by the
 102 .Ar dumpsets_prefix
 103 string.
 104 This file is for use by
 105 .Tn Imperial College's
 106 local backup system.
 107 .It Fl e Ar exports_prefix
 108 Defines the prefix for the
 109 .Pa exports
 110 files.
 111 If it is not given, then the file will not be generated.
 112 For each machine defined in the configuration files as having disks,
 113 and
 114 .Pa exports
 115 file is constructed and given a file name determined by the name of the
 116 machine, prefixed with the
 117 .Ar exports_prefix
 118 string.
 119 If a machine is defined as diskless, then no
 120 file will be created for it.
 121 The files contain entries
 122 for directories on the machine that may be exported to clients.
 123 .It Fl f Ar fstabs_prefix
 124 This defines the prefix for the
 125 .Pa fstab
 126 files.
 127 The files will only be created if this prefix is defined.
 128 For each machine defined in the configuration files, a
 129 .Pa fstab
 130 file is created with the file name determined by prefixing this
 131 .Ar fstabs_prefix
 132 string with the name of the machine.
 133 These files contain entries
 134 for file systems and partitions to mount at boot time.
 135 .It Fl h Ar hostname
 136 Defines the hostname of the destination machine to process for.
 137 If this is not specified, it defaults to the local machine name,
 138 as returned by
 139 .Xr gethostname 3 .
 140 .It Fl m Ar automounts_prefix
 141 Defines the prefix for the automounter files.
 142 The maps will
 143 only be produced if this option is specified.
 144 The mount maps
 145 suitable for the network defined by the configuration files will
 146 be placed into files with names calculated by prefixing the
 147 .Ar automounts_prefix
 148 string to the name of each map.
 149 .It Fl q
 150 Selects quite mode.
 151 Only error messages that are generated will
 152 be displayed.
 153 .It Fl v
 154 Selects verbose mode.
 155 When this is activated, more messages
 156 will be displayed, and all information discovered when performing the semantic
 157 analysis phase will be displayed.
 158 Each verbose message
 159 is output to the standard output on a line starting with a `#'
 160 character.
 161 .It Fl D Xo
 162 .Ar name Ns Op = Ns Ar string
 163 .Xc
 164 Defines a symbol
 165 .Ar name
 166 for the preprocessor when reading the configuration files.
 167 Equivalent to the
 168 .Em #define
 169 directive.
 170 .It Fl I Ar dir
 171 This option is passed into the preprocessor for the configuration
 172 files.
 173 It specifies directories in which to find include files.
 174 .It Fl U Ar name
 175 Removes and initial definition of the symbol
 176 .Ar name .
 177 Inverse of the
 178 .Fl D
 179 option.
 180 .It Ar config
 181 One or more configuration files to be passed as input to
 182 .Nm .
 183 .El
 184 .Pp
 185 The
 186 .Nm
 187 command is fully described in the document
 188 .%T "Amd - The 4.4BSD Automounter" .
 189 .Sh SEE ALSO
 190 .Xr amd 8 ,
 191 .Xr mount 8 ,
 192 .Xr mountd 8
 193 .Pp
 194 .Dq am-utils
 195 .Xr info 1
 196 entry.
 197 .Rs
 198 .%A Erez Zadok
 199 .%B "Linux NFS and Automounter Administration"
 200 .%O ISBN 0-7821-2739-8
 201 .%I Sybex
 202 .%D 2001
 203 .Re
 204 .Pp
 205 .Pa http://www.am-utils.org/
 206 .Rs
 207 .%T Amd \- The 4.4 BSD Automounter
 208 .Re
 209 .Sh HISTORY
 210 The
 211 .Nm
 212 command first appeared in
 213 .Bx 4.4 .
 214 .Sh AUTHORS
 215 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
 216 Department of Computing, Imperial College, London, UK.
 217 .Pp
 218 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
 219 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
 220 .Pp
 221 Other authors and contributors to am-utils are listed in the
 222 .Pa AUTHORS
 223 file distributed with am-utils.