What do think of a man page?

What are your thoughts on having a man page for jet(1) ?

A tool like this https://git.sr.ht/%7Esircmpwn/scdoc/ could be used to re-purpose the existing documentation and add it to the man page, so that it's (arguably) more accessible via man jet command, instead of "please go to https://github.com/borkdude/jet/ and read the documentation under doc directory".

Thanks

For example if you have the man page in scdoc's format:

jet(1)

# NAME

jet - tool to transform between JSON, EDN and Transit, powered with a
minimal query language.

# SYNTAX

Some more text

You'd run a command like this:

$ scdoc < jet.scd > jet.roff

To produce:

.\" Generated by scdoc 1.11.1
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "jet" "1" "2021-04-04"
.P
.SH NAME
.P
jet - tool to transform between JSON, EDN and Transit, powered with a
minimal query language.\&
.P
.SH SYNTAX
.P
Some more text

Which can be viewed via man ./jet.roff.

If placed in the correct MANPATH, it can be invoked via man jet.

See the example of how documentation looks like in a format that is required by scdoc:
https://git.sr.ht/~sircmpwn/scdoc/tree/master/item/scdoc.5.scd

I think that would be awesome. Feel free to work on this and let me know if I need to do anything.

Navigation Menu

Repository navigation

What do think of a man page? #86

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

What do think of a man page? #86

Description

Activity

dotemacs commented on Apr 4, 2021

borkdude 53A9 commented on Apr 4, 2021

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions