contrib/amd/scripts/amd.conf.5

   1 .\"
   2 .\" Copyright (c) 1997-2006 Erez Zadok
   3 .\" Copyright (c) 1990 Jan-Simon Pendry
   4 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
   5 .\" Copyright (c) 1990 The Regents of the University of California.
   6 .\" All rights reserved.
   7 .\"
   8 .\" This code is derived from software contributed to Berkeley by
   9 .\" Jan-Simon Pendry at Imperial College, London.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. All advertising materials mentioning features or use of this software
  20 .\"    must display the following acknowledgment:
  21 .\"      This product includes software developed by the University of
  22 .\"      California, Berkeley and its contributors.
  23 .\" 4. Neither the name of the University nor the names of its contributors
  24 .\"    may be used to endorse or promote products derived from this software
  25 .\"    without specific prior written permission.
  26 .\"
  27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37 .\" SUCH DAMAGE.
  38 .\"
  39 .\"     %W% (Berkeley) %G%
  40 .\"
  41 .\" $Id: amd.conf.5,v 1.39.2.5 2006/04/21 01:12:04 ezk Exp $
  42 .\" $FreeBSD$
  43 .\"
  44 .Dd February 26, 2016
  45 .Dt AMD.CONF 5
  46 .Os
  47 .Sh NAME
  48 .Nm amd.conf
  49 .Nd
  50 .Xr amd 8
  51 configuration file
  52 .Sh SYNOPSIS
  53 .Nm
  54 .Sh DESCRIPTION
  55 .Bf -symbolic
  56 This configuration file is obsolete.
  57 Users are advised to use
  58 .Xr autofs 5
  59 instead.
  60 .Ef
  61 .Pp
  62 The
  63 .Nm
  64 file is the configuration file for
  65 .Xr amd 8 ,
  66 as part of the am-utils suite.
  67 .Pp
  68 The
  69 .Nm
  70 file
  71 contains runtime configuration information for the
  72 .Xr amd 8
  73 automounter program.
  74 .Sh FILE FORMAT
  75 The file consists of sections and parameters.
  76 A section begins with the
  77 name of the section in square brackets and continues until the next section
  78 begins or the end of the file is reached.
  79 Sections contain parameters of the
  80 form
  81 .Dq Ar name No = Ar value .
  82 .Pp
  83 The file is line-based \[em] that is, each newline-terminated line represents
  84 either a comment, a section name or a parameter.
  85 No line-continuation
  86 syntax is available.
  87 .Pp
  88 Section, parameter names and their values are case sensitive.
  89 .Pp
  90 Only the first equals sign in a parameter is significant.
  91 Whitespace before
  92 or after the first equals sign is discarded.
  93 Leading, trailing and
  94 internal whitespace in section and parameter names is irrelevant.
  95 Leading
  96 and trailing whitespace in a parameter value is discarded.
  97 Internal
  98 whitespace within a parameter value is not allowed, unless the whole
  99 parameter value is quoted with double quotes as in
 100 .Dq Ar name No = Qq Li "some\ value" .
 101 .Pp
 102 Any line beginning with a pound sign (#) is ignored, as are lines containing
 103 only whitespace.
 104 .Pp
 105 The values following the equals sign in parameters are all either a string
 106 (no quotes needed if string does not include spaces) or a boolean, which may
 107 be given as
 108 .Dq Li yes/no .
 109 Case is significant in all values.
 110 Some items such as
 111 cache timeouts are numeric.
 112 .Sh SECTIONS
 113 .Ss "The [global] section"
 114 Parameters in this section either apply to
 115 .Nm amd
 116 as a whole, or to all other
 117 regular map sections which follow.
 118 There should be only one global section
 119 defined in one configuration file.
 120 .Pp
 121 It is highly recommended that this section be specified first in the
 122 configuration file.
 123 If it is not, then regular map sections which precede
 124 it will not use global values defined later.
 125 .Ss "Regular [/map] sections"
 126 Parameters in regular (non-global) sections apply to a single map entry.
 127 For example, if the map section
 128 .Bq Pa /homes
 129 is defined, then all parameters following it will be applied to the
 130 .Pa /homes
 131 .Nm amd Ns
 132 -managed mount point.
 133 .Sh PARAMETERS
 134 .Ss "Parameters common to all sections"
 135 These parameters can be specified either in the global or a map specific
 136 section.
 137 Entries specified in a map-specific section override the default
 138 value or one defined in the global section.
 139 If such a common parameter is
 140 specified only in the global section, it is applicable to all regular map
 141 sections that follow.
 142 .Bl -tag -width 4n
 143 .It Va browsable_dirs Pq string, default=no
 144 If
 145 .Dq Li yes ,
 146 then
 147 .Nm amd Ns 's
 148 top-level mount points will be browsable to
 149 .Xr readdir 3
 150 calls.
 151 This means you could run for example
 152 .Xr ls 1
 153 and see what keys are available to mount in that directory.
 154 Not all entries
 155 are made visible to
 156 .Xr readdir 3 :
 157 the
 158 .Dq Li /default
 159 entry, wildcard entries, and those with a
 160 .Ql /
 161 in them are not included.
 162 If you specify
 163 .Dq Li full
 164 to this option, all but
 165 .Dq Li /default
 166 will be visible.
 167 Note that if you run a command which will attempt to
 168 .Xr stat 2
 169 the entries, such as often done by
 170 .Dq Li "ls -l"
 171 or
 172 .Dq Li "ls -F" ,
 173 .Xr amd 8
 174 will attempt to mount
 175 .Em every
 176 entry in that map.
 177 This is often called a
 178 .Dq "mount storm" .
 179 .It Va map_defaults Pq string, default no empty
 180 This option sets a string to be used as the map's /defaults entry,
 181 overriding any /defaults specified in the map.
 182 This allows local users to
 183 override map defaults without modifying maps globally.
 184 .It Va map_options Pq string, default no options
 185 This option is the same as specifying map options on the command line to
 186 .Xr amd 8 ,
 187 such as
 188 .Dq Li "cache:=all" .
 189 .It Va map_type Pq string, default search all map types
 190 If specified,
 191 .Xr amd 8
 192 will initialize the map only for the type given.
 193 This is
 194 useful to avoid the default map search type used by
 195 .Xr amd 8
 196 which takes longer
 197 and can have undesired side-effects such as initializing
 198 .Tn NIS
 199 even if not
 200 used.
 201 Possible values are:
 202 .Pp
 203 .Bl -tag -width ".Cm nisplus" -compact
 204 .It Cm exec
 205 executable maps
 206 .It Cm file
 207 plain files
 208 .It Cm hesiod
 209 Hesiod name service from MIT
 210 .It Cm ldap
 211 Lightweight Directory Access Protocol
 212 .It Cm ndbm
 213 (New) dbm style hash files
 214 .It Cm nis
 215 Network Information Services (version 2)
 216 .It Cm nisplus
 217 Network Information Services Plus (version 3)
 218 .It Cm passwd
 219 local password files
 220 .It Cm union
 221 union maps
 222 .El
 223 .It Va mount_type Pq string, default=nfs
 224 All
 225 .Xr amd 8
 226 mount types default to
 227 .Tn NFS .
 228 That is,
 229 .Xr amd 8
 230 is an
 231 .Tn NFS
 232 server on the
 233 map mount points, for the local host it is running on.
 234 If
 235 .Dq Li autofs
 236 is specified,
 237 .Xr amd 8
 238 will be an autofs server for those mount points.
 239 .It Va autofs_use_lofs Pq string, default=yes
 240 When set to
 241 .Dq Li yes
 242 and using Autofs,
 243 .Xr amd 8
 244 will use lofs-type (loopback) mounts
 245 for type:=link mounts.
 246 This has the advantage of mounting in place, and
 247 users get to the see the same pathname that they chdir'ed into.
 248 If this
 249 option is set to
 250 .Dq Li no ,
 251 then
 252 .Xr amd 8
 253 will use symlinks instead: that code is more
 254 tested, but negates autofs's big advantage of in-place mounts.
 255 .It Va search_path Pq string, default no search path
 256 This provides a (colon-delimited) search path for file maps.
 257 Using a search
 258 path, sites can allow for local map customizations and overrides, and can
 259 query
 260 distributed maps in several locations as needed.
 261 .It Va selectors_in_defaults Pq boolean, default=no
 262 If
 263 .Dq Li yes ,
 264 then the /defaults entry of maps will search for and process any
 265 selectors before setting defaults for all other keys in that map.
 266 Useful
 267 when you want to set different options for a complete map based on some
 268 parameters.
 269 For example, you may want to better the NFS performance over
 270 slow slip-based networks as follows:
 271 .Bd -literal
 272 /defaults \\
 273         wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
 274         wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
 275 .Ed
 276 Deprecated form: selectors_on_default
 277 .El
 278 .Ss "Parameters applicable to the global section only"
 279 .Bl -tag -width 4n
 280 .It Va arch Pq string, default to compiled in value
 281 Same as the
 282 .Fl A
 283 option to
 284 .Xr amd 8 .
 285 Allows you to override the value of the
 286 .Va arch
 287 .Xr amd 8
 288 variable.
 289 .It Va auto_attrcache Pq numeric, default=0
 290 Specify in seconds (or units of 0.1 seconds, depending on the OS), what is
 291 the (kernel-side) NFS attribute cache timeout for
 292 .Nm amd Ns 's
 293 own automount
 294 points.
 295 A value of 0 is supposed to turn off attribute caching, meaning
 296 that
 297 .Xr amd 8
 298 will be consulted via a kernel-RPC each time someone stat()'s
 299 the mount point (which could be abused as a denial-of-service attack).
 300 Warning: some OSs are incapable of turning off the NFS attribute cache
 301 reliably.
 302 On such systems,
 303 .Nm amd
 304 may not work reliably under heavy load.
 305 See
 306 the
 307 .Pa README.attrcache
 308 document in the Am-utils distribution for more details.
 309 .It Va auto_dir Pq string, default= Ns Pa /a
 310 Same as the
 311 .Fl a
 312 option to
 313 .Xr amd 8 .
 314 This sets the private directory where
 315 .Nm amd
 316 will create
 317 sub-directories for its real mount points.
 318 .It Va cache_duration Pq numeric, default=300
 319 Same as the
 320 .Fl c
 321 option to
 322 .Xr amd 8 .
 323 Sets the duration in seconds that looked-up or mounted map
 324 entries remain in the cache.
 325 .It Va cluster Pq string, default no cluster
 326 Same as the
 327 .Fl C
 328 option to
 329 .Xr amd 8 .
 330 Specifies the alternate
 331 .Tn HP-UX
 332 cluster to use.
 333 .It Va debug_mtab_file Pq string, default= Ns Pa /tmp/mnttab
 334 Path to mtab file that is used by
 335 .Xr amd 8
 336 to store a list of mounted
 337 file systems during debug-mtab mode.
 338 This option only applies
 339 to systems that store mtab information on disk.
 340 .It Va debug_options Pq string, default no debug options
 341 Same as the
 342 .Fl D
 343 option to
 344 .Xr amd 8 .
 345 Specify any debugging options for
 346 .Xr amd 8 .
 347 Works only if
 348 am-utils was configured for debugging using the
 349 .Fl Fl enable-debug
 350 option.
 351 The
 352 .Cm mem
 353 option alone can be turned on via
 354 .Fl Fl enable-debug Ns = Ns Cm mem .
 355 Otherwise debugging options are ignored.
 356 Options are
 357 comma delimited, and can be preceded by the string
 358 .Dq Li no
 359 to negate their
 360 meaning.
 361 You can get the list of supported debugging options by running
 362 .Nm amd Fl v .
 363 Possible values are:
 364 .Pp
 365 .Bl -tag -width ".Cm xdrtrace" -compact
 366 .It Cm all
 367 all options
 368 .It Cm amq
 369 register for
 370 .Xr amq 8
 371 .It Cm daemon
 372 enter daemon mode
 373 .It Cm fork
 374 fork server
 375 .It Cm full
 376 program trace
 377 .It Cm info
 378 info service specific debugging
 379 (hesiod, nis, etc.)
 380 .It Cm mem
 381 trace memory allocations
 382 .It Cm mtab
 383 use local
 384 .Pa ./mtab
 385 file
 386 .It Cm str
 387 debug string munging
 388 .It Cm test
 389 full debug but no daemon
 390 .It Cm trace
 391 trace protocol and NFS mount arguments
 392 .It Cm xdrtrace
 393 trace XDR routines
 394 .El
 395 .It Va dismount_interval Pq numeric, default=120
 396 Same as the
 397 .Fl w
 398 option to
 399 .Xr amd 8 .
 400 Specify, in seconds, the time between attempts to dismount
 401 file systems that have exceeded their cached times.
 402 .It Va domain_strip Pq boolean, default=yes
 403 If
 404 .Dq Li yes ,
 405 then the domain
 406 name part referred to by ${rhost} is stripped off.
 407 This is
 408 useful to keep logs and smaller.
 409 If
 410 .Dq Li no ,
 411 then the domain name
 412 part is left changed.
 413 This is useful when using multiple domains with
 414 the same maps (as you may have hosts whose domain-stripped name is
 415 identical).
 416 .It Va exec_map_timeout Pq numeric, default=10
 417 The timeout in seconds that
 418 .Xr amd 8
 419 will wait for an executable map program before an answer is returned from
 420 that program (or script).
 421 This value should be set to as small as possible
 422 while still allowing normal replies to be returned before the timer expires,
 423 because during the time that the executable map program is queried,
 424 .Xr amd 8
 425 is essentially waiting and is thus not responding to any other queries.
 426 .It Va forced_unmounts Pq boolean, default=no
 427 If set to
 428 .Dq Li yes ,
 429 and the client OS supports forced or lazy unmounts, then
 430 .Xr amd 8
 431 will attempt to use them if it gets any of three serious error conditions
 432 when trying to unmount an existing mount point or mount on top of one:
 433 .Er EIO , ESTALE ,
 434 or
 435 .Er EBUSY .
 436 .Pp
 437 This could be useful to recover from serious conditions such as hardware
 438 failure of mounted disks, or NFS servers which are down permanently, were
 439 migrated, or changed their IP address.
 440 Only
 441 .Dq Li type:=toplvl
 442 mounts hung with
 443 .Er EBUSY
 444 are forcibly unmounted using this option, which is useful to recover
 445 from a hung
 446 .Xr amd 8 ) .
 447 .It Va full_os Pq string, default to compiled in value
 448 The full name of the operating system, along with its version.
 449 Allows you
 450 to override the compiled-in full name and version of the operating system.
 451 Useful when the compiled-in name is not desired.
 452 For example, the full
 453 operating system name on Linux comes up as
 454 .Dq Li linux ,
 455 but you can override it to
 456 .Dq Li linux-2.2.5 .
 457 .It Va fully_qualified_hosts Pq string, default=no
 458 If
 459 .Dq Li yes ,
 460 .Xr amd 8
 461 will perform RPC authentication using fully-qualified host names.
 462 This is
 463 necessary for some systems, and especially when performing cross-domain
 464 mounting.
 465 For this function to work, the
 466 .Xr amd 8
 467 variable ${hostd} is used, requiring that ${domain} not be null.
 468 .It Va hesiod_base Pq string, default=automount
 469 Specify the base name for hesiod maps.
 470 .It Va karch Pq string, default to karch of the system
 471 Same as the
 472 .Fl k
 473 option to
 474 .Xr amd 8 .
 475 Allows you to override the kernel-architecture of your
 476 system.
 477 Useful for example on Sun (Sparc) machines, where you can build one
 478 .Nm amd
 479 binary and run it on multiple machines, yet you want each one to get
 480 the correct
 481 .Va karch
 482 variable set (for example, sun4c, sun4m, sun4u, etc.)
 483 Note that if not
 484 specified,
 485 .Xr amd 8
 486 will use
 487 .Xr uname 3
 488 to figure out the kernel architecture of
 489 the machine.
 490 .It Va ldap_base Pq string, default not set
 491 Specify the base name for LDAP.
 492 This often includes LDAP-specific
 493 values such as country and organization.
 494 .It Va ldap_cache_maxmem Pq numeric, default=131072
 495 Specify the maximum memory
 496 .Xr amd 8
 497 should use to cache LDAP entries.
 498 .It Va ldap_cache_seconds Pq numeric, default=0
 499 Specify the number of seconds to keep entries in the cache.
 500 .It Va ldap_hostports Pq string, default not set
 501 Specify the LDAP host and port values.
 502 .It Va ldap_proto_version Pq numeric, default=2
 503 Specify the version of the LDAP protocol to use.
 504 .It Va local_domain Pq string, default no sub-domain
 505 Same as the
 506 .Fl d
 507 option to
 508 .Xr amd 8 .
 509 Specify the local domain name.
 510 If this option is not given
 511 the domain name is determined from the hostname by removing the first
 512 component of the fully-qualified host name.
 513 .It Va localhost_address Pq string, default to localhost or 127.0.0.1
 514 Specify the name or IP address for
 515 .Xr amd 8
 516 to use when connecting the sockets
 517 for the local NFS server and the RPC server.
 518 This defaults to 127.0.0.1 or
 519 whatever the host reports as its local address.
 520 This parameter is useful on
 521 hosts with multiple addresses where you want to force
 522 .Xr amd 8
 523 to connect to a
 524 specific address.
 525 .It Va log_file Pq string, default= Ns Pa /dev/stderr
 526 Same as the
 527 .Fl l
 528 option to
 529 .Xr amd 8 .
 530 Specify a file name to log
 531 .Xr amd 8
 532 events to.
 533 If the string
 534 .Pa /dev/stderr
 535 is specified,
 536 .Xr amd 8
 537 will send its events to the standard error file descriptor.
 538 If the string
 539 .Pa syslog
 540 is given,
 541 .Xr amd 8
 542 will record its events with the system logger
 543 .Xr syslogd 8 .
 544 The default syslog facility used is
 545 .Dv LOG_DAEMON .
 546 If you
 547 wish to change it, append its name to the log file name, delimited by a
 548 single colon.
 549 For example, if
 550 .Pa logfile
 551 is the string
 552 .Dq Li syslog:local7
 553 then
 554 .Xr amd 8
 555 will log messages via
 556 .Xr syslog 3
 557 using the
 558 .Dv LOG_LOCAL7
 559 facility (if it exists on the system).
 560 .It Va log_options Pq string, default no logging options
 561 Same as the
 562 .Fl x
 563 option to
 564 .Xr amd 8 .
 565 Specify any logging options for
 566 .Xr amd 8 .
 567 Options are comma
 568 delimited, and can be preceded by the string
 569 .Dq Li no
 570 to negate their meaning.
 571 The
 572 .Dq Li debug
 573 logging option is only available if am-utils was configured with
 574 .Fl Fl enable-debug .
 575 You can get the list of supported debugging and logging
 576 options by running
 577 .Nm amd Fl H .
 578 Possible values are:
 579 .Pp
 580 .Bl -tag -width ".Cm warning" -compact
 581 .It Cm all
 582 all messages
 583 .It Cm debug
 584 debug messages
 585 .It Cm error
 586 non-fatal system errors
 587 .It Cm fatal
 588 fatal errors
 589 .It Cm info
 590 information
 591 .It Cm map
 592 map errors
 593 .It Cm stats
 594 additional statistical information
 595 .It Cm user
 596 non-fatal user errors
 597 .It Cm warn
 598 warnings
 599 .It Cm warning
 600 warnings
 601 .El
 602 .It Va map_reload_interval Pq numeric, default=3600
 603 The number of seconds that
 604 .Xr amd 8
 605 will wait before it checks to see if any maps
 606 have changed at their source (NIS servers, LDAP servers, files, etc.).
 607 .Xr amd 8
 608 will reload only those maps that have changed.
 609 .It Va nfs_allow_any_interface Pq string, default=no
 610 Normally
 611 .Xr amd 8
 612 accepts local NFS packets only from 127.0.0.1.
 613 If this
 614 parameter is set to
 615 .Dq Li yes
 616 then
 617 .Xr amd 8
 618 will accept local NFS packets from any
 619 local interface; this is useful on hosts that may have multiple interfaces
 620 where the system is forced to send all outgoing packets (even those bound to
 621 the same host) via an address other than 127.0.0.1.
 622 .It Va nfs_allow_insecure_port Pq string, default=no
 623 Normally
 624 .Xr amd 8
 625 will refuse requests coming from unprivileged ports (i.e.\&
 626 ports >= 1024 on Unix systems), so that only privileged users and the kernel
 627 can send NFS requests to it.
 628 However, some kernels (certain versions of
 629 Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged
 630 ports in certain situations, which causes
 631 .Xr amd 8
 632 to stop dead in its tracks.
 633 This parameter allows
 634 .Xr amd 8
 635 to operate normally even on such systems, at the
 636 expense of a slight decrease in the security of its operations.
 637 If you see
 638 messages like
 639 .Dq Li "ignoring request from foo:1234, port not reserved"
 640 in your
 641 .Xr amd 8
 642 log, try enabling this parameter and give it another go.
 643 .It Va nfs_proto Pq string, default to trying version tcp then udp
 644 By default,
 645 .Xr amd 8
 646 tries TCP and then UDP.
 647 This option forces the overall
 648 .Tn NFS
 649 protocol used to TCP or UDP.
 650 It overrides what is in the
 651 .Xr amd 8
 652 maps, and is
 653 useful when
 654 .Nm amd
 655 is compiled with NFSv3 support that may not be stable.
 656 With
 657 this option you can turn off the complete usage of NFSv3 dynamically
 658 (without having to recompile
 659 .Nm amd )
 660 until such time as NFSv3 support is
 661 desired again.
 662 .It Va nfs_retransmit_counter Pq numeric, default=11
 663 Same as the
 664 .Ar retransmit
 665 counter
 666 part of the
 667 .Fl t Ar timeout.retransmit
 668 option to
 669 .Xr amd 8 .
 670 Specifies the number of NFS retransmissions that the kernel will use to
 671 communicate with
 672 .Xr amd 8 .
 673 .It Va nfs_retransmit_counter_udp Pq numeric, default=11
 674 Same as the
 675 .Va nfs_retransmit_counter
 676 option, but for all UDP mounts only.
 677 .It Va nfs_retransmit_counter_tcp Pq numeric, default=11
 678 Same as the
 679 .Va nfs_retransmit_counter
 680 option, but for all TCP mounts only.
 681 .It Va nfs_retransmit_counter_toplvl Pq numeric, default=11
 682 Same as the
 683 .Va nfs_retransmit_counter
 684 option, but only for
 685 .Nm amd Ns 's
 686 top-level UDP mounts.
 687 .It Va nfs_retry_interval Pq numeric, default=8
 688 Same as the
 689 .Ar timeout
 690 interval
 691 part of the
 692 .Fl t Ar timeout.retransmit
 693 option to
 694 .Xr amd 8 .
 695 Specifies the
 696 .Tn NFS
 697 timeout interval, in
 698 .Em tenths
 699 of seconds, between NFS/RPC retries (for UDP and TCP).
 700 This is the value that the kernel will use to
 701 communicate with
 702 .Xr amd 8 .
 703 .Pp
 704 .Xr amd 8
 705 relies on the kernel RPC retransmit mechanism to trigger mount retries.
 706 The values of the
 707 .Va nfs_retransmit_counter
 708 and the
 709 .Va nfs_retry_interval
 710 parameters change the overall retry interval.
 711 Too long an interval gives
 712 poor interactive response; too short an interval causes excessive retries.
 713 .It Va nfs_retry_interval_udp Pq numeric, default=8
 714 Same as the
 715 .Va nfs_retry_interval
 716 option, but for all UDP mounts only.
 717 .It Va nfs_retry_interval_tcp Pq numeric, default=8
 718 Same as the
 719 .It nfs_retry_interval
 720 option, but for all TCP mounts only.
 721 .It Va nfs_retry_interval_toplvl Pq numeric, default=8
 722 Same as the
 723 .It nfs_retry_interval
 724 option, but only for
 725 .Nm amd Ns 's
 726 top-level UDP mounts.
 727 .It Va nfs_vers Pq numeric, default to trying version 3 then 2
 728 By default,
 729 .Xr amd 8
 730 tries version 3 and then version 2.
 731 This option forces the
 732 overall
 733 .Tn NFS
 734 protocol used to version 3 or 2.
 735 It overrides what is in the
 736 .Xr amd 8
 737 maps, and is useful when
 738 .Nm amd
 739 is compiled with NFSv3 support that may not
 740 be stable.
 741 With this option you can turn off the complete usage of NFSv3
 742 dynamically (without having to recompile
 743 .Nm amd )
 744 until such time as NFSv3
 745 support is desired again.
 746 .It Va nis_domain Pq string, default to local Tn NIS domain name
 747 Same as the
 748 .Fl y
 749 option to
 750 .Xr amd 8 .
 751 Specify an alternative
 752 .Tn NIS
 753 domain from which to fetch the
 754 .Tn NIS
 755 maps.
 756 The default is the system domain name.
 757 This option is ignored if
 758 .Tn NIS
 759 support is not available.
 760 .It Va normalize_hostnames Pq boolean, default=no
 761 Same as the
 762 .Fl n
 763 option to
 764 .Xr amd 8 .
 765 If
 766 .Dq Li yes ,
 767 then the name referred to by
 768 .Va ${rhost}
 769 is normalized relative to the host database before being used.
 770 The effect is
 771 to translate aliases into
 772 .Dq official
 773 names.
 774 .It Va normalize_slashes Pq boolean, default=yes
 775 If
 776 .Dq Li yes ,
 777 then
 778 .Xr amd 8
 779 will condense all multiple
 780 .Ql /
 781 (slash) characters into
 782 one and remove all trailing slashes.
 783 If
 784 .Dq Li no ,
 785 then
 786 .Xr amd 8
 787 will not touch
 788 strings that may contain repeated or trailing slashes.
 789 The latter is
 790 sometimes useful with SMB mounts, which often require multiple slash
 791 characters in pathnames.
 792 .It Va os Pq string, default to compiled in value
 793 Same as the
 794 .Fl O
 795 option to
 796 .Xr amd 8 .
 797 Allows you to override the compiled-in name of the operating
 798 system.
 799 Useful when the built-in name is not desired for backward
 800 compatibility reasons.
 801 For example, if the build in name is
 802 .Dq Li sunos5 ,
 803 you can override it to
 804 .Dq Li sos5 ,
 805 and use older maps which were written with the
 806 latter in mind.
 807 .It Va osver Pq string, default to compiled in value
 808 Same as the
 809 .Fl o
 810 option to
 811 .Xr amd 8 .
 812 Overrides the compiled-in version number of the operating
 813 system.
 814 Useful when the built in version is not desired for backward
 815 compatibility reasons.
 816 For example, if the build in version is
 817 .Dq Li 2.5.1 ,
 818 you can override it to
 819 .Dq Li 5.5.1 ,
 820 and use older maps that were written with
 821 the latter in mind.
 822 .It Va pid_file Pq string, default= Ns Pa /dev/stdout
 823 Specify a file to store the process ID of the running daemon into.
 824 If not
 825 specified,
 826 .Xr amd 8
 827 will print its process ID onto the standard output.
 828 Useful
 829 for killing
 830 .Xr amd 8
 831 after it had run.
 832 Note that the PID of a running
 833 .Nm amd
 834 can
 835 also be retrieved via
 836 .Nm amq Fl p .
 837 This file is used only if the
 838 .Va print_pid
 839 option is on.
 840 .It Va plock Pq boolean, default=yes
 841 Same as the
 842 .Fl S
 843 option to
 844 .Xr amd 8 .
 845 If
 846 .Dq Li yes ,
 847 lock the running executable pages of
 848 .Nm amd
 849 into memory.
 850 To improve
 851 .Nm amd Ns 's
 852 performance, systems that support the
 853 .Xr plock 3
 854 or
 855 .Xr mlockall 2
 856 call can lock the
 857 .Nm amd
 858 process into memory.
 859 This way there is less chance that
 860 the operating system will schedule, page out, and swap the
 861 .Nm amd
 862 process as needed.
 863 This improves
 864 .Nm amd Ns 's
 865 performance, at the cost of reserving the
 866 memory used by the
 867 .Nm amd
 868 process (making it unavailable for other processes).
 869 .It Va portmap_program Pq numeric, default=300019
 870 Specify an alternate Port-mapper RPC program number, other than the official
 871 number.
 872 This is useful when running multiple
 873 .Nm amd
 874 processes.
 875 For example,
 876 you can run another
 877 .Xr amd 8
 878 in
 879 .Dq test
 880 mode, without affecting the primary
 881 .Nm amd
 882 process in any way.
 883 For safety reasons, the alternate program numbers that
 884 can be specified must be in the range 300019-300029, inclusive.
 885 The
 886 .Xr amq 8
 887 utility
 888 has an option
 889 .Fl P
 890 which can be used to specify an alternate program number of an
 891 .Nm amd
 892 to contact.
 893 In this way,
 894 .Nm amq
 895 can fully control any number of
 896 .Nm amd
 897 processes running on the same host.
 898 .It Va preferred_amq_port Pq numeric, default=0
 899 Specify an alternate Port-mapper RPC port number for
 900 .Nm amd Ns 's
 901 .Xr amq 8
 902 service.
 903 This is used for both UDP and TCP.
 904 Setting this value to 0 (or
 905 not defining it) will cause
 906 .Xr amd 8
 907 to select an arbitrary port number.
 908 Setting the
 909 .Xr amq 8
 910 RPC service port to a specific number is useful in firewalled or NAT'ed
 911 environments, where you need to know which port
 912 .Xr amd 8
 913 will listen on.
 914 .It Va print_pid Pq boolean, default=no
 915 Same as the
 916 .Fl p
 917 option to
 918 .Xr amd 8 .
 919 If
 920 .Dq Li yes ,
 921 .Nm amd
 922 will print its process ID upon starting.
 923 .It Va print_version Pq boolean, default=no
 924 Same as the
 925 .Fl v
 926 option to
 927 .Xr amd 8 ,
 928 but the version prints and
 929 .Nm amd
 930 continues to run.
 931 If
 932 .Dq Li yes ,
 933 .Nm amd
 934 will print its version information string, which includes some
 935 configuration and compilation values.
 936 .It Va restart_mounts Pq boolean, default=no
 937 Same as the
 938 .Fl r
 939 option to
 940 .Xr amd 8 .
 941 If
 942 .Dq Li yes ,
 943 .Nm amd
 944 will scan the mount table to determine which file systems are currently
 945 mounted.
 946 Whenever one of these would have been auto-mounted,
 947 .Nm amd
 948 inherits it.
 949 .It Va show_statfs_entries Pq boolean, default=no
 950 If
 951 .Dq Li yes ,
 952 then all maps which are browsable will also show the number of
 953 entries (keys) they have when
 954 .Xr df 1
 955 runs.
 956 (This is accomplished by returning
 957 non-zero values to the
 958 .Xr statfs 2
 959 system call.)
 960 .It Va truncate_log Pq boolean, default=no
 961 If
 962 .Dq Li yes ,
 963 then the log file (if it is a regular file), will be truncated
 964 upon startup.
 965 .It Va unmount_on_exit Pq boolean, default=no
 966 If
 967 .Dq Li yes ,
 968 then
 969 .Xr amd 8
 970 will attempt to unmount all file systems which it knows
 971 about.
 972 Normally
 973 .Nm amd
 974 leaves all
 975 (esp.\&
 976 .Tn NFS )
 977 mounted file systems intact.
 978 Note that
 979 .Nm amd
 980 does not know about file systems mounted before it starts up,
 981 unless the
 982 .Va restart_mounts
 983 option or
 984 .Fl r
 985 flag are used.
 986 .It Va use_tcpwrappers Pq boolean, default=yes
 987 If
 988 .Dq Li yes ,
 989 then
 990 .Xr amd 8
 991 will use the tcpd/libwrap tcpwrappers library
 992 (if available) to control
 993 access to
 994 .Nm amd
 995 via the
 996 .Pa /etc/hosts.allow
 997 and
 998 .Pa /etc/hosts.deny
 999 files.
1000 .It Va vendor Pq string, default to compiled in value
1001 The name of the vendor of the operating system.
1002 Overrides the compiled-in
1003 vendor name.
1004 Useful when the compiled-in name is not desired.
1005 For example,
1006 most Intel based systems set the vendor name to
1007 .Dq Li unknown ,
1008 but you can set it to
1009 .Dq Li redhat .
1010 .El
1011 .Ss "Parameters applicable to regular map sections"
1012 .Bl -tag -width 4n
1013 .It Va map_name Pq string, must be specified
1014 Name of the map where the keys are located.
1015 .It Va tag Pq string, default no tag
1016 Each map entry in the configuration file can be tagged.
1017 If no tag is
1018 specified, that map section will always be processed by
1019 .Xr amd 8 .
1020 If it is
1021 specified, then
1022 .Nm amd
1023 will process the map if the
1024 .Fl T
1025 option was given to
1026 .Xr amd 8 ,
1027 and the value given to that command-line option
1028 matches that in the map section.
1029 .El
1030 .Sh EXAMPLES
1031 Here is a real
1032 .Xr amd 8
1033 configuration I use daily.
1034 .Bd -literal
1035 # GLOBAL OPTIONS SECTION
1036 [ global ]
1037 normalize_hostnames =    no
1038 print_pid =              no
1039 restart_mounts =         yes
1040 auto_dir =               /n
1041 log_file =               /var/log/amd
1042 log_options =            all
1043 #debug_options =         all
1044 plock =                  no
1045 selectors_in_defaults =  yes
1046 # config.guess picks up "sunos5" and I don't want to edit my maps yet
1047 os =                     sos5
1048 # if you print_version after setting up "os", it will show it.
1049 print_version =          no
1050 map_type =               file
1051 search_path =            /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
1052 browsable_dirs =         yes
1053
1054 # DEFINE AN AMD MOUNT POINT
1055 [ /u ]
1056 map_name =               amd.u
1057
1058 [ /proj ]
1059 map_name =               amd.proj
1060
1061 [ /src ]
1062 map_name =               amd.src
1063
1064 [ /misc ]
1065 map_name =               amd.misc
1066
1067 [ /import ]
1068 map_name =               amd.import
1069
1070 [ /tftpboot/.amd ]
1071 tag =                    tftpboot
1072 map_name =               amd.tftpboot
1073 .Ed
1074 .Sh SEE ALSO
1075 .Xr hosts_access 5 ,
1076 .Xr amd 8 ,
1077 .Xr amq 8
1078 .Pp
1079 .Dq am-utils
1080 .Xr info 1
1081 entry.
1082 .Rs
1083 .%A Erez Zadok
1084 .%B "Linux NFS and Automounter Administration"
1085 .%O ISBN 0-7821-2739-8
1086 .%I Sybex
1087 .%D 2001
1088 .Re
1089 .Pp
1090 .Pa http://www.am-utils.org/
1091 .Rs
1092 .%T Amd \- The 4.4 BSD Automounter
1093 .Re
1094 .Sh HISTORY
1095 The
1096 .Xr amd 8
1097 utility first appeared in
1098 .Bx 4.4 .
1099 .Sh AUTHORS
1100 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
1101 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
1102 .Pp
1103 Other authors and contributors to am-utils are listed in the
1104 .Pa AUTHORS
1105 file distributed with am-utils.