BOS_HELP(8)

✨ BOS_HELP(8) β€” bestie edition ✨

okay so this is a page from the AFS Command Reference manual, section 8, and it's literally just about one little command that hands you the answers. no cap, it's giving "study guide energy" and honestly? iconic. πŸ’–


πŸ’… NAME πŸ’…

bos_help β€” displays help for bos commands

πŸ¦‹ SYNOPSIS πŸ¦‹

bos help [-topic <help string>+] [-help]

bos h [-t <help string>+] [-h]

🌸 DESCRIPTION 🌸

The bos help command shows you the complete online help entry β€” that's the short description plus the syntax statement β€” for every command operation code you name in the -topic argument. 🫢

But bestie, if you just leave -topic out? Then the output gives you the first line (name + short description) of the online help entry for every single bos command. like, the whole squad. no filter. ✨

heads up! if what you actually want is to search β€” to list every bos command whose name or short description has a specific keyword in it β€” you want the bos apropos command instead, not this one. don't get it twisted. 😭

πŸ‘‘ OPTIONS πŸ‘‘

  • -topic <help string>+ β€” tells it which command(s) you want the full online help entry for. important: drop the bos part of the name and give it only the operation code (so like, type status, not bos status). and if you just don't pass this argument at all, the output will briefly describe every bos command. πŸ’€
  • -help β€” prints the online help for this command. all the other valid options get ignored, periodt. πŸ™ˆ

πŸ’– OUTPUT πŸ’–

The online help entry for each bos command is made up of two or three lines, and they're each doing their own lil thing:

  • The first line names the command and briefly describes what its function is. ✨
  • The second line lists the aliases for the command, if there even are any.
  • And the final line β€” which starts with the string "Usage" β€” lists the command's options in the prescribed order. these online help entries use the same symbols (brackets and all that) as the reference pages in this document, so you already know the vibe. πŸŽ€

πŸ“ EXAMPLES πŸ“

this command right here displays the online help entry for the bos status command, and honestly? it ate. πŸ”₯

% bos help status
bos status: show server instance status
Usage: bos status -server <machine name> [-instance <server
process name>+] [-long] [-cell <cell name>] [-noauth]
[-localauth] [-help]

🌈 PRIVILEGE REQUIRED 🌈

None. zero. nada. you need literally no special access, queen. πŸ‘‘

⭐ SEE ALSO ⭐

bos(8), bos_apropos(8)

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.


and that's the whole thing! this OpenAFS page is dated 2026-07-27 and it lives in BOS_HELP(8). mwah, go read your help entries bestie πŸ’‹βœ¨πŸ¦‹

πŸ“¦ where this page comes from