Timo wrote:
> Hi who is responsible for writing documentation for OpenBSD? I'd like
> to get involved in writing documentation for OpenBSD as I really like
> OpenBSD and I feel technical writing is one of my strong points.

In case you (or other readers) need more of an introduction than other
people gave:

You'll need to learn how to use CVS. It's very simple:

http://www.openbsd.org/anoncvs.html

The website, including the FAQ, is in the www/ repo. The man pages are
combined with the source code in the src/ repo.

A typical simple CVS workflow looks something like this:

 o cd to the repo dir

 o cvs up -Pd    (use cvs up -PdC if you want to undo any existing
                  changes)

 o make your changes

 o cvs diff > /tmp/t.diff

 o append your diff to an email bound for tech@

The man pages are in the mdoc format - see the mdoc(7) man page. Man
pages have filenames like mdoc.7, where the trailing digit is the
section number. To view your local changes, you can use something like:

> mandoc path/to/mdoc.7 | less

Remember that while OpenBSD hosts and develops many of its own tools, it
also includes some third-party projects like GCC. We generally leave
third-party man pages alone unless there's a serious issue.

The mdoc format can be complicated , so make sure to read the man page
as much as you can manage.  :-)  In general, try to imitate the style of
the surrounding text.

Enjoy! And let me know if you have any remaining questions.

Michael

Reply via email to