diff options
author | Guido Günther <agx@sigxcpu.org> | 2014-04-01 20:29:22 +0200 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2014-04-01 22:42:13 +0200 |
commit | 4c6b06773876a35f55f8f5667af65a917f823757 (patch) | |
tree | 8623bdccf7d7d1a0d559bdb8f38dae4af0e652f0 /docs/manpages | |
parent | 03ada72d54480917c75e05568844e3f596e2cb64 (diff) |
Add minimal 'config' command
This only allows to print single config values so far.
Closes: #733470
Diffstat (limited to 'docs/manpages')
-rw-r--r-- | docs/manpages/gbp-config.sgml | 109 | ||||
-rw-r--r-- | docs/manpages/manpages.ent | 1 |
2 files changed, 110 insertions, 0 deletions
diff --git a/docs/manpages/gbp-config.sgml b/docs/manpages/gbp-config.sgml new file mode 100644 index 0000000..c07d758 --- /dev/null +++ b/docs/manpages/gbp-config.sgml @@ -0,0 +1,109 @@ +<refentry id="man.gbp.config"> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + </refentryinfo> + <refmeta> + <refentrytitle>gbp-config</refentrytitle> + &dhsection; + </refmeta> + <refnamediv> + <refname>gbp-config</refname> + + <refpurpose>Query configuration values</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + &gbp-config; + + <arg><option>--verbose</option></arg> + <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg> + <arg choice="plain"><replaceable>command.option</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + <para> + &gbp-config; prints values from the configuration files. It interpolates the + value for <replaceable>option</replaceable> of + <replaceable>command</replaceable>. + </para> + </refsect1> + <refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>--verbose</option></term> + <term><option>-v</option></term> + <listitem> + <para>verbose execution</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--color=</option><replaceable>[auto|on|off]</replaceable> + </term> + <listitem> + <para>Whether to use colored output.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>EXIT CODES</title> + <para> + When &gbp-config finishes it indicates success or failure with its exit code: + </para> + <variablelist> + <varlistentry> + <term><option>0</option></term> + <listitem> + <para>Success.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>1</option></term> + <listitem> + <para>Failed to parse command line</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>2</option></term> + <listitem> + <para>The value did not exist</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>EXAMPLES</title> + <para>Print the value <option>upstream-branch</option> that &gbp-buildpackage; + would use:</para> + <screen> + $ gbp config buildpackage.upstream-branch + upstream + </screen> + </refsect1> + <refsect1> + &man.gbp.config-files; + </refsect1> + <refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>gbp.conf</refentrytitle> + &dhconfsection; + </citerefentry> + </para> + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>&dhusername; &dhemail;</para> + + </refsect1> +</refentry> diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent index 3aee1de..d588254 100644 --- a/docs/manpages/manpages.ent +++ b/docs/manpages/manpages.ent @@ -2,6 +2,7 @@ <!ENTITY man.gbp.importdsc SYSTEM "gbp-import-dsc.sgml"> <!ENTITY man.gbp.importdscs SYSTEM "gbp-import-dscs.sgml"> <!ENTITY man.gbp.buildpackage SYSTEM "gbp-buildpackage.sgml"> +<!ENTITY man.gbp.config SYSTEM "gbp-config.sgml"> <!ENTITY man.gbp.dch SYSTEM "gbp-dch.sgml"> <!ENTITY man.gbp SYSTEM "gbp.sgml"> <!ENTITY man.gbp.pull SYSTEM "gbp-pull.sgml"> |