Bug 282279 - The rc(8) scripts 'netif' or 'routing' should have man pages
Summary: The rc(8) scripts 'netif' or 'routing' should have man pages
Status: New
Alias: None
Product: Base System
Classification: Unclassified
Component: bin (show other bugs)
Version: 14.1-RELEASE
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-10-22 22:12 UTC by Slawomir Wojciech Wojtczak
Modified: 2024-10-23 14:57 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Slawomir Wojciech Wojtczak 2024-10-22 22:12:14 UTC
The rc(8) 'netif' and 'routing' scripts could/should have at least some basic man(1) page.

Even people that are quite long into FreeBSD does not really get all the stuff they do:
- https://mastodon.bsd.cafe/@mms/113353330603293053

Regards,
vermaden
Comment 1 Alexander Ziaee freebsd_triage 2024-10-23 02:10:05 UTC
I have a draft dated June 16th but gave up because 1. (Afaict) no rc.d scripts have manpages and 2. I'm not even close to qualified to write this.

I would like to mention a caveat that local internet operations like attaching graphical console to a bhyve on the same machine, or using musicpd, will fail if netif is stopped.

Service routing restart isn't necessary at least on dhcp wifi. I don't fully understand what's going on there, but I did have to remove it from wifi(7) because it does break things on some setups.
Comment 2 Slawomir Wojciech Wojtczak 2024-10-23 05:45:24 UTC
IMHO it does not have to be 'separate' man pages - it may be something like 'rc-roles' or rc-scripts' or 'rc-services' ... that would be probably good way to start - and more and more service names could be added to it later.
Comment 3 Tomoaki AOKI 2024-10-23 13:01:08 UTC
(In reply to Slawomir Wojciech Wojtczak from comment #2)
+1.
And possibly, including in service (8) would be a candidate, too.
Because rc.d scripts are manipulated by service (8) at run time.
Comment 4 Slawomir Wojciech Wojtczak 2024-10-23 14:57:36 UTC
I will try to write this man page and we will see how it will go - give me some time.

For a start I will cover these:

How this relates to rc(8) and service(8).

Scripts I plan to cover for a start:
- netif
- dhclient
- routing
- bridge
- ctld
- devd
- devfs
- hastd
- iscsictl
- iscsid
- local
- moused
- nfsclient
- nfsd
- ntpd
- ntpdate
- power_profile
- powerd
- rctl
- sshd
- sysctl

Regards,
vermaden