1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
[
<!ENTITY defaultdir "<filename>/usr/share/configlets</filename>">
<!ENTITY cfg "<replaceable>CONFIGLET-PATH</replaceable>">
]>
<!-- $Progeny: update-configlets.refentry,v 1.11 2002/02/12 16:44:45 epg Exp $ -->
<refentry>
<refentryinfo>
<authorgroup>
<author>
<firstname>John</firstname>
<othername role="mi">R.</othername>
<surname>Daily</surname>
</author>
</authorgroup>
<copyright>
<year>2002</year>
<year>2001</year>
<holder>Progeny Linux Systems, Inc.</holder>
</copyright>
<date>2002-01-03</date>
</refentryinfo>
<refmeta>
<refentrytitle>UPDATE-CONFIGLETS</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>update-configlets</refname>
<refpurpose>Register configlets with any existing front end</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>update-configlets</command>
<group choice="opt">
<arg>--update</arg>
<arg>--install-all</arg>
<arg>--remove-all</arg>
<arg>--install &cfg;</arg>
<arg>--remove &cfg;</arg>
<arg>--reinstall &cfg;</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
This utility manages configlet registration by forwarding the
supplied arguments to front end scripts in
<filename>/etc/configlet.d</filename>.
</para>
<para>
&cfg; must be an absolute path to the directory in which the
configlet is located.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--update</option></term>
<listitem>
<para>
Effectively the same as consecutive runs of
<literal>--remove-all</literal> and
<literal>--install-all</literal>. This is the default if no
arguments are provided.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--install-all</option></term>
<listitem>
<para>
Register all configlets found in &defaultdir;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-all</option></term>
<listitem>
<para>
Unregister all configlets.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--install &cfg;</option></term>
<listitem>
<para>
Register the configlet installed in &cfg;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove &cfg;</option></term>
<listitem>
<para>
Unregister the configlet installed in &cfg;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ERRORS</title>
<para>
If <filename>/etc/configlet.d</filename> does not exist, the
application will indicate this and terminate.
</para>
<para>
<command>update-configlets</command> will invoke other scripts
provided by the configlet authors; those may report other errors.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/configlet.d</filename></term>
<listitem>
<para>
Front ends should place a script here to be invoked by
<command>update-configlets</command> for configlet
registration.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
Jeff Licquia <<email>jlicquia@progeny.com</email>>
</para>
</refsect1>
</refentry>
|