| 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 CONFEXPORT 8 |
|---|
| 29 | .Os |
|---|
| 30 | .Sh NAME |
|---|
| 31 | .Nm confexport |
|---|
| 32 | .Nd configuration exporter |
|---|
| 33 | .Sh SYNOPSIS |
|---|
| 34 | .Nm |
|---|
| 35 | .Op Fl d |
|---|
| 36 | .Nm |
|---|
| 37 | .Fl h |
|---|
| 38 | .Sh DESCRIPTION |
|---|
| 39 | The |
|---|
| 40 | .Nm |
|---|
| 41 | utility is designed to be run from |
|---|
| 42 | .Xr cron 8 |
|---|
| 43 | to provide a dump of the |
|---|
| 44 | .Xr confman 8 |
|---|
| 45 | repository for use by hosts running |
|---|
| 46 | .Xr confsync 8 . |
|---|
| 47 | .Pp |
|---|
| 48 | If the system is already up to date, |
|---|
| 49 | .Nm |
|---|
| 50 | will exit without making any changes. This behavior can be overridden with the |
|---|
| 51 | .Fl f |
|---|
| 52 | option, which will force |
|---|
| 53 | .Nm |
|---|
| 54 | to run even if the system revision equals the export revision. Note that the |
|---|
| 55 | .Fl f |
|---|
| 56 | option cannot be used to export a revision less than the system revision. |
|---|
| 57 | .Pp |
|---|
| 58 | The |
|---|
| 59 | .Fl d |
|---|
| 60 | option can be used to print additional debugging information. |
|---|
| 61 | .Pp |
|---|
| 62 | When launched with |
|---|
| 63 | .Fl h , |
|---|
| 64 | .Nm |
|---|
| 65 | will display the usage statement and exit. |
|---|
| 66 | .Pp |
|---|
| 67 | The export generated by |
|---|
| 68 | .Nm |
|---|
| 69 | will be written to the file specified in CONF_EXPORT_FILE (See |
|---|
| 70 | .Xr confman.conf 5) . |
|---|
| 71 | .Pp |
|---|
| 72 | A persistent working copy can be specified with CONF_EXPORT_WORK_PATH in |
|---|
| 73 | .Xr confman.conf 5 . |
|---|
| 74 | This eliminates the performance overhead of repeatedly creating and |
|---|
| 75 | destroying temporary working copies. |
|---|
| 76 | .Ss EXPORT STYLES |
|---|
| 77 | The following export styles are supported by |
|---|
| 78 | .Nm : |
|---|
| 79 | .Bl -tag -width indent |
|---|
| 80 | .It Cm repository |
|---|
| 81 | When using repository-style exports, |
|---|
| 82 | .Nm |
|---|
| 83 | will generate a single tarball containing the entire |
|---|
| 84 | .Xr confman 8 |
|---|
| 85 | repository. The value of CONF_EXPORT_FILE in |
|---|
| 86 | .Xr confman.conf 5 |
|---|
| 87 | is used to specify the name of the resulting tarball. |
|---|
| 88 | .It Cm recipe |
|---|
| 89 | When using recipe-style exports, |
|---|
| 90 | .Nm |
|---|
| 91 | will generate a tarball for every recipe in the |
|---|
| 92 | .Xr confman 8 |
|---|
| 93 | repository. The value of CONF_EXPORT_FILE in |
|---|
| 94 | .Xr confman.conf 5 |
|---|
| 95 | is used to specify the name of the directory that will store these tarballs. |
|---|
| 96 | .It Cm module |
|---|
| 97 | When using module-style exports, |
|---|
| 98 | .Nm |
|---|
| 99 | will generate a tarball for each module in the |
|---|
| 100 | .Xr confman 8 |
|---|
| 101 | repository. The value of CONF_EXPORT_FILE in |
|---|
| 102 | .Xr confman.conf 5 |
|---|
| 103 | is used to specify the name of the directory that will store these tarballs. |
|---|
| 104 | .Sh SECURITY CONSIDERATIONS |
|---|
| 105 | Because a tarball with all your configurations can potentially have sensitive |
|---|
| 106 | data, it is recommended that the System Administrator take reasonable |
|---|
| 107 | precautions for her environment. This certainly includes consideration of |
|---|
| 108 | the owner and group of the export file as well as the intended means for |
|---|
| 109 | distribution of and access to the file. |
|---|
| 110 | .Sh SEE ALSO |
|---|
| 111 | .Xr confman 8 , |
|---|
| 112 | .Xr confsync 8 , |
|---|
| 113 | .Xr confman.conf 5 , |
|---|
| 114 | .Xr cron 8 |
|---|
| 115 | .Sh BUGS |
|---|
| 116 | When using |
|---|
| 117 | .Nm |
|---|
| 118 | with the CONF_EXPORT_INCREMENTAL option, changes to files that are |
|---|
| 119 | referenced in other modules by in-repository symlinks do not cause |
|---|
| 120 | all relevant exports to be regenerated. This can be worked around by |
|---|
| 121 | either disabling the CONF_EXPORT_INCREMENTAL option or running |
|---|
| 122 | .Nm |
|---|
| 123 | with the |
|---|
| 124 | .Fl f |
|---|
| 125 | flag when such changes are made. |
|---|
| 126 | .Sh AUTHORS |
|---|
| 127 | .An Chris Cowart Aq ccowart@timesinks.net |
|---|
