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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd"
[
<!ENTITY daps_init "daps-init">
<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
<!-- Needed for GitHub Action, see openSUSE/daps#586 -->
<!ENTITY % isopub PUBLIC
"ISO 8879:1986//ENTITIES Publishing//EN//XML"
"http://www.w3.org/2003/entities/iso8879/isopub.ent">
%isopub;
]>
<refentry lang="en" id="daps_init">
<refentryinfo>
<productname>&dapsacr;</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Frank</firstname>
<surname>Sundermeyer</surname>
<email>fsundermeyer@opensuse.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>&dapsacr;</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="date"><?dbtimestamp format="Y B d"?></refmiscinfo>
<refmiscinfo class="version">&dapsversion;</refmiscinfo>
<refmiscinfo class="manual">&daps;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&daps_init;</refname>
<refpurpose>
A command to set up a &dapsacr; documentation directory.
</refpurpose>
</refnamediv>
<refsynopsisdiv id="daps_init.synopsis">
<title>Synopsis</title>
<cmdsynopsis>
<command>&daps_init;</command>
<arg choice="req">--docdir <replaceable>PATH_TO_DOC_DIR</replaceable></arg>
<arg choice="opt"><replaceable>OPTIONS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
&daps_init; is used to create a &dapsacr; documentation project from
scratch. It automatically sets up the key files and directory structure
needed and creates an example DocBook 4 or 5 document which can be used to
explore &dapsacr;' functionality.
</para>
<para>
Specifying the project directory with --docdir is mandatory, all other
options are optional. Specifying a name for the document with --name
is recommended—it will be used in filenames. Setting the title of the
document with --title is also recommended.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term>--docdir <replaceable>DIR</replaceable></term>
<listitem>
<para>
Path to the project directory under which the DAPS environment will be
set up. If the directory does not exists, it will be created. Mandatory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--dapsroot <replaceable>DIR</replaceable></term>
<listitem>
<para>
Specify the path to the directory where &daps_init; can find the
template files (directory <filename>init-templates/</filename>). This is
only necessary if you have installed DAPS in a custom
directory. Default: <filename>/usr/share/daps</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--date <replaceable>YYYY-MM-DD</replaceable></term>
<listitem>
<para>
Specify a date in the format YYYY-MM-DD. Will be used to set the
publication date of the document. (<date/> in the document's info
section). Default: Current date (<?dbtimestamp format=\"B d, Y\"?>)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--docbook4</term>
<listitem>
<para>
Create a document in DocBook 4 format (default).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--docbook5</term>
<listitem>
<para>
Create a document in DocBook 5 format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--name <replaceable>NAME</replaceable></term>
<listitem>
<para>
String that will be used in filenames (e.g. when generating PDF or HTML
output). Only use letters, digits, dashes and underscores [A-Za-z0-9-_].
Default: daps-example
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--productname "<replaceable>PRODUCT</replaceable>"</term>
<listitem>
<para>
Specify a name for the product the document describes. Will be used in
the subtitle of the document (<productname/> in the document's
info section).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--productnumber "<replaceable>PRODUCT_VERSION</replaceable>"</term>
<listitem>
<para>
Specify a version for the product the document describes. Will be used
in the subtitle of the document (<productnumber/> in the
document's info section). Requires --productname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--rootelement article|book</term>
<listitem>
<para>
DocBook root element of the example document. Currently supported are
"book" and "article" (default).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>--title "<replaceable>TITLE</replaceable>"</term>
<listitem>
<para>
Title of the document. Default: "DAPS Example"
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="daps_init.moreinfo">
<title>See Also</title>
<variablelist>
<varlistentry>
<term>
&dapsurl;
</term>
<listitem>
<para>DAPS project homepage</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
|
