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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*
Copyright (C) CFEngine AS
This file is part of CFEngine 3 - written and maintained by CFEngine AS.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; version 3.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
To the extent this program is licensed as part of the Enterprise
versions of CFEngine, the applicable Commercial Open Source License
(COSL) may apply to this file if you as a licensee so wish it. See
included file COSL.txt.
*/
#include <man.h>
#include <string_lib.h>
#include <time.h>
static void WriteCopyright(Writer *out)
{
static const char *const copyright =
".\\\"Copyright (C) CFEngine AS\n"
".\\\"\n"
".\\\"This file is part of CFEngine 3 - written and maintained by CFEngine AS.\n"
".\\\"\n"
".\\\"This program is free software; you can redistribute it and/or modify it\n"
".\\\"under the terms of the GNU General Public License as published by the\n"
".\\\"Free Software Foundation; version 3.\n"
".\\\"\n"
".\\\"This program is distributed in the hope that it will be useful,\n"
".\\\"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
".\\\"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
".\\\"GNU General Public License for more details.\n"
".\\\"\n"
".\\\"You should have received a copy of the GNU General Public License\n"
".\\\"along with this program; if not, write to the Free Software\n"
".\\\"Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA\n"
".\\\"\n"
".\\\"To the extent this program is licensed as part of the Enterprise\n"
".\\\"versions of CFEngine, the applicable Commercial Open Source License\n"
".\\\"(COSL) may apply to this file if you as a licensee so wish it. See\n"
".\\\"included file COSL.txt.\n";
WriterWrite(out, copyright);
}
static void WriteHeader(Writer *out, const char *program, time_t last_modified)
{
char program_upper[256] = { 0 };
snprintf(program_upper, 255, "%s", program);
ToUpperStrInplace(program_upper);
char date_modified[20] = { 0 };
{
struct tm t;
gmtime_r(&last_modified, &t);
strftime(date_modified, 19, "%Y-%m-%d", &t);
}
WriterWriteF(out, ".TH %s 8 \"%s\" \"CFEngine\" \"System Administration\"\n", program_upper, date_modified);
}
static void WriteAvailability(Writer *out, const char *program)
{
static const char *const availability =
".SH AVAILABILITY\n"
"%s is part of CFEngine.\n"
".br\n"
"Binary packages may be downloaded from http://cfengine.com/downloads/.\n"
".br\n"
"The source code is available at http://github.com/cfengine/\n";
WriterWriteF(out, availability, program);
}
static void WriteAuthor(Writer *out)
{
static const char *const author =
".SH AUTHOR\n"
"Mark Burgess and CFEngine AS\n";
WriterWrite(out, author);
}
static void WriteName(Writer *out, const char *program, const char *short_description)
{
static const char *const author =
".SH NAME\n"
"%s \\- %s\n";
WriterWriteF(out, author, program, short_description);
}
static void WriteSynopsis(Writer *out, const char *program, bool accepts_file_argument)
{
static const char *const synopsis =
".SH SYNOPSIS\n"
".B %s\n"
".RI [ OPTION ]...\n";
WriterWriteF(out, synopsis, program);
if (accepts_file_argument)
{
WriterWrite(out, ".RI [ FILE ]\n");
}
else
{
WriterWrite(out, "\n");
}
}
static void WriteDescription(Writer *out, const char *description)
{
WriterWriteF(out, ".SH DESCRIPTION\n%s\n", description);
}
static void WriteOptions(Writer *out, const struct option options[],
const char *const option_hints[])
{
WriterWrite(out, ".SH OPTIONS\n");
for (int i = 0; options[i].name != NULL; i++)
{
if (options[i].has_arg)
{
WriterWriteF(out, ".IP \"--%s, -%c\" \n%s\n", options[i].name, (char) options[i].val, option_hints[i]);
}
else
{
WriterWriteF(out, ".IP \"--%s, -%c\"\n%s\n", options[i].name, (char) options[i].val, option_hints[i]);
}
}
}
static void WriteSeeAlso(Writer *out)
{
static const char *const see_also =
".SH \"SEE ALSO\"\n"
".BR cf-promises (8),\n"
".BR cf-agent (8),\n"
".BR cf-serverd (8),\n"
".BR cf-execd (8),\n"
".BR cf-monitord (8),\n"
".BR cf-runagent (8),\n"
".BR cf-key (8)\n";
WriterWrite(out, see_also);
}
static void WriteBugs(Writer *out)
{
static const char *const bugs =
".SH BUGS\n"
"Please see the public bug-tracker at http://bug.cfengine.com/.\n"
".br\n"
"GitHub pull-requests may be submitted to http://github.com/cfengine/core/.\n";
WriterWrite(out, bugs);
}
static void WriteCFEngine(Writer *out)
{
static const char *const cfengine =
".SH CFENGINE\n"
"CFEngine provides automated configuration management of large-scale computer systems. A system administrator "
"describes the desired state of a system using CFEngine policy code. The program \\fBcf-agent\\fR reads policy code "
"and attempts to bring the current system state to the desired state described. Policy code is downloaded by "
"\\fBcf-agent\\fR from a \\fBcf-serverd\\fR daemon. The daemon \\fBcf-execd\\fR is responsible for running "
"\\fBcf-agent\\fR periodically.\n"
".br\n"
"Documentation for CFEngine is available at http://cfengine.com/documentation/.\n";
WriterWrite(out, cfengine);
}
static void WritePromiseTheory(Writer *out)
{
static const char *const promise_theory =
".SH PROMISE THEORY\n"
"CFEngine is built on principles from promise theory, proposed by Mark Burgess in 2004. "
"Promise theory is a model of voluntary cooperation between individual, autonomous "
"actors or agents who publish their intentions to one another in the form of promises. "
"A promise is a declaration of intent whose purpose is to increase the recipient's certainty "
"about a claim of past, present or future behaviour. For a promise to increase certainty, "
"the recipient needs to trust the promiser, but trust can also be built on the verification "
"that previous promises have been kept, thus trust plays a symbiotic relationship with promises. \n"
".br\n"
"For an introduction to promise theory, please see http://arxiv.org/abs/0810.3294/\n";
WriterWrite(out, promise_theory);
}
void ManPageWrite(Writer *out, const char *program, time_t last_modified,
const char *short_description, const char *long_description,
const struct option options[],
const char *const option_hints[], bool accepts_file_argument)
{
WriteCopyright(out);
WriteHeader(out, program, last_modified);
WriteName(out, program, short_description);
WriteSynopsis(out, program, accepts_file_argument);
WriteDescription(out, long_description);
WriteOptions(out, options, option_hints);
WriteCFEngine(out);
WritePromiseTheory(out);
WriteAvailability(out, program);
WriteBugs(out);
WriteSeeAlso(out);
WriteAuthor(out);
}
|
