X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/blobdiff_plain/d5f1a7b175efc4506e0f0c164309c9397f984fa1..ba8768d7e12d8d4a60d823e684502ef24b6a8473:/doc.mdwn diff --git a/doc.mdwn b/doc.mdwn index 3b63b90..4d4a4f2 100644 --- a/doc.mdwn +++ b/doc.mdwn @@ -1,53 +1,69 @@ [[!meta title="SIPB Documentation"]] -The Student Information Processing Board is devoted to helping the MIT community utilize the Institute's computer facilities with ease and efficiency. Since we know how dry and badly written the average user's manual is, we write and maintain many documents on our own. This documentation is freely provided to users in the form of online and printed manuals, UNIX man pages, and emacs info files, in addition to the documentation available in our office. The source for almost all of this documentation is available online under the directory /afs/sipb.mit.edu/project/doc, and is redistributable under certain conditions; all these documents are copyright by the SIPB. Although the following guides are mainly of use to Athena users, SIPB documents are known to be used at universities other than MIT. Hardcopies of these documents are available for free in the SIPB Office, W20-557, and online versions are also available via Athena's online "help" facility, by selecting the main-menu item "Documentation Archives". +SIPB offers documentation for users at MIT and elsewhere. -Some stuff under this tree is being migrated from Trac format. +Writing and editing this documentation is an [[ongoing project|doc/project]]. Edits and other contributions welcome. +## Recent Documentation -## More Useful Guides +* [[Using Zephyr|doc/zephyr]]
+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/). -* [Using Zephyr](http://sipb-www.scripts.mit.edu/doc/wiki/UsingZephyr)
-A guide on using Zephyr today with BarnOwl (and GNU Screen). Aimed at newcomers to Zephyr, and also a pretty good reference. - -* [AFS and You](http://sipb.mit.edu/doc/afs-and-you)
+* [[AFS and You|doc/afs-and-you]]
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. -* [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))
-A one-page list of guidelines on how to choose secure passwords, and why this is important. +* [[doc/screen]]
+Handy for [[doc/Zephyr]] and anything else you do in an ssh session. + +* XVM: [Using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl), and + [Getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole) + +* [[Printing with CUPS on the Mac|doc/cups-on-mac]]
+How to set up printing on a Mac. + +* [[Kerberized Server|doc/kerberized-server]]
+Explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos. + +* [[Root Instance|doc/root-instance]]
+Explains root and extra instances in Kerberos. + +* [[Summer Reading|doc/summer-reading]]
+Documents and books that various SIPB members recommend reading. -* [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html)
-A quick guide to filtering your e-mail on Athena's common email-clients. + + +## IAP Classes and Cluedumps + +SIPB teaches [an array of classes](http://sipb.mit.edu/iap) each IAP and shorter [cluedumps](http://cluedumps.mit.edu/) in the fall. +Some of them leave notes useful as documentation. * [Java Class Notes](http://stuff.mit.edu/afs/sipb/project/iap/Archive/1999/java/outline.html)
These are the electronic slides that were used in SIPB's popular Java class. -* [Getting Started with PGP on Athena](http://stuff.mit.edu/afs/sipb/project/doc/pgp/pgp.html)
-A quick guide to using PGP security on Athena. +* [Understanding Git](http://web.mit.edu/cluedumps/slides/understanding-git-2008.pdf)
+These slides were developed for a SIPB cluedump on the Git version control system. -* [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))
-XDVI is a program to view DVI files, a common output format from LaTeX. -* [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))
-A one-page reference to reading NetNews. +## Documentation in progress -* [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)) -A guide to using and enjoying the Discuss bulletin board system on Athena. +See the [[SIPB Documentation Project|doc/project]] page for more documentation ideas. +* [[doc/Debianization]]
+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). ## The Inessential Guide Series The SIPB Inessential Guide series contain useful information about a variety of computing topics. Explore! -* [An Inessential Guide to Athena](http://stuff.mit.edu/afs/sipb/project/doc/quickref/quick.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/iAthena.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))
+* [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))
A large guide on how to get the most out of your Athena account, from reading mail, to using AFS, to sending zephyrs. -* [An Inessential Quick Reference to Athena](http://stuff.mit.edu/afs/sipb/project/doc/quickref/quick.html)([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/quickref.dvi))
+* [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))
A one-page reference to the most basic information about Athena, including logging in, reading email, and getting help. -* [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)) -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](http://sipb.mit.edu/doc/afs-and-you). +* [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))
+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]]. * [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))
A very helpful guide to LaTeX, a typesetting program commonly used for doing PSets, writing papers, theses, books, etc. @@ -63,3 +79,25 @@ A guide to drawing and displaying XBM bitmaps and other graphics. * Inessential Refrigerator Restocking (Internal DVI version - inquire at SIPB)
A guide on how to restock a soda fridge. It isn't as hard as you make it look. + + +## Other Documentation + +* [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))
+A one-page list of guidelines on how to choose secure passwords, and why this is important. + +* [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html)
+A quick guide to filtering your e-mail on Athena's common email-clients. + +* [Getting Started with PGP on Athena](http://stuff.mit.edu/afs/sipb/project/doc/pgp/pgp.html)
+A quick guide to using PGP security on Athena. + +* [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))
+XDVI is a program to view DVI files, a common output format from LaTeX. + +* [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))
+A one-page reference to reading NetNews. + +* [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))
+A guide to using and enjoying the Discuss bulletin board system on Athena. +