5 ms·
Any Linux or BSD distro could achieve best-in-class documentation for new users by simply adding example usages for most commands to the top of their man pages.
by RandomTisk 6y ago
Any Linux or BSD distro could achieve best-in-class documentation for new users by simply adding example usages for most commands to the top of their man pages. Man pages tend to read more encyclopedias than practical guidance, and FreeBSD was no exception last I looked.
Command xyz
Common usage: xyz -s source_ip -d dest_ip:port
- wyclif 6y agoThe Arch Wiki is pretty damn good in my opinion. I don't see how FreeBSD's documentation is better, if "better" = more useful and up to date.
- tkfu 6y agoSlightly off-topic here, but you might like the tdlr project[1]! It's community-maintained, example-focused documentation for common command-line tools. Currently, there are over 1700 pages, and it's very easy to contribute new pages or improve existing ones, because it's all in simple markdown on github. (For example, [2] is the source for the tar page.) [1] https://tldr.sh/ https://tldr.sh/ [2] https://raw.githubusercontent.com/tldr-pages/tldr/master/pages/common/tar.md https://raw.githubusercontent.com/tldr-pages/tldr/master/pag...