Organize the documentation a bit more. I'm not actually sure this is an improvement...
[wiki.git] / doc.mdwn
1 [[!meta title="SIPB Documentation"]]
2
3 SIPB offers documentation for users at MIT and elsewhere.
4
5 Writing and editing this documentation is an [[ongoing project|doc/project]].  Edits and other contributions welcome.
6
7
8 ## Recent Documentation
9
10 ### SIPB
11
12 * [[Using sipbmp3|doc/using-sipbmp3]] <br />
13 A guide to queue music to sipbmp3, the gutenbach system SIPB uses to play music in the office.
14
15 * [[SIPB Hands-on Assignments|doc/hands-on]] <br />
16 Modeled on the [6.033 hands-on assignments], these guides will walk you through concepts and technologies that are core to many SIPB projects. We appreciate contributions!
17
18 * [[Summer Reading|doc/summer-reading]] <br />
19 Documents and books that various SIPB members recommend reading.
20
21 ### Zephyr
22
23 * [[Using Zephyr|doc/zephyr]] <br />
24 A guide on using Zephyr today with BarnOwl (and GNU Screen). Aimed at newcomers to Zephyr, and a pretty good reference.  See also [the Barnowl wiki](http://barnowl.mit.edu/).
25
26 * [[Using SZS (the SMS to Zephyr Relay)|doc/szs]] <br />
27 Send and receive text messages through Zephyr.
28
29 * [[Using Screen|doc/screen]] <br />
30 Handy for [[doc/Zephyr]] and anything else you do in an ssh session.
31
32
33 ### Kerberos and AFS
34
35 * [[Kerberized Server|doc/kerberized-server]] <br />
36 Explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
37
38 * [[Root Instance|doc/root-instance]] <br />
39 Explains root and extra instances in Kerberos.
40
41 * [[AFS and You|doc/afs-and-you]] <br />
42 A useful guide to AFS (originally the Andrew File System), the system that stores your Athena files. Targeted at mid-to-advanced users, this is a more up-to-date version than the Inessential Guide to AFS below.
43
44 ### Client Certificates
45
46 * [[doc/Enabling Client Certificate Auth in Chrome]] <br />
47 Recent versions of Google Chrome and Chromium should mostly work without surprises. This documentation is primarily for Linux users.
48
49 * [[Configuring Client-Side Certificate Authentication on Apache|doc/apache-client-certs]] <br />
50 How to configure your own server to accept client-side certificates just like [scripts.mit.edu](http://scripts.mit.edu)
51
52 ### Miscellaneous
53
54 * XVM: [Using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl), and
55  [Getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole)
56
57 * [[Printing with CUPS on the Mac|doc/cups-on-mac]] <br />
58 How to set up printing on a Mac.
59
60 * [Learning Debian Packaging](http://debathena.mit.edu/packaging/)
61
62 * [[Using CPAN|doc/cpan]] <br />
63 CPAN is a source of many useful Perl libraries, but the tools often seem determined not to let you have them. Here's how to beat them into submission.
64
65 ## IAP Classes and Cluedumps
66
67 SIPB teaches [an array of classes](http://sipb.mit.edu/iap) each IAP and shorter [cluedumps](http://cluedumps.mit.edu/) in the fall.
68 Some of them leave notes useful as documentation.
69
70 * [Java Class Notes](http://stuff.mit.edu/afs/sipb/project/iap/Archive/1999/java/outline.html) <br />
71 These are the electronic slides that were used in SIPB's popular Java class.
72
73 * [Understanding Git](http://web.mit.edu/cluedumps/slides/understanding-git-2008.pdf) <br />
74 These slides were developed for a SIPB cluedump on the Git version control system.
75
76
77 ## Documentation in progress
78
79 See the [[SIPB Documentation Project|doc/project]] page for more documentation ideas.
80
81 * [[doc/Debianization]] <br />
82 How to package software for Debian and Ubuntu.  Popular topic in SIPB projects thanks to [Debathena](http://debathena.mit.edu/) and [XVM](http://xvm.mit.edu).
83
84
85 ## The Inessential Guide Series
86 The SIPB Inessential Guide series contain useful information about a variety of computing topics. Explore!
87
88 * [An Inessential Guide to Athena](http://stuff.mit.edu/afs/sipb/project/doc/guide/guide/) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/guide/guide.dvi))([PDF](http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/guide/guide.pdf))([PS](http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/guide/guide.ps))<br />
89 A large guide on how to get the most out of your Athena account, from reading mail, to using AFS, to sending zephyrs.
90
91 * [An Inessential Quick Reference to Athena](http://stuff.mit.edu/afs/sipb/project/doc/quickref/quick/) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/quickref/quickref.dvi)) <br />
92 A one-page reference to the most basic information about Athena, including logging in, reading email, and getting help.
93
94 * [Inessential AFS](http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/afs/html/afs-new.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/iAFS.dvi))([PDF](http://stuff.mit.edu/afs/sipb/project/doc/current/iAFS.pdf))([PS](http://stuff.mit.edu/afs/sipb/project/doc/current/iAFS.ps)) <br />
95 A guide to AFS (Andrew File System) - the system used to store your files on Athena. Note that a more updated version of this guide can be found [[here|doc/afs-and-you]].
96
97 * [Inessential LaTeX (PDF)](http://stuff.mit.edu/sipb/ilatex) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/iLaTeX.dvi)) ([HTML, but somewhat dated](http://stuff.mit.edu/afs/sipb.mit.edu/project/www/latex/guide/guide.html))  <br />
98 A very helpful guide to LaTeX, a typesetting program commonly used for doing PSets, writing papers, theses, books, etc.
99
100 * [Inessential MATLAB](http://stuff.mit.edu/afs/sipb/project/www/matlab/imatlab/imatlab.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/imatlab/imatlab.dvi)) ([PDF](http://stuff.mit.edu/afs/sipb/project/doc/current/imatlab.pdf)) <br />
101 A guide to using MATLAB on Athena.
102
103 * [Inessential Zephyr](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/html/izephyr.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/izephyr.dvi))([PDF](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/izephyr.pdf)) <br />
104 A guide to using the Athena instant-messenging system, Zephyr. Less relevant now that most people use Barnowl, try [this](http://sipb-www.scripts.mit.edu/doc/wiki/UsingZephyr) instead
105
106 * [Inessential Bitmaps](http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/ibitmap/ibitmap.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/ibitmap.dvi)) <br />
107 A guide to drawing and displaying XBM bitmaps and other graphics.
108
109 * Inessential Refrigerator Restocking (Internal DVI version - inquire at SIPB) <br />
110 A guide on how to restock a soda fridge. It isn't as hard as you make it look.
111
112
113 ## Other Documentation
114
115 * [How to Choose a Good Password](http://stuff.mit.edu/afs/sipb/project/doc/passwords/passwords.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/passwords.dvi)) <br />
116 A one-page list of guidelines on how to choose secure passwords, and why this is important.
117
118 * [[Who Fixes What at MIT|doc/who-fixes-what]] <br />
119 How and to whom to report all kinds of problems with computing infrastructure at MIT.
120
121 * [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html) <br />
122 A quick guide to filtering your e-mail on Athena's common email-clients.
123
124 * [Getting Started with PGP on Athena](http://stuff.mit.edu/afs/sipb/project/doc/pgp/pgp.html) <br />
125 A quick guide to using PGP security on Athena.
126
127 * [DVI files? What are those? What's XDVI?](http://stuff.mit.edu/afs/sipb/project/www/latex/xdvi/xdvi.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/xdvi.dvi)) <br />
128 XDVI is a program to view DVI files, a common output format from LaTeX.
129
130 * [NetNews: A One-Page Guide to the Usenet](http://stuff.mit.edu/afs/sipb/project/www/netnews/netnews-doc/netnews-doc.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/onepage-netnews.dvi)) <br />
131 A one-page reference to reading NetNews.
132
133 * [Using Discuss](http://stuff.mit.edu/afs/sipb/project/www/discuss/discuss.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/discuss.dvi)) <br />
134 A guide to using and enjoying the Discuss bulletin board system on Athena.
135
136 * [[So you want to learn Git...|doc/&git ]] <br />
137 Pointers to resources from which Git, the Version Control System many of us use.
138
139
140 ## Licensing
141
142 While we love free and open source software, there are [http://www.opensource.org/proliferation](too many licenses) and the options can get a bit confusing. SIPB has some official recommendations for what to use and how to effect these licenses.
143
144 * [[Code Licensing Recommendation|doc/code-licensing]]
145
146 * [[Documentation Licensing Recommendation|doc/doc-licensing]]