5ce82c10a5260dd7b1eecb6fda29ccd3040d1240
[dragonfly.git] / sbin / rconfig / rconfig.8
1 .\" $DragonFly: src/sbin/rconfig/rconfig.8,v 1.5 2006/03/26 22:56:57 swildner Exp $
2 .\"
3 .\" Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
4 .\"
5 .\" This code is derived from software contributed to The DragonFly Project
6 .\" by Matthew Dillon <dillon@backplane.com>
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\"
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in
16 .\"    the documentation and/or other materials provided with the
17 .\"    distribution.
18 .\" 3. Neither the name of The DragonFly Project nor the names of its
19 .\"    contributors may be used to endorse or promote products derived
20 .\"    from this software without specific, prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .Dd June 17, 2004
36 .Dt RCONFIG 8
37 .Os
38 .Sh NAME
39 .Nm rconfig
40 .Nd Remote Configuration Client/Server
41 .Sh SYNOPSIS
42 .Nm
43 .Bk -words
44 .Op Fl a
45 .Op Fl W Ar workdir
46 .Op Fl T Ar tagdir
47 .Op Fl C Ar configfiles
48 .Op Fl s
49 .Op Fl v
50 .Ek
51 .Sh DESCRIPTION
52 The
53 .Nm
54 utility provides simple remote configurator functionality.  In client mode
55 .Nm
56 will broadcast a request for the specified configuration tag over available
57 interfaces (or you can specify an IP), locate a server capable of supplying
58 the tag, then connect to, download, and run the script associate with the
59 tag.  In server mode
60 .Nm
61 will listen on port 257 for broadcast requests (UDP) and connections (TCP).
62 Note that UDP based requests are only responded to if the requested tag
63 is available.  You can run the server on multiple machines on the LAN
64 serving different tags or, if you wish to provide a backup, serving the
65 same tags, or a mix.  The client will use the first matching tag it encounters.
66 .Pp
67 The following command line options are available when operating in client mode:
68 .Bl -tag -width Fl
69 .It Fl a
70 .Nm
71 will broadcast a request for the 'auto' tag on all available interfaces.
72 No additional arguments are necessary.
73 .It Fl W Ar workdir
74 Specify the working directory for script downloads.  The default is
75 .Pa /tmp .
76 .It Fl v
77 Verbose mode prints additional information during program execution.
78 .It host[:tag]
79 Specify any number of remote IP addresses or broadcast addresses.  If no
80 tag is specified
81 .Nm
82 defaults to 'auto'.  If you specify just a tag using :tag the broadcast
83 address for all available interfaces will be used.  The
84 .Fl a
85 option should not be used in that case.
86 .El
87 .Pp
88 The following command line options are available when operating in server mode:
89 .Bl -tag -width Fl
90 .It Fl a
91 .Nm
92 will bind to and listen on all available interfaces.  If this option is not
93 used you must specify a particular IP address or addresses to bind to.  The
94 server listens on port 257 for both UDP and TCP.
95 .It Fl T Ar tagdir
96 Specify the directory containing the tag scripts.  The default is
97 .Pa /usr/local/etc/rconfig .
98 Tag scripts are in the form:
99 .Pa tagname.sh .
100 .It Fl C Ar configfiles
101 Specify server configuration files (currently unused).
102 .It Fl s
103 This option is required to operate
104 .Nm
105 as a server.
106 .It Fl v
107 Verbose mode prints additional information during program execution.
108 .It bind_address
109 Specify any number of IP addresses or hostnames corresponding to machine
110 local addresses that the server will bind to and listen on.
111 .El
112 .Sh SEE ALSO
113 .Xr dhclient 8
114 .Sh AUTHORS
115 This program was written by Matthew Dillon.