Use help2man to automatically generate man pages
This commit is contained in:
2
Makefile
2
Makefile
@@ -35,7 +35,7 @@ copyfiles: addman
|
|||||||
|
|
||||||
addman:
|
addman:
|
||||||
mkdir -p /usr/local/share/man/man1
|
mkdir -p /usr/local/share/man/man1
|
||||||
cp dokku.1 /usr/local/share/man/man1/dokku.1
|
help2man -Nh help -v version -n "configure and get information from your dokku installation" -o /usr/local/share/man/man1/dokku.1 dokku
|
||||||
mandb
|
mandb
|
||||||
|
|
||||||
version:
|
version:
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
apt-get update
|
apt-get update
|
||||||
apt-get install -qq -y git make curl software-properties-common man-db
|
apt-get install -qq -y git make curl software-properties-common man-db help2man
|
||||||
|
|
||||||
[[ $(lsb_release -sr) == "12.04" ]] && apt-get install -qq -y python-software-properties
|
[[ $(lsb_release -sr) == "12.04" ]] && apt-get install -qq -y python-software-properties
|
||||||
|
|
||||||
|
|||||||
96
dokku.1
96
dokku.1
@@ -1,96 +0,0 @@
|
|||||||
.TH DOKKU 1 2015-1-15
|
|
||||||
.\"Make sure to change that date when you commit a change!
|
|
||||||
.\"
|
|
||||||
.SH NAME
|
|
||||||
dokku \- configure and get information from your dokku installation
|
|
||||||
.\"
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.B dokku
|
|
||||||
.I <command>
|
|
||||||
.\"
|
|
||||||
.SH DESCRIPTION
|
|
||||||
.B dokku
|
|
||||||
is a catch-all command to configure your apps,
|
|
||||||
work with plugins and inspect the current state of your server.
|
|
||||||
.\"
|
|
||||||
.SH OPTIONS
|
|
||||||
.TP
|
|
||||||
.BI apps:create " <app>"
|
|
||||||
Create a new app.
|
|
||||||
.TP
|
|
||||||
.BI apps:destroy " <app>"
|
|
||||||
Permanantly destroy an app.
|
|
||||||
.TP
|
|
||||||
.B apps
|
|
||||||
List your apps.
|
|
||||||
.TP
|
|
||||||
.BI backup:import " file"
|
|
||||||
Import dokku config files.
|
|
||||||
.TP
|
|
||||||
.BI backup:export " file"
|
|
||||||
Export dokku config files.
|
|
||||||
.TP
|
|
||||||
.BI config " <app>"
|
|
||||||
Display the config vars for an app.
|
|
||||||
.TP
|
|
||||||
.BI config:get " <app> KEY"
|
|
||||||
Display a specific config var for an app.
|
|
||||||
.TP
|
|
||||||
.BI config:set " <app> KEY1=VAL1" \fR\ (KEY2=VAL2\ \.\.\.)
|
|
||||||
Set one or more config vars for an app.
|
|
||||||
.TP
|
|
||||||
.BI config:unset " <app> KEY1" \fR\ (KEY2\ \.\.\.)
|
|
||||||
Remove one or more config vars from an app.
|
|
||||||
.TP
|
|
||||||
.BI domains " <app>"
|
|
||||||
List custom domains for an app.
|
|
||||||
.TP
|
|
||||||
.BI domains:add " <app> DOMAIN"
|
|
||||||
Add a custom domain to an app.
|
|
||||||
.TP
|
|
||||||
.BI domains:remove " <app> DOMAIN"
|
|
||||||
Remove a custom domain from an app.
|
|
||||||
.TP
|
|
||||||
.BI domains:clear " <app>"
|
|
||||||
Clear all custom domains for an app.
|
|
||||||
.TP
|
|
||||||
.B help
|
|
||||||
Print the list of commands.
|
|
||||||
.TP
|
|
||||||
.B logs \ \fI<app> \fR[\fI-t\fR]
|
|
||||||
Show the last logs for an application (-t follows)
|
|
||||||
.TP
|
|
||||||
.BI nginx:build-config " <app>"
|
|
||||||
(Re)builds nginx config for an app.
|
|
||||||
.TP
|
|
||||||
.BI nginx:import-ssl " <app>"
|
|
||||||
Imports a tarball from stdin which should contain
|
|
||||||
server\.crt and server\.key
|
|
||||||
.TP
|
|
||||||
.B plugins-install
|
|
||||||
Install active plugins.
|
|
||||||
.TP
|
|
||||||
.B plugins-update
|
|
||||||
Update active plugins.
|
|
||||||
.TP
|
|
||||||
.B plugins
|
|
||||||
Print active plugins.
|
|
||||||
.TP
|
|
||||||
.BI run " <app> command"
|
|
||||||
Run a command in the environment of an app.
|
|
||||||
.TP
|
|
||||||
.BI url " <app>"
|
|
||||||
Show the first URL for an application (compatibility).
|
|
||||||
.TP
|
|
||||||
.BI urls " <app>"
|
|
||||||
Show all URLs for an application.
|
|
||||||
.TP
|
|
||||||
.B version
|
|
||||||
Print dokku's version.
|
|
||||||
.\"
|
|
||||||
.SH NOTES
|
|
||||||
This man page does not include commands added
|
|
||||||
by non-default plugins. To see the full list
|
|
||||||
of commands available to your current dokku
|
|
||||||
installation, run \fBdokku help\fR. Man page
|
|
||||||
last updated for dokku 0.3.13.
|
|
||||||
Reference in New Issue
Block a user