From 4d0bdcc8c056ba282b70fba20158ae3186852591 Mon Sep 17 00:00:00 2001 From: Joe Pettersson Date: Fri, 10 Jan 2014 13:47:15 +0000 Subject: [PATCH] Update README.md to show options --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 72c295f7..48bc3735 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,32 @@ utility, you can run it like so: $ gollum --help ``` +This will show you the options you can pass as arguments to the `gollum` command: + +```bash +Options: + --port [PORT] Bind port (default 4567). + --host [HOST] Hostname or IP address to listen on (default 0.0.0.0). + --version Display current version. + --config [CONFIG] Path to additional configuration file + --irb Start an irb process with gollum loaded for the current wiki. + --css Inject custom css. Uses custom.css from root repository + --js Inject custom js. Uses custom.js from root repository + --template-dir [PATH] Specify custom template directory + --page-file-dir [PATH] Specify the sub directory for all page files (default: repository root). + --base-path [PATH] Specify the base path. + --gollum-path [PATH] Specify the gollum path. + --ref [REF] Specify the repository ref to use (default: master). + --no-live-preview Disables livepreview. + --live-preview Enables livepreview. + --allow-uploads Allows file uploads. + --mathjax Enables mathjax. + --user-icons [SOURCE] Set the history user icons. Valid values: gravatar, identicon, none. Default: none. + --show-all Shows all files in file view. By default only valid pages are shown. + --collapse-tree Collapse file view tree. By default, expanded tree is shown. + --h1-title Sets page title to value of first h1 +``` + Note that the gollum server will not run on Windows because of [an issue](https://github.com/rtomayko/posix-spawn/issues/9) with posix-spawn (which is used by Grit). ### RACK