Club Pages
From Club Ubuntu
Contents |
What are the Club Pages?
The club pages (or Command Line Utility Breakdown Pages) are a documentation project begun by the Club Ubuntu community to develop a comprehensive collection of useful information about every command available at the Command Line Interface. Club pages are similar to man pages in their scope, but differ from man pages by placing a special emphasis on building understanding and intuition about the given command. Club pages are likely to be more useful to more users, more often.
What Club Pages are Not
The Club Pages project is in no way a replacement or alternative for man pages. Man pages serve their purpose very well. If we intended to improve upon man pages we would use our time to improve the man pages that already exist. Man pages tend to be used for reference, while Club Pages may be used for learning. The difference in intent should be made clear in what follows.
The Motivation
Linux users are often encouraged to 'read the manual' and experienced Linux users are familiar with 'man pages'. Man pages provide very detailed, factual, information about most commands available at the command line. While these man pages are part of the Linux/Unix tradition and have great utility, they are not well suited for every person or purpose. Often it seems that man pages are written for someone who already has a solid grasp of the material and needs a quick reference for how to use it in a particular way. The man pages (and other Linux documentation) are often not quite satisfying for someone who is first encountering the material or seeking a deeper understanding. Club pages will be.
An Example Club Page
How to make Club Pages in this Wiki
Now we need you to help us create the club pages. To create a new club page in this wiki simply search for the command/utility by name. If it does not exist, create the page. Use the format indicated in the above example to document the command/utility in question (if you cannot fill it out completely, don't worry, that is the power of a wiki, and some one will be able to finish what you have gotten started). At the end of the page you are editing put [[Category:Club Pages]] in order to add your page to the Club Pages index.
This is a work in progress
This is a work in progress. The above example is given to indicate the idea of this project, at this stage nothing is fixed or permanent, we welcome you to add to it, or restructure it. Experimentation is encouraged until we settle on the 'best format for a club page'. I do hope that the example given above provides a fairly clear idea of the intent, while giving something to build upon. We will need a lot of help to complete this project so pick a command and jump in! :)
