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 ## Recent Documentation
   8
   9 ### SIPB
  10
  11 * [[Using sipbmp3|doc/using-sipbmp3]] <br />
  12 A guide to queue music to sipbmp3, the gutenbach system SIPB uses to play music in the office.
  13
  14 * [[SIPB Hands-on Assignments|doc/hands-on]] <br />
  15 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!
  16
  17 * [[Summer Reading|doc/summer-reading]] <br />
  18 Documents and books that various SIPB members recommend reading.
  19
  20 * [[Moira|doc/moira]] <br />
  21 Some tips for using Moira
  22
  23 * [[Pergamon|doc/pergamon]] <br />
  24 Setting up a mailing list archive using Pergamon, SIPB's self-service discuss server (see below for documentation on discuss)
  25
  26 ### Zephyr
  27
  28 * [[Using Zephyr|doc/zephyr]] <br />
  29 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/).
  30
  31 * [[Using `zcrypt`|doc/zcrypt]] <br />
  32 A guide to using `zcrypt`ed (encrypted) zephyr classes. Zephyr at MIT (mostly) doesn't support limiting who can sub to a zephyr class, so if you want to have reasonably private conversations, encrypting them is a good idea.
  33
  34 * [[Using SZS (the SMS to Zephyr Relay)|doc/szs]] <br />
  35 Send and receive text messages through Zephyr.
  36
  37 * [[Using Screen|doc/screen]] <br />
  38 Handy for [[doc/Zephyr]] and anything else you do in an ssh session.
  39
  40
  41 ### Kerberos and AFS
  42
  43 * [[Kerberized Server|doc/kerberized-server]] <br />
  44 Explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
  45
  46 * [[Root Instance|doc/root-instance]] <br />
  47 Explains root and extra instances in Kerberos.
  48
  49 * [[AFS and You|doc/afs-and-you]] <br />
  50 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.
  51
  52 ### Client Certificates
  53
  54 * [[Configuring Client-Side Certificate Authentication on Apache|doc/apache-client-certs]] <br />
  55 How to configure your own server to accept client-side certificates just like [scripts.mit.edu](https://scripts.mit.edu/)
  56
  57 ### Miscellaneous
  58
  59 * [scripts.mit.edu](https://scripts.mit.edu/): [user documentation](https://scripts.mit.edu/faq), [internals wiki](https://scripts.mit.edu/wiki/)
  60
  61 * XVM: [Using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl), and
  62  [Getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole)
  63
  64 * [[Printing with CUPS on the Mac|doc/cups-on-mac]] <br />
  65 How to set up printing on a Mac.
  66
  67 * [Learning Debian Packaging](http://debathena.mit.edu/packaging/)
  68
  69 * [[Using CPAN|doc/cpan]] <br />
  70 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.
  71
  72 * [[Writing safe(r) shell scripts|doc/safe-shell]]
  73
  74 ## IAP Classes and Cluedumps
  75
  76 SIPB teaches [an array of classes](http://sipb.mit.edu/iap) each IAP and shorter [cluedumps](http://cluedumps.mit.edu/) in the fall.
  77 Some of them leave notes useful as documentation.
  78
  79 * [Understanding Git](http://web.mit.edu/cluedumps/slides/understanding-git-2008.pdf) <br />
  80 These slides were developed for a SIPB cluedump on the Git version control system.
  81
  82
  83 ## The Inessential Guide Series
  84 The SIPB Inessential Guide series contain useful information about a variety of computing topics. Explore!
  85
  86 * [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 />
  87 A large guide on how to get the most out of your Athena account, from reading mail, to using AFS, to sending zephyrs.
  88
  89 * [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 />
  90 A one-page reference to the most basic information about Athena, including logging in, reading email, and getting help.
  91
  92 * [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 />
  93 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]].
  94
  95 * [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 />
  96 A very helpful guide to LaTeX, a typesetting program commonly used for doing PSets, writing papers, theses, books, etc.
  97
  98 * [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 />
  99 A guide to using MATLAB on Athena.
 100
 101 * [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 />
 102 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
 103
 104 * [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 />
 105 A guide to drawing and displaying XBM bitmaps and other graphics.
 106
 107 * Inessential Refrigerator Restocking (Internal DVI version - inquire at SIPB) <br />
 108 A guide on how to restock a soda fridge. It isn't as hard as you make it look.
 109
 110
 111 ## Other Documentation
 112
 113 * [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 />
 114 A one-page list of guidelines on how to choose secure passwords, and why this is important.
 115
 116 * [Who Fixes What at MIT](http://stuff.mit.edu/afs/athena.mit.edu/system/info/who_fixes_what) <br />
 117 How and to whom to report all kinds of problems with computing infrastructure at MIT.
 118
 119 * [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html) <br />
 120 A quick guide to filtering your e-mail on Athena's common email-clients.
 121
 122 * [Getting Started with PGP on Athena](http://stuff.mit.edu/afs/sipb/project/doc/pgp/pgp.html) <br />
 123 A quick guide to using PGP security on Athena.
 124
 125 * [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 />
 126 XDVI is a program to view DVI files, a common output format from LaTeX.
 127
 128 * [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 />
 129 A one-page reference to reading NetNews.
 130
 131 * [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 />
 132 A guide to using and enjoying the Discuss bulletin board system on Athena.
 133
 134 * [[So you want to learn Git...|doc/&git ]] <br />
 135 Pointers to resources from which Git, the Version Control System many of us use.
 136
 137
 138 ## Licensing
 139
 140 While we love free and open source software, there are [too many licenses](http://www.opensource.org/proliferation) and the options can get a bit confusing. SIPB has some official recommendations for what to use and how to effect these licenses.
 141
 142 * [[Code Licensing Recommendation|doc/code-licensing]]
 143
 144 * [[Documentation Licensing Recommendation|doc/doc-licensing]]