callbootd: Add man page, update Makefile to install man page, and update usage().

[felix.the.red_gmail.com]

Summary

Create man page for callbootd.

[maxim]

usr.sbin/bootparamd/callbootd/callbootd.8

24

You probably want to Xr bootparamd.8 here.

53

Missed comma

[ziaee]

It's been quite a long time, but adding reviewers who have worked on this codebase.

[sjg]

Looks ok - fix the items noted by maxim

[gbe]

usr.sbin/bootparamd/callbootd/callbootd.8

2

Please add a SPDX Header and a copyright notice.

56

This should something like

The ABC command / utility was written by
$NAME_OF_SRC_AUTHOR .
This manage was written by...

[felix.the.red_gmail.com]

Add SPDX header and BSD Documentation License.

[felix.the.red_gmail.com]

Updated to include recommendations. Please review.

[maxim]

LGTM

[ziaee]

usr.sbin/bootparamd/callbootd/callbootd.8

39

I don't understand the comment. It shows a different usage than is displayed in this section? I'm not familiar with the program to know which is correct.

58

style.mdoc(5) says the width should be the longest item, unless that hurts readability then it should be indent. I like to check mine at MANWIDTH=80 and MANWIDTH=59

76

Ql is quoted literal, so you don't need to quote it's arguments

[ngie]

usr.sbin/bootparamd/callbootd/callbootd.c

151–154

This is backwards: this should all be hard-tab indented per style(9).

[ziaee]

usr.sbin/bootparamd/callbootd/callbootd.8

2

The entire license for new manuals should look like this:

/*
 * Copyright (c) [year] [your name]
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

[felix.the.red_gmail.com]

I updated the license.
After re-reading the source for callbootd, I learned I was mistaken about broadcast mode.
I updated the usage function and simplified the manpage.

[imp]

usr.sbin/bootparamd/callbootd/callbootd.8

2

Also, don't put name and uear inside square [] brackets.

[maxim]

There are several EoL whitespaces. Please trim them before committing.

Also, it makes sense to wrap long lines.

Sorry for nitpicking.

[felix.the.red_gmail.com]

Remove EOL whitespace, break up long lines, remove brackets around author and year.

[maxim]

The final diff (copy&pasted)

• callbootd.8.orig 2025-06-24 20:10:46.860839000 +0000

+++ callbootd.8 2025-06-24 20:15:11.645894000 +0000
@@ -1,8 +1,8 @@
-.\"/*

• .\"* Copyright (c) 2025 Felix Johnson
• .\"*
• .\"* SPDX-License-Identifier: BSD-2-Clause
• .\"*/

+.\"
+.\" Copyright (c) 2025 Felix Johnson
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.Dd June 23, 2025
.Dt CALLBOOTD 8
.Os
@@ -89,7 +89,7 @@
was written by
.An Klas Heggemann Aq Mt [e-mail] .
.Pp
-This manpage was written by Felix Johnson
+This manual page was written by Felix Johnson
.Aq Mt [e-mail] .
.Sh BUGS
.Nm

[felix.the.red_gmail.com]

Updated copyright to remove extra characters, changed "manpage" to "manual page".

[maxim]

It looks good.

[ziaee]

usr.sbin/bootparamd/callbootd/callbootd.8

12

Nds don't get capitalized

17

Is file_id a type of argument?

[felix.the.red_gmail.com]

usr.sbin/bootparamd/callbootd/callbootd.8

17

Yes, and it's optional.

If file_id is not present, then callbootd will be in whoami mode, asking for
the client's hostname, domain, and router.

Otherwise, callbootd asks for mount paths, using file_id as a key.
The boot server maintains a list of key:value pairs for each client in /etc/bootparams.
The file_id argument is typically a short string like root, swap, data, etc.
The value is a server:/path pair for the client to use to mount the corresponding filesystem via NFS.

[ziaee]

usr.sbin/bootparamd/callbootd/callbootd.8

12

This is still not done, you can this for yourself in mdoc(7).

17

Ok, then please "Op Ar fileid" instead of Op fileid.

Also, that sounds like important information you should put in the DESCRIPTION!

63

92

Hmm use the format above, so .An goes before your name.

[ziaee]

usr.sbin/bootparamd/callbootd/callbootd.c

152

So, callbootd can not take an ip address instead of a fileid?

[ngie]

usr.sbin/bootparamd/callbootd/callbootd.c

152

This double prints callbootd (prefix), which is inconsistent with other commands.
Also, the indentation is off here (please use clang-format -i from the top-level directory). It's not perfect, but it's better than nothing.

[ziaee]

Ping

[bcr]

Is there more work on this to come @felix.the.red_gmail.com ? We would really like to see this man page in FreeBSD.
If you're to busy, we can probably finish the rest ourselves. Just wanting to make sure this is still actively being worked on. Thanks!

[ziaee]

In D48872#1327993, @bcr wrote:

Is there more work on this to come @felix.the.red_gmail.com ? We would really like to see this man page in FreeBSD.
If you're to busy, we can probably finish the rest ourselves. Just wanting to make sure this is still actively being worked on. Thanks!

+1!