[jira] [Commented] (AURORA-984) man pages for aurora client and thermos CLI

["Bill Farner (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AURORA-984?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14268787#comment-14268787 ] 

Bill Farner commented on AURORA-984:
------------------------------------

As [~benley] pointed out in AURORA-994, help2man could prove useful in fulfilling this.

http://www.gnu.org/software/help2man/

> man pages for aurora client and thermos CLI
> -------------------------------------------
>
>                 Key: AURORA-984
>                 URL: https://issues.apache.org/jira/browse/AURORA-984
>             Project: Aurora
>          Issue Type: Story
>          Components: Client, Documentation
>            Reporter: Kevin Sweeney
>            Priority: Minor
>
> I propose we introduce man pages for the aurora client similar and display them with aurora help. We get basic formatting, discoverability, and little usability improvements like starting in a PAGER. Anecdotally I feel like we'll reduce frustration by acting more like a standard unix tool.
> I'm heavily influenced by my good experience with git here, but open to suggestions. Also open to suggestions for tools to do this (extracting the output of help and running it through a converter during our build might be preferable to maintaining troff input files).



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)