cut commented links to LennyBugs* -- now in projects/
[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 * [[Using Zephyr|doc/zephyr]] <br />
11 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/).
12
13 * [[AFS and You|doc/afs-and-you]] <br />
14 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 above.
15
16 * [[doc/screen]] <br />
17 Handy for [[doc/Zephyr]] and anything else you do in an ssh session.
18
19 * XVM: [Using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl), and
20  [Getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole)
21
22 * [[Printing with CUPS on the Mac|doc/cups-on-mac]] <br />
23 How to set up printing on a Mac.
24
25 * [[Kerberized Server|doc/kerberized-server]] <br />
26 Explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
27
28 * [[Root Instance|doc/root-instance]] <br />
29 Explains root and extra instances in Kerberos.
30
31 * [[Summer Reading|doc/summer-reading]] <br />
32 Documents and books that various SIPB members recommend reading.
33
34
35
36 ## IAP Classes and Cluedumps
37
38 SIPB teaches [an array of classes](http://sipb.mit.edu/iap) each IAP and shorter [cluedumps](http://cluedumps.mit.edu/) in the fall.
39 Some of them leave notes useful as documentation.
40
41 * [Java Class Notes](http://stuff.mit.edu/afs/sipb/project/iap/Archive/1999/java/outline.html) <br />
42 These are the electronic slides that were used in SIPB's popular Java class.
43
44 * [Understanding Git](http://web.mit.edu/cluedumps/slides/understanding-git-2008.pdf) <br />
45 These slides were developed for a SIPB cluedump on the Git version control system.
46
47
48 ## Documentation in progress
49
50 See the [[SIPB Documentation Project|doc/project]] page for more documentation ideas.
51
52 * [[doc/Debianization]] <br />
53 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).
54
55
56 ## The Inessential Guide Series
57 The SIPB Inessential Guide series contain useful information about a variety of computing topics. Explore!
58
59 * [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 />
60 A large guide on how to get the most out of your Athena account, from reading mail, to using AFS, to sending zephyrs.
61
62 * [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 />
63 A one-page reference to the most basic information about Athena, including logging in, reading email, and getting help.
64
65 * [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 />
66 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]].
67
68 * [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 />
69 A very helpful guide to LaTeX, a typesetting program commonly used for doing PSets, writing papers, theses, books, etc.
70
71 * [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 />
72 A guide to using MATLAB on Athena.
73
74 * [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 />
75 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
76
77 * [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 />
78 A guide to drawing and displaying XBM bitmaps and other graphics.
79
80 * Inessential Refrigerator Restocking (Internal DVI version - inquire at SIPB) <br />
81 A guide on how to restock a soda fridge. It isn't as hard as you make it look.
82
83
84 ## Other Documentation
85
86 * [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 />
87 A one-page list of guidelines on how to choose secure passwords, and why this is important.
88
89 * [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html) <br />
90 A quick guide to filtering your e-mail on Athena's common email-clients.
91
92 * [Getting Started with PGP on Athena](http://stuff.mit.edu/afs/sipb/project/doc/pgp/pgp.html) <br />
93 A quick guide to using PGP security on Athena.
94
95 * [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 />
96 XDVI is a program to view DVI files, a common output format from LaTeX.
97
98 * [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 />
99 A one-page reference to reading NetNews.
100
101 * [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 />
102 A guide to using and enjoying the Discuss bulletin board system on Athena.
103