Skip to content

Commit 4d31700

Browse files
author
Chris Thorn
committed
Update rustdoc man page
Brings the rustdoc man page in sync with the options specified in src/librustdoc/lib.rs. The text was taken verbatim, but I tweaked the order to be (what I think is) somewhat logical.
1 parent 89c4e37 commit 4d31700

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

man/rustdoc.1

+30
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,27 @@ space-separated list of plugins to run (default: '')
3535
--plugin-path <val>
3636
directory to load plugins from (default: /tmp/rustdoc_ng/plugins)
3737
.TP
38+
--target <val>
39+
target triple to document
40+
.TP
41+
--crate-name <val>
42+
specify the name of this crate
43+
.TP
3844
-L --library-path <val>
3945
directory to add to crate search path
4046
.TP
47+
--cfg <val>
48+
pass a --cfg to rustc
49+
.TP
50+
--extern <val>
51+
pass an --extern to rustc
52+
.TP
53+
--test
54+
run code examples as tests
55+
.TP
56+
--test-args <val>
57+
pass arguments to the test runner
58+
.TP
4159
--html-in-header <val>
4260
file to add to <head>
4361
.TP
@@ -47,8 +65,20 @@ file to add in <body>, before content
4765
--html-after-content <val>
4866
file to add in <body>, after content
4967
.TP
68+
--markdown-css <val>
69+
CSS files to include via <link> in a rendered Markdown file
70+
.TP
71+
--markdown-playground-url <val>
72+
URL to send code snippets to
73+
.TP
74+
--markdown-no-toc
75+
don't include table of contents
76+
.TP
5077
-h, --help
5178
Print help
79+
.TP
80+
-V, --version
81+
Print rustdoc's version
5282

5383
.SH "OUTPUT FORMATS"
5484

0 commit comments

Comments
 (0)