shithub: hugo

Info  •  Files  •  Log  •  Branches

docs: getting usage up to spec

--- a/docs/content/overview/usage.md

+++ b/docs/content/overview/usage.md

@@ -15,28 +15,28 @@

 Make sure either `hugo` is in your `PATH` or provide a path to it.

 <pre><code class="hljs nohighlight">$ hugo help

-A Fast and Flexible Static Site Generator built with

-love by spf13 and friends in Go.

+	

+Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go.

 Complete documentation is available at http://gohugo.io

-Usage:

+Usage: 

   hugo [flags]

   hugo [command]

-Available Commands:

-  server      Hugo runs its own webserver to render the files

-  version     Print the version number of Hugo

-  config      Print the site configuration

-  check       Check content in the source directory

-  benchmark   Benchmark hugo by building a site a number of times

-  new         Create new content for your site

-  help        Help about any command

-Flags:

-      --noTimes=false: Don't sync modification time of files

-  -w, --watch=false: watch filesystem for changes and recreate as needed

+Available Commands: 

+  server          Hugo runs its own webserver to render the files

+  version         Print the version number of Hugo

+  config          Print the site configuration

+  check           Check content in the source directory

+  benchmark       Benchmark hugo by building a site a number of times

+  new             Create new content for your site

+  undraft         Undraft changes the content's draft status from 'True' to 'False'

+  genautocomplete Generate shell autocompletion script for Hugo

+  gendoc          Generate Markdown documentation for the Hugo CLI.

+  help            Help about any command

-Global Flags:

+Flags:

   -b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/

   -D, --buildDrafts=false: include content marked as draft

   -F, --buildFuture=false: include content with publishdate in the future

@@ -50,6 +50,7 @@

       --ignoreCache=false: Ignores the cache directory for reading but still writes to it

       --log=false: Enable Logging

       --logFile="": Log File path (if set, logging enabled automatically)

+      --noTimes=false: Don't sync modification time of files

       --pluralizeListTitles=true: Pluralize titles in lists using inflect

   -s, --source="": filesystem path to read files relative from

       --stepAnalysis=false: display memory and timing of different steps of the program

@@ -57,7 +58,12 @@

       --uglyUrls=false: if true, use /filename.html instead of /filename/

   -v, --verbose=false: verbose output

       --verboseLog=false: verbose logging

+  -w, --watch=false: watch filesystem for changes and recreate as needed

+

+Additional help topics:

+ hugo convert         Convert will modify your content to different formats hugo list            Listing out various types of content

+

 Use "hugo help [command]" for more information about a command.

 </code></pre>

@@ -153,6 +159,9 @@

     hugo server --watch \

                 --baseUrl=http://yoursite.org/ --port=80 \

                 --appendPort=false

+		--bind=87.245.198.50

+

+Note the `bind` option, which is the interface to which the server will bind (defaults to `127.0.0.1`, which is fine for most development use cases). Some hosts, like Amazon WS, runs network address translation and it can sometimes be hard to figure out the actual IP address. Using `--bind=0.0.0.0` will bind to all interfaces.

 This way, you may actually deploy just the source files,

 and Hugo on your server will generate the resulting web site