'\" t .\" Title: DAPS .\" Author: Frank Sundermeyer .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 01/10/2020 .\" Manual: daps .\" Source: DAPS @DAPS_VERSION@ .\" Language: English .\" .TH "DAPS" "1" "01/10/2020" "DAPS @DAPS_VERSION@" "daps" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" daps-init \- A command to set up a DAPS documentation directory\&. .SH "SYNOPSIS" .HP \w'\fBdaps\-init\fR\ 'u \fBdaps\-init\fR {\-\-docdir\ \fIPATH_TO_DOC_DIR\fR} [\fIOPTIONS\fR] .SH "DESCRIPTION" .PP daps\-init is used to create a DAPS 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 DAPS\*(Aq functionality\&. .PP Specifying the project directory with \-\-docdir is mandatory, all other options are optional\&. Specifying a name for the document with \-\-name is recommended\(emit will be used in filenames\&. Setting the title of the document with \-\-title is also recommended\&. .SH "OPTIONS" .PP \-\-docdir \fIDIR\fR .RS 4 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\&. .RE .PP \-\-dapsroot \fIDIR\fR .RS 4 Specify the path to the directory where daps\-init can find the template files (directory init\-templates/)\&. This is only necessary if you have installed DAPS in a custom directory\&. Default: /usr/share/daps .RE .PP \-\-date \fIYYYY\-MM\-DD\fR .RS 4 Specify a date in the format YYYY\-MM\-DD\&. Will be used to set the publication date of the document\&. ( in the document\*(Aqs info section)\&. Default: Current date () .RE .PP \-\-docbook4 .RS 4 Create a document in DocBook 4 format (default)\&. .RE .PP \-\-docbook5 .RS 4 Create a document in DocBook 5 format\&. .RE .PP \-\-name \fINAME\fR .RS 4 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 .RE .PP \-\-productname "\fIPRODUCT\fR" .RS 4 Specify a name for the product the document describes\&. Will be used in the subtitle of the document ( in the document\*(Aqs info section)\&. .RE .PP \-\-productnumber "\fIPRODUCT_VERSION\fR" .RS 4 Specify a version for the product the document describes\&. Will be used in the subtitle of the document ( in the document\*(Aqs info section)\&. Requires \-\-productname\&. .RE .PP \-\-rootelement article|book .RS 4 DocBook root element of the example document\&. Currently supported are "book" and "article" (default)\&. .RE .PP \-\-title "\fITITLE\fR" .RS 4 Title of the document\&. Default: "DAPS Example" .RE .SH "SEE ALSO" .PP \m[blue]\fB\%https://opensuse.github.io/daps/\fR\m[] .RS 4 DAPS project homepage .RE .SH "AUTHOR" .PP \fBFrank Sundermeyer\fR <\&fsundermeyer@opensuse\&.org\&> .RS 4 Developer .RE