ostree/man/ostree-config.xml
Matthew Leeds 656853a98a man/ostree-config: Consistently use GROUPNAME placeholder
It doesn't make much sense to use SECTIONNAME in some places and
GROUPNAME in others when they mean the same thing.

Closes: #1743
Approved by: cgwalters
2019-03-01 16:29:44 +00:00

104 lines
4.1 KiB
XML

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
SPDX-License-Identifier: LGPL-2.0+
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
-->
<refentry id="ostree">
<refentryinfo>
<title>ostree config</title>
<productname>OSTree</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Colin</firstname>
<surname>Walters</surname>
<email>walters@verbum.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>ostree config</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-config</refname>
<refpurpose>Change configuration settings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree config get</command> <arg choice="req">GROUPNAME.KEYNAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config get</command> <arg choice="req"> --group=GROUPNAME</arg> <arg choice="req"> KEYNAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config set</command> <arg choice="req">GROUPNAME.KEYNAME</arg> <arg choice="req">VALUE</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config set</command> <arg choice="req"> --group=GROUPNAME</arg> <arg choice="req"> KEYNAME</arg> <arg choice="req">VALUE</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config unset</command> <arg choice="req">GROUPNAME.KEYNAME</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config unset</command> <arg choice="req"> --group=GROUPNAME</arg> <arg choice="req"> KEYNAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<itemizedlist>
<listitem><para>
<command>ostree config get</command> displays the value of
<arg choice="plain">KEYNAME</arg> in the group <arg choice="plain">GROUPNAME</arg>
</para></listitem>
<listitem><para>
<command>ostree config set</command> sets the value of
<arg choice="plain">KEYNAME</arg> in the group <arg choice="plain">GROUPNAME</arg>
to <arg choice="plain">VALUE</arg>.
</para></listitem>
<listitem><para>
<command>ostree config unset</command> removes the key
<arg choice="plain">KEYNAME</arg> from the group <arg choice="plain">GROUPNAME</arg>
so that OSTree uses the default value for it. It is not an
error for the specified <arg choice="plain">GROUPNAME</arg> or
<arg choice="plain">KEYNAME</arg> not to exist.
</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree config get core.mode</command></para>
<para>bare</para>
<para><command>$ ostree config set --group='remote "myremote"' url http://example.com/repo</command></para>
<para><command>$ ostree config unset core.lock-timeout-secs</command></para>
</refsect1>
</refentry>