about summary refs log tree commit diff
diff options
context:
space:
mode:
authorChris Thorn <thorn@thoughtbot.com>2015-01-17 11:45:59 -0800
committerChris Thorn <thorn@thoughtbot.com>2015-01-17 11:45:59 -0800
commit4d31700067e5bc549b475e4b2560657b8483003f (patch)
tree148d174306f4868f49cc418f5925eba4b8a5c052
parent89c4e3792ddc5b45706ea0e919806a248f7a87c3 (diff)
downloadrust-4d31700067e5bc549b475e4b2560657b8483003f.tar.gz
rust-4d31700067e5bc549b475e4b2560657b8483003f.zip
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.
-rw-r--r--man/rustdoc.130
1 files changed, 30 insertions, 0 deletions
diff --git a/man/rustdoc.1 b/man/rustdoc.1
index 4c6557f0f65..830884b19bd 100644
--- a/man/rustdoc.1
+++ b/man/rustdoc.1
@@ -35,9 +35,27 @@ space-separated list of plugins to run (default: '')
 --plugin-path <val>
 directory to load plugins from (default: /tmp/rustdoc_ng/plugins)
 .TP
+--target <val>
+target triple to document
+.TP
+--crate-name <val>
+specify the name of this crate
+.TP
 -L --library-path <val>
 directory to add to crate search path
 .TP
+--cfg <val>
+pass a --cfg to rustc
+.TP
+--extern <val>
+pass an --extern to rustc
+.TP
+--test
+run code examples as tests
+.TP
+--test-args <val>
+pass arguments to the test runner
+.TP
 --html-in-header <val>
 file to add to <head>
 .TP
@@ -47,8 +65,20 @@ file to add in <body>, before content
 --html-after-content <val>
 file to add in <body>, after content
 .TP
+--markdown-css <val>
+CSS files to include via <link> in a rendered Markdown file
+.TP
+--markdown-playground-url <val>
+URL to send code snippets to
+.TP
+--markdown-no-toc
+don't include table of contents
+.TP
 -h, --help
 Print help
+.TP
+-V, --version
+Print rustdoc's version
 
 .SH "OUTPUT FORMATS"