xref: /dflybsd-src/sbin/rconfig/rconfig.8 (revision bc49aa1be5400e3bdd801519c6936e8947d5d432)
1.\" $DragonFly: src/sbin/rconfig/rconfig.8,v 1.2 2004/07/04 17:21:15 eirikn Exp $
2.Dd June 17, 2004
3.Dt RCONFIG 8
4.Os
5.Sh NAME
6.Nm rconfig
7.Nd Remote Configuration Client/Server
8.Sh SYNOPSIS
9.Nm
10.Bk -words
11.Op Fl a
12.Op Fl W Ar workdir
13.Op Fl T Ar tagdir
14.Op Fl C Ar configfiles
15.Op Fl s
16.Op Fl v
17.Ek
18.Sh DESCRIPTION
19The
20.Nm
21utility provides simple remote configurator functionality.  In client mode
22.Nm
23will broadcast a request for the specified configuration tag over available
24interfaces (or you can specify an IP), locate a server capable of supplying
25the tag, then connect to, download, and run the script associate with the
26tag.  In server mode
27.Nm
28will listen on port 257 for broadcast requests (UDP) and connections (TCP).
29Note that UDP based requests are only responded to if the requested tag
30is available.  You can run the server on multiple machines on the LAN
31serving different tags or, if you wish to provide a backup, serving the
32same tags, or a mix.  The client will use the first matching tag it encounters.
33.Pp
34The following command line options are available when operating in client mode:
35.Bl -tag -width Fl
36.It Fl a
37.Nm
38will broadcast a request for the 'auto' tag on all available interfaces.
39No additional arguments are necessary.
40.It Fl W Ar workdir
41Specify the working directory for script downloads.  The default is
42.Pa /tmp .
43.It Fl v
44Verbose mode prints additional information during program execution.
45.It host[:tag]
46Specify any number of remote IP addresses or broadcast addresses.  If no
47tag is specified
48.Nm
49defaults to 'auto'.  If you specify just a tag using :tag the broadcast
50address for all available interfaces will be used.  The
51.Fl a
52option should not be used in that case.
53.El
54.Pp
55The following command line options are available when operating in server mode:
56.Bl -tag -width Fl
57.It Fl a
58.Nm
59will bind to and listen on all available interfaces.  If this option is not
60used you must specify a particular IP address or addresses to bind to.  The
61server listens on port 257 for both UDP and TCP.
62.It Fl T Ar tagdir
63Specify the directory containing the tag scripts.  The default is
64.Pa /usr/local/etc/rconfig .
65Tag scripts are in the form:
66.Pa tagname.sh .
67.It Fl C Ar configfiles
68Specify server configuration files (currently unused).
69.It Fl s
70This option is required to operate
71.Nm
72as a server.
73.It Fl v
74Verbose mode prints additional information during program execution.
75.It bind_address
76Specify any number of IP addresses or hostnames corresponding to machine
77local addresses that the server will bind to and listen on.
78.El
79.Pp
80.Sh SEE ALSO
81.Xr dhclient 8
82.Sh AUTHORS
83This program was written by Matthew Dillon.
84