github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/commands/hugo_genautocomplete.md
Anthony Fok f2ab0b2608 Improve formatting of Hugo command descriptions 
Trying to make them look good both in the terminal (`hugo help [command]`)
and in the web browser (http://gohugo.io/commands/).  :-)
2015-08-04 03:19:57 -06:00

2.5 KiB
Raw Blame History

date title slug url
2015-08-04T03:11:10-06:00 hugo genautocomplete hugo_genautocomplete /commands/hugo_genautocomplete/

hugo genautocomplete

Generate shell autocompletion script for Hugo

Synopsis

Generates a shell autocompletion script for Hugo.

NOTE: The current version supports Bash only. This should work for *nix systems with Bash installed.

By default, the file is written directly to /etc/bash_completion.d for convenience, and the command may need superuser rights, e.g.:

$ sudo hugo genautocomplete

Add --completionfile=/path/to/file flag to set alternative file-path and name.

Logout and in again to reload the completion scripts, or just source them in directly:

$ . /etc/bash_completion

hugo genautocomplete

Options

      --completionfile="/etc/bash_completion.d/hugo.sh": Autocompletion file
  -h, --help[=false]: help for genautocomplete
      --type="bash": Autocompletion type (currently only bash supported)

Options inherited from parent commands

  -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
      --cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
      --config="": config file (default is path/config.yaml|json|toml)
  -d, --destination="": filesystem path to write files to
      --disableRSS[=false]: Do not build RSS files
      --disableSitemap[=false]: Do not build Sitemap file
      --editor="": edit new content with this editor, if provided
      --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)
      --pluralizeListTitles[=true]: Pluralize titles in lists using inflect
      --preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
  -s, --source="": filesystem path to read files relative from
      --stepAnalysis[=false]: display memory and timing of different steps of the program
  -t, --theme="": theme to use (located in /themes/THEMENAME/)
      --uglyUrls[=false]: if true, use /filename.html instead of /filename/
  -v, --verbose[=false]: verbose output
      --verboseLog[=false]: verbose logging

SEE ALSO

  • hugo - hugo builds your site
Auto generated by spf13/cobra at 2015-08-04 09:11:10.032217938 +0000 UTC