1 % roobuilder(SECTION) | User Commands
5 [comment]: # The lines above form a Pandoc metadata block. They must be
6 [comment]: # the first ones in the file.
7 [comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
9 [comment]: # pandoc -s -f markdown -t man package.md -o package.1
11 [comment]: # A manual page package.1 will be generated. You may view the
12 [comment]: # manual page with: nroff -man package.1 | less. A typical entry
13 [comment]: # in a Makefile or Makefile.am is:
15 [comment]: # package.1: package.md
16 [comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@
18 [comment]: # The pandoc binary is found in the pandoc package. Please remember
19 [comment]: # that if you create the nroff version in one of the debian/rules
20 [comment]: # file targets, such as build, you will need to include pandoc in
21 [comment]: # your Build-Depends control field.
23 [comment]: # Remove the lines starting with '[comment]:' in this file in order
24 [comment]: # to avoid warning messages from pandoc.
28 roobuilder - program to do something
32 **roobuilder** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
33 [{**-e** | **\-\-example**} {_this_ | _that_}]
35 **roobuilder** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
39 This manual page documents briefly the **roobuilder** and **bar** commands.
41 This manual page was written for the Debian distribution because the
42 original program does not have a manual page. Instead, it has documentation
43 in the GNU info(1) format; see below.
45 **roobuilder** is a program that...
49 The program follows the usual GNU command line syntax, with long options
50 starting with two dashes ('-'). A summary of options is included below. For
51 a complete description, see the **info**(1) files.
53 **-e** _this_, **\-\-example=**_that_
57 : Show summary of options.
59 **-v**, **\-\-version**
60 : Show version of program.
65 : The system-wide configuration file to control the behaviour of
66 roobuilder. See **foo.conf**(5) for further details.
69 : The per-user configuration file to control the behaviour of
70 roobuilder. See **foo.conf**(5) for further details.
75 : If used, the defined file is used as configuration file (see also
76 the section called “FILES”).
80 The following diagnostics may be issued on stderr:
82 Bad configuration file. Exiting.
83 : The configuration file seems to contain a broken configuration
84 line. Use the **\-\-verbose** option, to get more info.
86 **roobuilder** provides some return codes, that can be used in scripts:
89 0 Program exited successfully.
90 1 The configuration file seems to be broken.
94 The program is currently limited to only work with the foobar library.
96 The upstream BTS can be found at http://bugzilla.foo.tld.
100 **bar**(1), **baz**(1), **foo.conf**(5)
102 The programs are documented fully by The Rise and Fall of a Fooish Bar
103 available via the **info**(1) system.
107 Alan <alan@office.roojs.com>
108 : Wrote this manpage for the Debian system.
112 Copyright © 2007 Alan
114 This manual page was written for the Debian system (and may be used by
117 Permission is granted to copy, distribute and/or modify this document under
118 the terms of the GNU General Public License, Version 2 or (at your option)
119 any later version published by the Free Software Foundation.
121 On Debian systems, the complete text of the GNU General Public License
122 can be found in /usr/share/common-licenses/GPL.
124 [comment]: # Local Variables:
125 [comment]: # mode: markdown