docs/manpages/gbp-config.sgml


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

<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><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></arg>
      <group choice='req'>
	<arg choice="plain"><replaceable>command.option</replaceable></arg>
	<arg choice="plain"><replaceable>command</replaceable></arg>
      </group>
    </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>
      <varlistentry>
        <term><option>--color-scheme</option>=<replaceable>COLOR_SCHEME</replaceable></term>
        <listitem>
          <para>
          Colors to use in output (when color is enabled). The format for
          COLOR_SCHEME is
          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
          Numerical values and color names are accepted, empty fields imply
          the default color. For example --git-color-scheme='cyan:34::' would
          show debug messages in cyan, info messages in blue and other messages
          in default (i.e. warning and error messages in red).
          </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
    buildpackage.upstream-branch=upstream
    </screen>
    <para>Print the values of all of &gbp-buildpackage;s options</para>
    <screen>
    $ gbp config buildpackage
    buildpackage.upstream-branch=upstream
    buildpackage.debian-branch=master
    ...
    </screen>
  </refsect1>
  <refsect1>
      &man.gbp.config-files;
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <xref linkend="man.gbp.conf">
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhusername; &dhemail;</para>

  </refsect1>
</refentry>