Weblog Archives
You are currently browsing the archives for the Documentation tag.
Published on October 29th, 2010 by George Notaras - Comments : 0
It has become common nowadays that Python projects provide their documentation in “source form“. The documentation is split into multiple files, written in restructured text, and is shipped together with some other configuration and media files for Sphinx. The user is meant to use the provided Makefile to export the documentation in various formats. This [...]
Published on April 12th, 2009 by George Notaras - Comments : 0
This post incudes a list of ZFS related screencast links and documentation links that you might find useful.
Published on December 16th, 2007 by George Notaras - Comments : 0
The National Security Agency (NSA) of the USA has published some security configuration guides for various popular Operating Systems. Linux is covered by the Red Hat Enterprise Linux 5 security guide, but most of the included information can be easily translated to other Linux distributions. As it is clearly stated in the guide’s disclaimer, all [...]
Published on March 5th, 2007 by George Notaras - Comments : 0
Reading a man page using a terminal application is easy, but I doubt if it would ever win a convenience award. Sometimes, it is necessary to print the man page. I can recommend two ways of doing this.
Published on November 27th, 2006 by George Notaras - Comments : 0
Today, I stumbled upon the following links, which seem to be what could get someone started with LaTeX. Andrew Roberts has done an exceptional job. His tutorials cover topics both for the absolute beginner and the medium experienced user. This is a must read! Actually, I found out about the above tutorials by this post, [...]
Published on May 17th, 2006 by George Notaras - Comments : 0
The availability of good and complete documentation for an API is one of the most important factors in order someone to be able to effectively use that API for application programming. Good API documentation saves time and effort. It provides all the needed information a programmer, either professional or amateur, would need in order to [...]
Published on May 4th, 2006 by George Notaras - Comments : 0
Some links about how to write a man page: How to Write man Pages Writing man-pages THE LINUX MAN-PAGE-HOWTO Last, but not least: # man 7 groff_man This man page contains all the macros that can be used in a manual page.