The FreeBSD Project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- The FreeBSD Project
- Technical writer:
- The King of Toasters
- Project name:
- Write missing manpages, Add EXAMPLE sections to man pages
- Project length:
- Standard length (3 months)
Project description
Write missing man pages:
There is a list of missing manpages on
https://wiki.freebsd.org/MissingManpages. Start writing as many man
pages from that list as possible. With the help of your mentor, find the
author or someone who recently changed the source file that the man page
in question is about for background information and details.
Add EXAMPLE sections to man pages:
The FreeBSD man pages include in many places an EXAMPLE sections,
describing basic usage of the utility or command described therein. The
FreeBSD wiki has a list of man pages without examples (https://wiki.freebsd.org/ManPagesWithoutExamples). Add as many examples
to these man pages as possible in cases where it makes sense to have
them. Come up with a general way of introducing the command/utility in
these sections (i.e. quick start first, more advanced examples
afterwards) and apply that to man pages describing similar
utilities/commands. That way, the examples have a consistent approach
and the reader can find things easier.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[],["The FreeBSD Project, in collaboration with technical writer \"The King of Toasters,\" will undertake a technical writing project focused on man pages. The project includes creating missing man pages from a specified list, using source file authors for guidance. Additionally, the project will add EXAMPLE sections to existing man pages that lack them, following a consistent structure of introductory and then advanced examples to improve readability and usability. The project duration will be three months.\n"]]
