Skip to content

Commit 72fb09a

Browse files
committed
Add manpage
1 parent 73374a5 commit 72fb09a

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

docs/man1/phpdraft.1

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
2+
.TH PHPDRAFT: "1" "May 2020" "PHPDraft: 2.2-1-g5fc9180" "User Commands"
3+
.SH NAME
4+
PHPDraft: \- manual page for PHPDraft: 2.2-1-g5fc9180
5+
.SH DESCRIPTION
6+
usage: phpdraft [<options>]
7+
.PP
8+
Parse API Blueprint files.
9+
.PP
10+
OPTIONS
11+
.TP
12+
\fB\-\-css\fR, \fB\-c\fR
13+
Specifies a CSS file to include (value is put in a link
14+
element without checking).
15+
.TP
16+
\fB\-\-debug\-json\fR
17+
Input a rendered JSON text for debugging.
18+
.TP
19+
\fB\-\-debug\-json\-file\fR
20+
Input a rendered JSON file for debugging.
21+
.TP
22+
\fB\-\-file\fR, \fB\-f\fR
23+
Specifies the file to parse.
24+
.TP
25+
\fB\-\-header_image\fR, \fB\-i\fR
26+
Specifies an image to display in the header.
27+
.TP
28+
\fB\-\-help\fR, \-?
29+
Display this help.
30+
.TP
31+
\fB\-\-javascript\fR, \fB\-j\fR
32+
Specifies a JS file to include (value is put in a script
33+
element without checking).
34+
.TP
35+
\fB\-\-online\fR, \fB\-o\fR
36+
Always use the online mode.
37+
.TP
38+
\fB\-\-sort\fR, \fB\-s\fR
39+
Sort displayed values [All|None|Structures|Webservices]
40+
(defaults to the way the objects are in the file).
41+
.TP
42+
\fB\-\-template\fR, \fB\-t\fR
43+
Specifies the template to use. (defaults to 'default').
44+
.TP
45+
\fB\-\-version\fR, \fB\-v\fR
46+
Print the version for PHPDraft.
47+
.TP
48+
\fB\-\-yes\fR, \fB\-y\fR
49+
Always accept using the online mode.
50+
.SH "SEE ALSO"
51+
The full documentation for
52+
.B PHPDraft:
53+
is maintained as a Texinfo manual. If the
54+
.B info
55+
and
56+
.B PHPDraft:
57+
programs are properly installed at your site, the command
58+
.IP
59+
.B info PHPDraft:
60+
.PP
61+
should give you access to the complete manual.

0 commit comments

Comments
 (0)