forked from AliceO2Group/AliceO2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrunExampleModule2.1.in
More file actions
62 lines (44 loc) · 1.52 KB
/
runExampleModule2.1.in
File metadata and controls
62 lines (44 loc) · 1.52 KB
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
.\" Manpage for runExampleModule2.
.\" this file gives some basic introduction on how to use the
.\" roff format to write man pages
.\" NOTE: all formatting commands start with a dot and must be
.\" at the beginning of the line
.\" the header section
.TH AliceO2 1 "12 May 2017" "1.0" "runExampleModule2 man page"
.\" .SH starts a new section, NAME is the first section
.SH NAME
runExampleModule2 - A simple example for AliceO2 submodules
.\" next is the SYNOPSIS section
.SH SYNOPSIS
.\" some bold formatted text
.B runExampleModule2
.\" alternate between roman and bold font, separated by blank, i.e. the
.\" square backets in roman and the option in bold
.RB [ --someoption ]
.\" same here, in addition, the dots indicating the argument string are in
.\" italic. Note: the quoted " [" makes sure there is a blank
.RB [ --debug " [" --gdb=\fI...\fR ]]
.\" italic formatting (underline in man)
.I mandatory_argument
.\" alternate roman and italic
.RI [ further_arguments... ]
.SH DESCRIPTION
runExampleModule2 is an example to demonstrate the AliceO2 cmake setup of
modules. This document illustrates creation of man pages. All options and
arument are pure fictive.
.SH OPTIONS
.\" indented paragraph with label, indentation is set to the optional number
.TP 5
.B --someoption
This is a fancy option of the example.
.TP 5
.B --debug
Run everything with debugging options
.TP 5
.B --gdb=\fI...\fR
Add additional information to run with gdb
.SH SEE ALSO
runExampleModule2(1)
http://gnustep.made-it.com/man-groff.html
.SH BUGS
No known bugs