NetBSD/usr.sbin/rpc.bootparamd/rpc.bootparamd.8

.\" $NetBSD: rpc.bootparamd.8,v 1.16 2003/08/20 13:07:41 tsutsui Exp $
.\" @(#)bootparamd.8
.Dd January 8, 1994
.Dt BOOTPARAMD 8
.Os
.Sh NAME
.Nm bootparamd ,
.Nm rpc.bootparamd
.Nd boot parameter server
.Sh SYNOPSIS
.Nm
.Op Fl ds
.Op Fl i Ar interface
.Op Fl r Ar router
.Op Fl f Ar file
.Sh DESCRIPTION
.Nm
is a server process that provides information to diskless clients
necessary for booting. It consults the file
.Dq Pa /etc/bootparams .
It should normally be started from
.Dq Pa /etc/rc .
.Pp
This version will allow the use of aliases on the hostname in the
.Dq Pa /etc/bootparams
file. The hostname returned in response to the booting client's whoami request
will be the name that appears in the config file, not the canonical name.
In this way you can keep the answer short enough
so that machines that cannot handle long hostnames won't fail during boot.
.Pp
While parsing, if a line containing just ``+'' is found, and
the YP subsystem is active, the YP map
.Pa bootparams
will be searched immediately.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl d
Display the debugging information. The daemon does not fork in this
case.
.It Fl i Ar interface
Specify the interface to become the default router.
.Nm
picks the first IPv4 address it finds on the system by default.
With
.Fl i ,
you can control which interface to be used to obtain the default router address.
.Fl r
overrides
.Fl i .
.It Fl s
Log the debugging information with
.Xr syslog 3 .
.It Fl r
Set the default router (a hostname or IP-address).
This defaults to the machine running the server.
.It Fl f
Specify the file to use as boot parameter file instead of
.Dq Pa /etc/bootparams .
.El
.Sh FILES
.Bl -tag -width /etc/bootparams -compact
.It Pa /etc/bootparams
default configuration file
.El
.Sh SEE ALSO
.Xr bootparams 5
.Sh AUTHORS
Originally written by
.An Klas Heggemann
.Aq klas@nada.kth.se .
.Sh BUGS
You may find the syslog messages too verbose.
.Pp
It's not clear if the non-canonical hack mentioned above is a good idea.
Fix Typo. 2003-08-20 17:07:41 +04:00			`.\" $NetBSD: rpc.bootparamd.8,v 1.16 2003/08/20 13:07:41 tsutsui Exp $`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.\" @(#)bootparamd.8`
Use full month names with .Dd, as per mdoc.samples(7). 1999-09-12 22:47:10 +04:00			`.Dd January 8, 1994`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Dt BOOTPARAMD 8`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:43:46 +03:00			`.Os`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Sh NAME`
Install manpage as both bootparamd(8) and rpc.bootparamd(8). Changed manpage so both bootparamd and rpc.bootparamd are mentioned in NAME section. 1995-04-12 04:53:09 +04:00			`.Nm bootparamd ,`
			`.Nm rpc.bootparamd`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Nd boot parameter server`
			`.Sh SYNOPSIS`
WARNSify; generate ansi c code with rpcgen, cleanup manpage 1997-10-17 19:59:05 +04:00			`.Nm`
make it possible to obtain default router address from any interface (-i). -r might be sufficient. http://pc.2ch.net/test/read.cgi/unix/1050823044/377 2003-06-26 09:38:45 +04:00			`.Op Fl ds`
Fix Typo. 2003-08-20 17:07:41 +04:00			`.Op Fl i Ar interface`
eliminate extra dashes before option arguments; from Enami Tsugutomo in PR bin/4000. also add xref to syslog(3) and fix some typos. 1997-08-19 08:20:40 +04:00			`.Op Fl r Ar router`
			`.Op Fl f Ar file`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Sh DESCRIPTION`
WARNSify; generate ansi c code with rpcgen, cleanup manpage 1997-10-17 19:59:05 +04:00			`.Nm`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`is a server process that provides information to diskless clients`
			`necessary for booting. It consults the file`
			`.Dq Pa /etc/bootparams .`
			`It should normally be started from`
			`.Dq Pa /etc/rc .`
			`.Pp`
			`This version will allow the use of aliases on the hostname in the`
			`.Dq Pa /etc/bootparams`
			`file. The hostname returned in response to the booting client's whoami request`
			`will be the name that appears in the config file, not the canonical name.`
			`In this way you can keep the answer short enough`
			`so that machines that cannot handle long hostnames won't fail during boot.`
document that YP works 1994-10-24 11:01:56 +03:00			`.Pp`
			While parsing, if a line containing just ``+'' is found, and
			`the YP subsystem is active, the YP map`
			`.Pa bootparams`
			`will be searched immediately.`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Sh OPTIONS`
			`.Bl -tag -width indent`
			`.It Fl d`
			`Display the debugging information. The daemon does not fork in this`
			`case.`
make it possible to obtain default router address from any interface (-i). -r might be sufficient. http://pc.2ch.net/test/read.cgi/unix/1050823044/377 2003-06-26 09:38:45 +04:00			`.It Fl i Ar interface`
			`Specify the interface to become the default router.`
			`.Nm`
			`picks the first IPv4 address it finds on the system by default.`
			`With`
			`.Fl i ,`
			`you can control which interface to be used to obtain the default router address.`
			`.Fl r`
			`overrides`
			`.Fl i .`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.It Fl s`
eliminate extra dashes before option arguments; from Enami Tsugutomo in PR bin/4000. also add xref to syslog(3) and fix some typos. 1997-08-19 08:20:40 +04:00			`Log the debugging information with`
			`.Xr syslog 3 .`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.It Fl r`
			`Set the default router (a hostname or IP-address).`
			`This defaults to the machine running the server.`
			`.It Fl f`
			`Specify the file to use as boot parameter file instead of`
			`.Dq Pa /etc/bootparams .`
			`.El`
			`.Sh FILES`
			`.Bl -tag -width /etc/bootparams -compact`
			`.It Pa /etc/bootparams`
			`default configuration file`
			`.El`
change: .Sh "SEE ALSO" to: .Sh SEE ALSO The doc macros check for the latter (actually just for 'SEE' as the first argument to .Sh) to set the section header SEE ALSO flag, which modifies some behaviour (e.g. references done with .Rs/.Re). 1999-04-06 08:54:19 +04:00			`.Sh SEE ALSO`
Fix SEE ALSO and FILES. 1994-10-03 22:26:13 +03:00			`.Xr bootparams 5`
Sort sections, use standard headers, drop a .Pp. 2002-02-02 04:42:22 +03:00			`.Sh AUTHORS`
The correct capitalisation of 'NetBSD.org' is (you guessed it) 'NetBSD.org'. some mdoc fixes. 2003-02-14 19:11:34 +03:00			`Originally written by`
			`.An Klas Heggemann`
			`.Aq klas@nada.kth.se .`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Sh BUGS`
eliminate extra dashes before option arguments; from Enami Tsugutomo in PR bin/4000. also add xref to syslog(3) and fix some typos. 1997-08-19 08:20:40 +04:00			`You may find the syslog messages too verbose.`
rpc.bootparamd written by Klas Heggemann <klas@nada.kth.se> (yes, it belongs in usr.sbin, not libexec) 1994-01-08 16:22:03 +03:00			`.Pp`
eliminate extra dashes before option arguments; from Enami Tsugutomo in PR bin/4000. also add xref to syslog(3) and fix some typos. 1997-08-19 08:20:40 +04:00			`It's not clear if the non-canonical hack mentioned above is a good idea.`