alertmanager/cmd/amtool/README.md
Calle Pettersson 608848390f Switch amtool to kingpin (#976)
* Switch cmd/amtool to kingpin

* Touch-ups

* Implement long help

* Add missing short-form of --output

* Fix backwards compatibility for config file options

* Fix vendoring

* Review fixes

* Fix flag word order
2017-12-22 11:17:13 +01:00

21 lines
574 B
Markdown

# Generating amtool artifacts
Amtool comes with the option to create a number of ease-of-use artifacts that can be created.
## Shell completion
A bash completion script can be generated by calling `amtool --completion-script-bash`.
The bash completion file can be added to `/etc/bash_completion.d/`.
## Man pages
A man page can be generated by calling `amtool --help-man`.
Man pages can be added to the man directory of your choice
amtool --help-man > /usr/local/share/man/man1/amtool.1
sudo mandb
Then you should be able to view the man pages as expected.