p/sdn
1
1
Fork 0
Code Issues 2 Pull Requests Releases 1 Wiki Activity

Write a manual page #1

New Issue
Closed
opened 2020-10-10 21:43:48 +02:00 by p · 1 comment
p commented 2020-10-10 21:43:48 +02:00
Owner
Copy Link

Use Asciidoctor, see json-rpc-shell and pdf-simple-sign for examples.

Try to move content from README.adoc.

Examples of manpages written in AsciiDoc:
https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/man/asciidoctor.adoc
https://github.com/git/git/tree/master/Documentation

May also consider mdoc, so that dependencies aren't excessively large.

Use Asciidoctor, see json-rpc-shell and pdf-simple-sign for examples. Try to move content from README.adoc. Examples of manpages written in AsciiDoc: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/man/asciidoctor.adoc https://github.com/git/git/tree/master/Documentation May also consider mdoc, so that dependencies aren't excessively large.
p self-assigned this 2020-10-10 21:44:26 +02:00
p commented 2020-10-26 21:01:31 +01:00
Author
Owner
Copy Link

Now that df046bb has landed, I'm not sure how to proceed. It's extremely painful to write manuals this way, so I'm likely to finish the job with Asciidoctor, as usual. Right now, it's nice to have any manual at all but the current one only lists critically important information.

Now that df046bb has landed, I'm not sure how to proceed. It's extremely painful to write manuals this way, so I'm likely to finish the job with Asciidoctor, as usual. Right now, it's nice to have any manual at all but the current one only lists critically important information.
p closed this issue 2020-10-27 04:20:07 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
WIP

   
easy

   
priority
No Label
WIP
easy
priority
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
p
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: p/sdn#1
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?