source: trunk/confsync.8 @ 471

Revision 471, 3.2 KB checked in by ccowart, 3 years ago (diff)

Adding support for a -q flag to suppress the no-op log messages.

Fixes #71

  • Property svn:keywords set to Id
Line 
1.\" Copyright (c) 2008, Christopher Cowart and contributors
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" * Redistributions of source code must retain the above copyright
8.\"   notice, this list of conditions and the following disclaimer.
9.\" * Redistributions in binary form must reproduce the above copyright
10.\"   notice, this list of conditions and the following disclaimer in the
11.\"   documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
14.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
15.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
16.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
17.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
19.\" TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20.\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
21.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $Id$
26.\"
27.Dd May 06, 2009
28.Dt CONFSYNC 8
29.Os
30.Sh NAME
31.Nm confsync
32.Nd configuration syncer
33.Sh SYNOPSIS
34.Nm
35.Op Fl f
36.Op Fl s
37.Op Fl d
38.Op Fl q
39.Nm
40.Fl h
41.Sh DESCRIPTION
42The
43.Nm
44utility is designed to be run from
45.Xr cron 8
46to allow managed hosts to sync the latest configurations from the repository.
47.Nm
48is effectively a
49.Cm confman commit
50operation without the overhead of a working copy.
51.Pp
52If the system is already up to date,
53.Nm
54will exit without making any changes.  This behavior can be overridden with
55the
56.Fl f
57option, which will force
58.Nm
59to run even if the system revision equals the tar revision.  This is useful
60when files are known to have been modified on the live filesystem.  Note that
61the
62.Fl f
63option cannot be used to sync a tar revision less than the system revision.
64.Pp
65The
66.Fl s
67option will cause
68.Nm
69to run in sleep mode.  In this mode,
70.Nm
71will sleep for CONF_SYNC_SLEEP seconds before executing.  This can be used to
72stagger the execution of
73.Nm
74across multiple managed hosts.
75.Pp
76The
77.Fl d
78option can be used to print additional debugging information. The
79.Fl q
80can be used to quiet the log messages by suppressing the "System is up to date"
81messages.
82.Pp
83When launched with
84.Fl h ,
85.Nm
86will display the usage statement and exit.
87.Pp
88The use of
89.Nm
90requires the use of
91.Xr confexport 8
92and that CONF_EXPORT_URI be defined in
93.Xr confman.conf 5 .
94.Sh SECURITY CONSIDERATIONS
95Currently,
96.Nm
97does no verification on the export file. For this reason, it is highly
98recommended that you configure
99.Nm
100to fetch the export using a protocol that is secure against man-in-the-middle
101and other nasty attacks, such as
102.Xr scp 1 ,
103or https.
104.Sh SEE ALSO
105.Xr confman 8 ,
106.Xr confexport 8 ,
107.Xr confman.conf 5 ,
108.Xr cron 8
109.Sh AUTHORS
110.An Chris Cowart Aq ccowart@timesinks.net
Note: See TracBrowser for help on using the repository browser.