ExcaliburZero / jekyll-helper

A program that serves as a basic GUI for Jekyll.
MIT License
4 stars 0 forks source link

Add manual page for program #34

Closed ExcaliburZero closed 9 years ago

ExcaliburZero commented 9 years ago

Currently the program does not have a manual page that can be shown via man jekyll-helper in order to provide quick information on the program. Thus, such as page should be added.

ExcaliburZero commented 9 years ago

These pages have some information on creating manual pages:

ExcaliburZero commented 9 years ago

It looks like the file for a manual pages is written something like the following.

.TH foo 1 "14 May 1999" "version 1.0"
.SH NAME
foo - my own text editor
.SH SYNOPSIS
.B [-d] [-e] [-f
.I filename
.B ]
ExcaliburZero commented 9 years ago

It might be a good idea to see how manual pages are implemented in other programs such as Trimage.

ExcaliburZero commented 9 years ago

It looks like Trimage implements its manual page through the following:

ExcaliburZero commented 9 years ago

The manual file should probably be licensed under the GNU Free Documentation License version 3.