这是indexloc提供的服务，不要输入任何密码
Skip to content

Man page? #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
3 commits merged into from
Mar 8, 2014
Merged

Man page? #476

3 commits merged into from
Mar 8, 2014

Conversation

@joliv
Copy link
Contributor

@joliv joliv commented Mar 8, 2014

Is there a particular reason the dokku command doesn't have a man entry? I'd be glad to write one (although I don't have a ton of experience with makefiles) unless we're worried about polluting the environment or something. I think a man page would be really helpful. Here was my first experience with the dokku command:

$ man dokku
No manual entry for dokku
See 'man 7 undocumented' for help when manual pages are not available.
$ dokku --help
# (silent failure)
$ dokku
# (chirp chirp)
$ dokku help
    backup:export [file]                            Export dokku configuration files
    backup:import [file]                            Import dokku configuration files
    config <app>                                    display the config vars for an app
    config:get <app> KEY                            display a config value for an app
    config:set <app> KEY1=VALUE1 [KEY2=VALUE2 ...]  set one or more config vars
    config:unset <app> KEY1 [KEY2 ...]              unset one or more config vars
    delete <app>                                    Delete an application
    help            Print the list of commands
    logs <app> [-t]                                 Show the last logs for an application (-t follows)
    plugins-install Install active plugins
    plugins         Print active plugins
    run <app> <cmd>                                 Run a command in the environment of an application
    url <app>                                       Show the URL for an application
    version                                         Print dokku's version

I may be completely oblivious to some problem here, though. Thanks!

@ghost
Copy link

ghost commented Mar 4, 2014

A man page would be very welcome! Thanks for offering to write one

@colmarius
Copy link

colmarius commented Mar 5, 2014

+1

@ghost ghost added the enhancement label Mar 5, 2014
@joliv
Copy link
Contributor Author

joliv commented Mar 8, 2014

There we go.

man-dokku

That's from a clean dokku installation, btw.

Added a man page and code in the Makefile to install it. The man page is pretty much ripped from the help text, so please go ahead and clarify the syntax and descriptions if needed.

@AlJohri
Copy link
Contributor

AlJohri commented Mar 8, 2014

@joliv This looks awesome! Did you also plan to fix the silent failures?

dokku --help
dokku -h
dokku

@joliv
Copy link
Contributor Author

joliv commented Mar 8, 2014

I think I'll leave that to someone who understands the command :) I'm not really sure how the dokku command decides what arguments are valid when they aren't listed in the file. It seems like it runs through /var/lib/dokku/plugins/*/commands but I'm pretty lost.

ghost pushed a commit that referenced this pull request Mar 8, 2014
Merge pull request #476 from joliv/master
a9af04d 
Man page
@ghost ghost merged commit a9af04d into dokku:master Mar 8, 2014
@ghost
Copy link

ghost commented Mar 8, 2014

Thanks!

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

type: enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@joliv @colmarius @AlJohri