4 Commits

Author	SHA1	Message	Date
Ahmed El Gabri	c3f97513d6	doc: sync config file examples ... This brings the examples for configuration files in sync between the man page and the guide.	2018-05-25 06:42:05 -04:00
Andrew Gallant	f5411b992c	doc: use PATTERNFILE for -f/--file flag ... Fixes #832	2018-02-23 12:18:15 -05:00
Andrew Gallant	904c75bd30	doc: overhaul documentation ... This commit cleans up the README and splits portions of it out into a user guide (GUIDE.md) and a FAQ (FAQ.md). The README now provides a small list of documentation "quick" links to various parts of the docs. This commit also does a few other minor touchups.	2018-02-10 12:12:47 -05:00
Andrew Gallant	6553940328	doc: generate man page ... This commit uses the recent refactoring for defining flags to automatically generate a man page. This finally allows us to define the documentation for each flag in a single place. The man page is generated on every build, if and only if `asciidoc` is installed. When generated, it is placed in Cargo's `OUT_DIR` directory, which is the same place that shell completions live.	2018-02-06 12:07:59 -05:00