Skip to content

Conversation

flexibeast
Copy link

This PR updates the openrc-run.8 man page to note which variables are referenced by the default implementations of start() and stop().

In creating this PR, i found that the capabilities, no_new_privs and secbits variables, referenced by the default start() function, are not documented in openrc-run(8); is this intentional, or can i create a PR to address this?

@N-R-K
Copy link
Contributor

N-R-K commented Apr 10, 2025

In creating this PR, i found that the capabilities, no_new_privs and secbits variables, referenced by the default start() function, are not documented in openrc-run(8); is this intentional, or can i create a PR to address this?

I don't think this is intentional. PRs should be welcome.

This PR updates the openrc-run.8 man page to note which variables are referenced by the default implementations of start() and stop().

I like the idea, but:

  • I don't like how it's using (*) and (**), they look ugly
  • The "default" start and stop can vary based on supervisor=.

@flexibeast
Copy link
Author

I like the idea, but:

  • I don't like how it's using (*) and (**), they look ugly
  • The "default" start and stop can vary based on supervisor=.

Okay. Can you suggest an alternative way of conveying this information? (As an aside, here's the situation which led me to create this PR.)

@N-R-K
Copy link
Contributor

N-R-K commented Apr 10, 2025

I think we can have a separate section in a table format. Something like this:

.Sh DEFAULT START STOP
The following table lists all the variables that are used by the default start
and stop functions.
.Bl -column "Variable" "start\-stop\-daemon" "supervise\-daemon" "s6" -offset indent
.It Sy "Variable" Ta Sy "start\-stop\-daemon" Ta Sy "supervise\-daemon" Ta Sy "s6"
.It "pidfile"     Ta "start,stop" Ta "start,stop" Ta ""
.El

Screenshot:

image

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