Skip to content

Commit 4785441

Browse files
GuillaumeGomezGuillaumeGomez
committedMay 29, 2017
Update rustdoc man page
1 parent 5b13bff commit 4785441

File tree

1 file changed

+25
-39
lines changed

1 file changed

+25
-39
lines changed
 

‎man/rustdoc.1

+25-39
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH RUSTDOC "1" "September 2016" "rustdoc 1.13.0" "User Commands"
1+
.TH RUSTDOC "1" "May 2017" "rustdoc 1.19.0" "User Commands"
22
.SH NAME
33
rustdoc \- generate documentation from Rust source code
44
.SH SYNOPSIS
@@ -15,14 +15,13 @@ provides several output formats for the generated documentation.
1515

1616
.TP
1717
\fB\-r\fR, \fB\-\-input\-format\fR \fIFORMAT\fR
18-
html or json (default: inferred)
18+
rust
1919
.TP
2020
\fB\-w\fR, \fB\-\-output\-format\fR \fIFORMAT\fR
21-
html or json (default: html)
21+
html
2222
.TP
23-
\fB\-o\fR, \fB\-\-output\fR \fIOUTPUT\fR
24-
where to place the output (default: \fIdoc/\fR for html,
25-
\fIdoc.json\fR for json)
23+
\fB\-o\fR, \fB\-\-output\fR \fIOUTPUT\fR,
24+
where to place the output (default: \fIdoc/\fR for html)
2625
.TP
2726
\fB\-\-passes\fR \fILIST\fR
2827
space\[hy]separated list of passes to run (default: '')
@@ -60,55 +59,47 @@ pass arguments to the test runner
6059
\fB\-\-html\-in\-header\fR \fIFILE\fR
6160
file to add to <head>
6261
.TP
63-
\fB\-\-html\-before\-content\fR \fIFILE\fR
64-
file to add in <body>, before content
62+
\fB\-\-html\-before\-content\fR \fIFILES\fR
63+
files to include inline between <body> and the content of a rendered Markdown
64+
file or generated documentation
6565
.TP
66-
\fB\-\-html\-after\-content\fR \fIFILE\fR
67-
file to add in <body>, after content
66+
\fB\-\-markdown\-before\-content\fR \fIFILES\fR
67+
files to include inline between <body> and the content of a rendered
68+
Markdown file or generated documentation
6869
.TP
69-
\fB\-\-markdown\-css\fR \fIFILE\fR
70-
CSS files to include via <link> in a rendered Markdown file
70+
\fB\-\-html\-after\-content\fR \fIFILES\fR
71+
files to include inline between the content and </body> of a rendered
72+
Markdown file or generated documentation
73+
.TP
74+
\fB\-\-markdown\-after\-content\fR \fIFILES\fR
75+
files to include inline between the content and </body> of a rendered
76+
Markdown file or generated documentation
77+
.TP
78+
\fB\-\-markdown\-css\fR \fIFILES\fR
79+
CSS files to include via <link> in a rendered Markdown file Markdown file or
80+
generated documentation
7181
.TP
7282
\fB\-\-markdown\-playground\-url\fR \fIURL\fR
7383
URL to send code snippets to
7484
.TP
7585
\fB\-\-markdown\-no\-toc\fR
7686
don't include table of contents
7787
.TP
78-
\fB\-h\fR, \fB\-\-help\fR
79-
Print help
88+
\fB\-h\fR, \fB\-\-extend\-css\fR
89+
to redefine some css rules with a given file to generate doc with your own theme
8090
.TP
8191
\fB\-V\fR, \fB\-\-version\fR
8292
Print rustdoc's version
8393

8494
.SH "OUTPUT FORMATS"
8595

86-
The rustdoc tool can generate output in either an HTML or JSON format.
96+
The rustdoc tool can generate output in an HTML format.
8797

8898
If using an HTML format, then the specified output destination will be the root
8999
directory of an HTML structure for all the documentation.
90100
Pages will be placed into this directory, and source files will also
91101
possibly be rendered into it as well.
92102

93-
If using a JSON format, then the specified output destination will have the
94-
rustdoc output serialized as JSON into it.
95-
This output format exists to pre\[hy]compile documentation for crates,
96-
and for usage in non\[hy]rustdoc tools.
97-
The JSON output is the following hash:
98-
99-
{
100-
"schema": VERSION,
101-
"crate": ...,
102-
"plugins": ...,
103-
}
104-
105-
The schema version indicates what the structure of crate/plugins will
106-
look like.
107-
Within a schema version the structure will remain the same.
108-
The \fIcrate\fR field will contain all relevant documentation for the
109-
source being documented, and the \fIplugins\fR field will contain the
110-
output of the plugins run over the crate.
111-
112103
.SH "EXAMPLES"
113104

114105
To generate documentation for the source in the current directory:
@@ -117,11 +108,6 @@ To generate documentation for the source in the current directory:
117108
List all available passes that rustdoc has, along with default passes:
118109
$ rustdoc \-\-passes list
119110

120-
To precompile the documentation for a crate, and then use it to render html at
121-
a later date:
122-
$ rustdoc \-w json hello.rs
123-
$ rustdoc doc.json
124-
125111
The generated HTML can be viewed with any standard web browser.
126112

127113
.SH "SEE ALSO"

0 commit comments

Comments
 (0)