Changes between Version 4 and Version 5 of NewHelpSystem


Ignore:
Timestamp:
Apr 8, 2009, 12:51:28 AM (15 years ago)
Author:
raimue (Rainer Müller)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • NewHelpSystem

    v4 v5  
    1313== Help invocation from port(1) == #invocation
    1414
    15 As previous calls for participation to enhance `port help` went unheard, I am now proposing a different system inspired by git. The documentation will be available as man pages, therefore `port help <topic>` will become an alias of `man port-<topic>`. This means it can be easily accessed from the command line. Once the man pages are also available online, a new switch `port help --web <topic>` could open the requested topic in the browser instead for users preferring websites over man pages.
     15As previous calls for participation to enhance `port help` went unheard, here is a proposasl for a totally different system inspired by git. The documentation will be available as man pages, therefore `port help <topic>` will become an alias of `man port-<topic>`. This means it can be easily accessed from the command line. Once the man pages are also available online, a new switch `port help --web <topic>` could open the requested topic in the browser instead for users preferring websites over man pages.
    1616
    1717Man pages will at least exist for all port commands, which will go into the man1 category. Some similar port commands should be covered by the same man page, such as activate/deactivate, archive/unarchive, etc. Splitting out certain topics from the current port(1) into their own man page to provide more details and examples will be considered, these will go into the man7 category.