contrib/amd/fsinfo/fsinfo.8

   1 .\"
   2 .\" Copyright (c) 1997-1999 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.2 1999/01/10 21:54:28 ezk Exp $
  37 .\"     $FreeBSD: src/contrib/amd/fsinfo/fsinfo.8,v 1.4.2.2 2001/03/06 16:54:05 ru Exp $
  38 .\"
  39 .Dd June 26, 1999
  40 .Dt FSINFO 8
  41 .Os
  42 .Sh NAME
  43 .Nm fsinfo
  44 .Nd co-ordinate site-wide filesystem 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 co-ordinated set of
  67 .Xr amd ,
  68 .Xr mount
  69 and
  70 .Xr mountd
  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.  This defaults to
  78 .Pa /a .
  79 .It Fl b Ar bootparams_prefix
  80 Specifies the prefix for the
  81 .Pa bootparams
  82 file.  If it is not given, then the file will not be generated.
  83 The file will be constructed for the destination machine and will be
  84 placed into a file named
  85 .Pa bootparams
  86 and prefixed by the
  87 .Ar bootparams_prefix
  88 string.
  89 The file generated contains a list of entries describing each
  90 diskless client that can boot from the destination machine.
  91 .It Fl d Ar dumpsets_prefix
  92 Specifies the prefix for the
  93 .Pa dumpsets
  94 file.  If it is not specified, then the file will not be generated.
  95 The file will be for the destination machine and will be placed into a file
  96 named
  97 .Pa dumpsets
  98 prefixed by the
  99 .Ar dumpsets_prefix
 100 string.
 101 This file is for use by
 102 .Tn Imperial College's
 103 local backup system.
 104 .It Fl e Ar exports_prefix
 105 Defines the prefix for the
 106 .Pa exports
 107 files.  If it is not given, then the file will not be generated.
 108 For each machine defined in the configuration files as having disks,
 109 and
 110 .Pa exports
 111 file is constructed and given a file name determined by the name of the
 112 machine, prefixed with the
 113 .Ar exports_prefix
 114 string.
 115 If a machine is defined as diskless, then no
 116 file will be created for it.  The files contain entries
 117 for directories on the machine that may be exported to clients.
 118 .It Fl f Ar fstabs_prefix
 119 This defines the prefix for the
 120 .Pa fstab
 121 files.  The files will only be created if this prefix is defined.
 122 For each machine defined in the configuration files, a
 123 .Pa fstab
 124 file is created with the file name determined by prefixing this
 125 .Ar fstabs_prefix
 126 string with the name of the machine.  These files contain entries
 127 for filesystems and partitions to mount at boot time.
 128 .It Fl h Ar hostname
 129 Defines the hostname of the destination machine to process for.
 130 If this is not specified, it defaults to the local machine name,
 131 as returned by
 132 .Xr gethostname 3 .
 133 .It Fl m Ar automounts_prefix
 134 Defines the prefix for the automounter files.  The maps will
 135 only be produced if this option is specified.  The mount maps
 136 suitable for the network defined by the configuration files will
 137 be placed into files with names calculated by prefixing the
 138 .Ar automounts_prefix
 139 string to the name of each map.
 140 .It Fl q
 141 Selects quite mode.  Only error messages that are generated will
 142 be displayed.
 143 .It Fl v
 144 Selects verbose mode.  When this is activated, more messages
 145 will be displayed, and all information discovered when performing the semantic
 146 analysis phase will be displayed.  Each verbose message
 147 is output to the standard output on a line starting with a `#'
 148 character.
 149 .It Fl D Xo
 150 .Ar name Ns Op = Ns Ar string
 151 .Xc
 152 Defines a symbol
 153 .Ar name
 154 for the preprocessor when reading the configuration files.
 155 Equivalent to the
 156 .Em #define
 157 directive.
 158 .It Fl I Ar dir
 159 This option is passed into the preprocessor for the configuration
 160 files.  It specifies directories in which to find include files.
 161 .It Fl U Ar name
 162 Removes and initial definition of the symbol
 163 .Ar name .
 164 Inverse of the
 165 .Fl D
 166 option.
 167 .It Ar config
 168 One or more configuration files to be passed as input to
 169 .Nm fsinfo .
 170 .El
 171 .Pp
 172 The
 173 .Nm
 174 command is fully described in the document
 175 .%T "Amd - The 4.4BSD Automounter"
 176 and in the
 177 .Nm amd
 178 section in
 179 .Xr info 1 .
 180 .Sh "SEE ALSO"
 181 .Xr amd 8 ,
 182 .Xr mount 8 ,
 183 .Xr mountd 8
 184 .Sh HISTORY
 185 The
 186 .Nm
 187 command first appeared in
 188 .Bx 4.4 .