Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.75 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.75 KB

Manual Page Skeleton 💀

license GitHub last commit

Usage

  1. Download skeleton.x

  2. Open skeleton.x with your favourite text-editor and replace the content in lines: 1, 4, 5, 7, 8, 11, 13, 14, 16, 18, 20.

  3. Save the file and give it a new name. (Example: human.1)

  4. Compress the man page (See Example)

  1. Evaluate where to move the compressed man page

    Subdirectories for the different man page sections (Click to expand)

  2. Copy the compressed man page into the man page directory of your choice (See Example)

cp human.1.gz /usr/share/man/man1
  1. Make sure that the man page can be called by man. (See Example)

Development

To improve or suggest something simply open an issue or submit a Pull.

Contributing

  1. Fork it (https://github.com/AlexanderBodin/man-page-skeleton/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

MIT 2018 Alexander Bodin