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