Skip to content

wip: new manpage docs - #1092

Open
navi-desu wants to merge 3 commits into
masterfrom
mandocs
Open

navi-desu wants to merge 3 commits into
masterfrom
mandocs

Conversation

@navi-desu

Copy link
Copy Markdown
Member

those are also aimed to be rendered to html as static online docs later

.Dd $Mdocdate$
.Dt openrc-intro 7
.Os

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mandoc will render these empty lines as empty lines, so the man page has lots of empty lines.

Use a line with . instead, which yields the visual separation that you want in the source without affecting how the page is rendered.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, mandb ignores them (which i was using to test) but mandoc proper doesn't, wonderful

will fix

.Os

.Sh NAME
.Nm openrc-intro

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

File name does not match this name.

Comment on lines +15 to +20
openrc requires that every service provides the
.Ic start Ns () ,
.Ic stop Ns () ,
and
.Ic status Ns ()
commands.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a misleading start if the next paragraph indicates that users shouldn't define custom start/stop for the common case.

When should these actually be defined by the user?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that was meant to be covered by Do not define custom start or stop functions for managing daemons, though i see what you mean

we could have it say openrc always provides start(), stop() and status() commands to every service, then add a section later going more in detail about custom commands?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants