libSystem
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY firstname "Pierre">
<!ENTITY surname "Pronchery">
<!ENTITY username "khorben">
<!ENTITY email "khorben@defora.org">
<!ENTITY section "1">
<!ENTITY title "libSystem User Manual">
<!ENTITY package "DeforaOS libSystem">
<!ENTITY name "configctl">
<!ENTITY purpose "Generic tool to parse and update configuration files">
]>
<refentry>
<refentryinfo>
<title>&title;</title>
<date>@DATE@</date>
<productname>&package;</productname>
<authorgroup>
<author>
<firstname>&firstname;</firstname>
<surname>&surname;</surname>
<contrib>Code and documentation.</contrib>
<address>
<email>&email;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2014</year>
<year>2015</year>
<year>2016</year>
<year>2017</year>
<year>2018</year>
<year>2019</year>
<year>2020</year>
<year>2021</year>
<year>2022</year>
<holder>&firstname; &surname; <&email;></holder>
</copyright>
<legalnotice>
<para>This manual page was written for the DeforaOS project (and may be
used by others).</para>
<para>Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License,
Version 3 as published by the Free Software Foundation.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&name;</refentrytitle>
<manvolnum>§ion;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<arg choice="plain"><option>-f</option>
<replaceable>filename</replaceable></arg>
<arg choice="plain"><option>-a</option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&name;</command>
<arg choice="plain"><option>-f</option>
<replaceable>filename</replaceable></arg>
<group choice="opt">
<arg choice="plain"><option>-q</option></arg>
<arg choice="plain"><option>-v</option></arg>
</group>
<arg choice="plain" rep="repeat">
<arg choice="opt"><replaceable>section.</replaceable></arg>
<arg choice="plain"><replaceable>variable</replaceable></arg>
</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&name;</command>
<arg choice="plain"><option>-w</option></arg>
<arg choice="plain"><option>-f</option>
<replaceable>filename</replaceable></arg>
<group choice="opt">
<arg choice="plain"><option>-q</option></arg>
<arg choice="plain"><option>-v</option></arg>
</group>
<arg choice="plain" rep="repeat">
<arg choice="opt"><replaceable>section.</replaceable></arg>
<arg choice="plain"><replaceable>variable</replaceable></arg>
<arg choice="opt"><replaceable>=value</replaceable></arg>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a generic tool for parsing and updating
configuration files.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para><command>&name;</command> expects the name of a variable to be specified
on the command line, optionally following a section name delimited with a dot
("."). In write mode, a new value can be set after an equal ("=") delimiter.
The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-a</option></term>
<listitem>
<para>Print every value set in every section for this file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<listitem>
<para>Filename to parse or update.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<listitem>
<para>Disable output on the standard stream.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>Be more verbose.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<listitem>
<para>Update a value or add a new one, and save it back into the original
file.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>Issues can be listed and reported at <ulink
url="https://www.defora.org/os/project/bug_list/27/libSystem"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>configure</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->