API tools faq
paste
Guest User

illumos man page bugs

a guest
Aug 19th, 2025
39
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 15.46 KB | Source Code | 0 0
raw download clone embed print report
  1. Our man page changes for this quarter are at:
  2. https://gist.github.com/alanc/ae834f8047eb234c68cf9b4db4a96958
  3.  
  4. My big man page project for the quarter was a cleanup pass across the
  5. section 8 man pages. Changes from those included:
  6.  
  7. - Formatting, spelling, grammar, wording, and typo fixes across many pages
  8. - Remove less useful / add more useful "See Also" entries in several pages
  9. - Add/update History sections
  10.  
  11. add_drv(8):
  12. - Note that package scripting info only applies to SVR4,
  13. and that the driver action handles this in IPS packages.
  14. - Drop 32-bit kernel info
  15.  
  16. cron(8), init(8):
  17. - Point to TZ in environ(7) for current instructions on setting the
  18. system default timezone, replacing obsolete instructions.
  19.  
  20. cron(8):
  21. - Add pointer to svc.periodicd(8) for scheduled & periodic tasks.
  22.  
  23. disks(8), vmstat(8)
  24. - Stop talking about IPI disks, since support for them was removed in
  25. Solaris 7 in 1998.
  26.  
  27. edquota(8), ff(8), fsck(8), tunefs(8), ufsdump(8):
  28. - emphasize these programs are for UFS only, not ZFS
  29.  
  30. format(8):
  31. - remove discussion of "the memory-resident system environment" which
  32. hasn't existed in decades (since boot from tape went away?)
  33. - add warning about data purge with modern storage devices
  34.  
  35. fsdb_ufs(8):
  36. - remove WARNINGS section that advises making unsupported changes to
  37. files installed by system packages
  38.  
  39. fwflash(8):
  40. - remove example that just shows usage message, since it doesn't show
  41. the current usage message, and is just going to get more out of sync
  42. over time
  43.  
  44. getty(8):
  45. - Reflect removal of /etc/getty before 11.0 GA
  46.  
  47. halt(8), init(8), reboot(8), shutdown(8):
  48. - note that sysadm(8) can block reboot with noreboot mode
  49.  
  50. init(8):
  51. - single-user mode runs sulogin(8), not /bin/su
  52.  
  53. ldm(8):
  54. - add ADI to description of migration-class2
  55.  
  56. mvdir(8):
  57. - note that this is no longer needed, users can just use mv now
  58.  
  59. reboot(8):
  60. - explain fast vs. prom reboot
  61.  
  62. sar(8):
  63. - remove /tmp/sa.adrfl, since Bonwick removed it from the code in 1991
  64.  
  65. savecore(8):
  66. - add pointer to dumpadm(8) -m to set minfree
  67.  
  68.  
  69. Fixes I see that apply to your pages as well include:
  70.  
  71. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/add_drv.8#L83
  72. - the "and" should not be bold
  73.  
  74. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/add_drv.8#L278
  75. - We don't support a "32-bit system" any longer, I thought you didn't either
  76. (and thus a subdirectory is needed in line 280, and the 32-bit directories
  77. should be removed from the FILES section).
  78.  
  79. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/add_drv.8#L285-L287
  80. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/add_drv.8#L315-L317
  81. - The whole command should be bold, not just the options
  82.  
  83. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/add_drv.8#L642
  84. - It's not really a bug that an unsupported argument results in failure.
  85.  
  86.  
  87. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/auditreduce.8#L137
  88. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/eeprom.8#L815
  89. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsdb_udfs.8#L823
  90. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ypbind.8#L66
  91. - Missing space after "."
  92.  
  93. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/auditreduce.8#L441
  94. - "Process are objects" should be "Processes ..."
  95.  
  96. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/beadm.8#L305
  97. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/beadm.8#L502
  98. - "Forcefully" seems like the wrong word here. (I went with "Forcibly".)
  99.  
  100. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/boot.8#L727
  101. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/boot.8#L801
  102. - "file" should be italic, to mark it as another argument, not a command/keyword
  103.  
  104. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/boot.8#L807-L813
  105. - The x86 systems we support today are not really IBM PC compatible, and haven't
  106. been called that in decades. They often use UEFI instead of BIOS now as well,
  107. and most no longer have "diskette" drives.
  108.  
  109. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L19
  110. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tapes.8#L15
  111. - Seems like there should be some sort of verb before "/dev". (I went with
  112. "maintaining".)
  113.  
  114. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L46-L47
  115. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/vmstat.8#L413
  116. - IPI disk support was removed years before OpenSolaris source release.
  117.  
  118. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L56
  119. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L135
  120. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L155
  121. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L210
  122. - "disks" here refers to the command and thus should be in bold text.
  123.  
  124. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/disks.8#L210
  125. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tapes.8#L169
  126. - the closing ")" should be outside of the bold markup
  127.  
  128. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/dtrace.8#L647
  129. - __SunOS_5_11 would be a better example than __SunOS_5_10 now
  130.  
  131. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/dtrace.8#L767
  132. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/dtrace.8#L770
  133. - these should say "dtrace command" instead of "proc tool"
  134.  
  135. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/eeprom.8#L75
  136. - Duplicate "of" here. (Also no mention of what case applies to your OS.)
  137.  
  138. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/format.8#L19-L23
  139. - We no longer document a "memory-resident system environment" like this.
  140. (I think that's leftover from SunOS 4.x days?)
  141.  
  142. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsck.8#L19
  143. - Missing "-" on the N, Y, and y options
  144.  
  145. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsck.8#L131
  146. - Missing "-" on the Y option
  147.  
  148. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsck.8#L177
  149. - "pre-4.1" should specify "SunOS" so people in this century know what 4.1
  150. refers to now.
  151.  
  152. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsdb_udfs.8#L39
  153. - "options are" should be "option is" since there's only one.
  154.  
  155. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsdb_udfs.8#L823
  156. - the arguments should be part of the synopsis above, not the first line of
  157. the description.
  158.  
  159. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/fsdb_ufs.8#L1217-L1222
  160. - "Suggested permissions" should be provided by the packaging system, not
  161. the man page
  162.  
  163. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/hal-device.8#L12
  164. - the -a & -r options should have only one "-", not two
  165.  
  166. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/hal-device.8#L22
  167. - the "(8)" should be outside the bold markup
  168.  
  169. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/hal-device.8#L40
  170. - "--help" should be listed as well as "-h"
  171.  
  172. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/inetd.8#L423
  173. - duplicated "that"
  174.  
  175. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/inetd.8#L540
  176. - nothing is controlled by "Sun" any more.
  177.  
  178. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/infocmp.8#L290
  179. - "TERMINFO" should be one word, with no space before the "."
  180.  
  181. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/init.8#L55
  182. - "environments" should be "environment variables"
  183.  
  184. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/init.8#L96
  185. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/init.8#L545
  186. - "su" should be "sulogin"
  187.  
  188. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/init.8#L386
  189. - missing "." at end of sentence
  190.  
  191. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L41-L42
  192. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L89-L90
  193. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L94
  194. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L110
  195. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L121
  196. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L133
  197. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/install.8#L194-L195
  198. - "file" should be italic to mark it as an argument, not a command/keyword
  199.  
  200. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L90
  201. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L179
  202. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L343
  203. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L905
  204. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tpmadm.8#L77
  205. - in syntax/synopses for commands we generally don't include the '#' prompt
  206. and mark up the command, subcommands, keywords, in bold
  207.  
  208. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L603
  209. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L617
  210. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L631
  211. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L863
  212. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L877
  213. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L891
  214. - "default to ... seconds" is awkwardly worded.
  215.  
  216. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/iscsiadm.8#L1103
  217. - "commands uses" should be "commands use"
  218.  
  219. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ldap_cachemgr.8
  220. - the page alternately calls ldap_cachemgr a "utility" or a "daemon" - I
  221. standardized on "daemon"
  222.  
  223. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ldap_cachemgr.8#L19-L20
  224. - "multi-user boot" is the pre-SMF description
  225.  
  226. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ldap_cachemgr.8#L35
  227. - "by superuser only" is awkward wording
  228.  
  229. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ldap_cachemgr.8#L94
  230. - missing "." at end of sentence
  231.  
  232. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ldap_cachemgr.8#L99
  233. - svcadm refresh is preferred over pkill -HUP in the SMF world
  234.  
  235. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/lockstat.8#L36
  236. - "example#" prompt should not be bolded
  237.  
  238. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/lockstat.8#L96
  239. - "event list" should be "event_list" to match the synopsis
  240.  
  241. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/lofiadm.8#L316
  242. - we don't really need to say "from the internet" any more, especially as
  243. many distros include mkisofs in their packages.
  244.  
  245. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/logadm.8#L144
  246. - missing space between "w" and "(weeks)"
  247.  
  248. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/logadm.8#L576
  249. - missing space between "1," and "1970"
  250.  
  251. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/mvdir.8#L18
  252. - since mvdir is just a wrapper script around mv(1) now, it's no longer
  253. limited to "within a filesystem". (We added a "NOTES" section suggesting you
  254. just use mv(1) instead of this ancient relic.)
  255.  
  256. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/mvdir.8#L18-L21
  257. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/mvdir.8#L52-L54
  258. - "dirname" should be in italic, as an argument, not bold
  259.  
  260. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/mvdir.8#L25
  261. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/mvdir.8#L31
  262. - the "example%" prompt should not be in bold
  263.  
  264. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/psrinfo.8#L37
  265. - "processor_id" should be italic
  266.  
  267. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/psrinfo.8#L186
  268. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/psrinfo.8#L199
  269. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/psrinfo.8#L199
  270. - ">" is an odd prompt for man page examples
  271.  
  272. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/reboot.8
  273. - Since the modern world is not just SPARC workstations, "the PROM monitor"
  274. is often a hypervisor or other firmware (BIOS/UEFI/etc.). We also added
  275. more explanation of fast vs. "PROM" reboot.
  276. - The '-p' option has a note that it is mutually exclusive with '-f'.
  277. The '-f' option fails to note that.
  278.  
  279. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/reboot.8#L128
  280. - missing "the" before "system/boot-config service"
  281.  
  282. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/reboot.8#L201
  283. - missing "the" before "property"
  284.  
  285. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/sar.8#L62
  286. - "dd" should be italic, as shown in the filename in this line, not bold,
  287. since it's not a reference to the dd command, but to the date characters
  288. in the filename.
  289.  
  290. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/sar.8#L82
  291. - the "." after "dd" should be outside the markup as it's the end of the
  292. sentence marker, not part of the filename.
  293.  
  294. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/sar.8#L95-L102
  295. - /tmp/sa.adrfl hasn't existed for many years before OpenSolaris source release.
  296.  
  297. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/sar.8#L107
  298. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/sar.8#L117
  299. - again, "dd" should be italic, since it's replaced by the day-of-month number
  300.  
  301. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/savecore.8#L37
  302. - "if" should be capitalized at the start of the sentence. (I also added a
  303. pointer to "dumpadm -m" to set the minfree value.)
  304.  
  305. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/syslogd.8#L37
  306. - mismatched parentheses
  307.  
  308. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tic.8#L42
  309. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tic.8#L63
  310. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tic.8#L71
  311. - "file" should be italic to mark it as an argument, not a command/keyword
  312.  
  313. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/tic.8#L72
  314. - "TERMINFO" should be one word, with no space before the "\fR"
  315.  
  316. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/ufsdump.8#L366
  317. - extra space after "("
  318.  
  319. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/vmstat.8#L214-L215
  320. - disks on systems this century do not have names starting with "xd"
  321.  
  322. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man8/zdump.8#L12
  323. - "version" in "--version" should be bold, not italic, as it's not replaceable
  324. text, but fixed text
Tags: illumos
Advertisement
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!