[patch] update for doc/FIRST_STEPS
Peter J Ross <[email protected]>
| Newsgroups | gmane.network.slrn.user |
|---|---|
| Message-ID | <[email protected]> |
The attached diff is for version pre0.9.9-xxx. Changes: 1. Updated URLs. 2. Expanded information about using multiple servers. 3. Expanded information about where to find the reference manual. 4. Fixed a couple of typos, and applied consistent formatting. 5. Added my name and email address, so Felix S won't be blamed for my changes. ;-) I think an HTML version of this document would be useful, so I propose to create an SGML file from which both text and HTML can be generated. I may do likewise for score.txt. As usual, my latest attempts to update slrn's other documentation (the reference manual and FAQ) can be found at <http://pjr.lasnobberia.net/slrn-doc/>, and comments, suggestions, patches etc are very welcome. -- PJR :-) ------------------------------------------------------------------------- Check out the new SourceForge.net Marketplace. It's the best place to buy or sell services for just about anything Open Source. http://sourceforge.net/services/buy/index.php
FIRST_STEPS.patch
(text/x-diff, 6.5 KB)
--- FIRST_STEPS.orig 2008-06-04 20:49:14.000000000 +0100 +++ FIRST_STEPS 2008-06-04 21:08:00.000000000 +0100 @@ -3,11 +3,11 @@ ============================================================================== -This document explains the first things you have to do after having -installed slrn. It doesn't matter how you installed slrn (from source or -using a binary package), the first steps remain the same on any Unix system. -If you installed slrn as a binary package, however, it is possible that your -distributor has already done some work for you. +This document explains the first things you have to do after having installed +slrn. It doesn't matter how you installed slrn (from source or using a binary +package), the first steps remain the same on any Unix system. If you installed +slrn as a binary package, however, it is possible that your distributor has +already done some work for you. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = @@ -24,33 +24,35 @@ distributor has included a global slrn.rc and/or an example slrn.rc. If you cannot find a file named "slrn.rc" or any other file which seems to be a configuration file for slrn, you can get an example from -<http://slrn.sourceforge.net/docs/>. +<http://pjr.lasnobberia.net/slrn-doc/>. If a global configuration file exists, it will also be read before your personal one on each startup, so you might want to look at the default settings it makes for you. If you don't have a configuration file for slrn yet (check your home -directory), you may copy the example configuration file and edit it with -your favourite editor: +directory), you may copy the example configuration file and edit it with your +favourite editor: - cp /path/to/slrn.rc ~/.slrnrc - vi ~/.slrnrc + cp /path/to/slrn.rc ~/.slrnrc + vi ~/.slrnrc For the exact syntax and descriptions of all variables, have a look at the -"slrn reference manual" which comes with slrn. +"slrn reference manual" which comes with slrn, named "manual.txt". An HTML +version is also available from <http://pjr.lasnobberia.net/slrn-doc/>. -If your "From:" header cannot be generated from your local account, you -should at least set the following variables: +If your "From:" header cannot be generated from your local account, you should +at least set the following variables: - set hostname "doe.com" % sets the domain of your adress to "doe.com" - set username "john" % sets the localpart of your adress to "john" - set realname "John Doe" % sets your realname to "John Doe" + set hostname "doe.com" % sets the domain of your address to "doe.com" + set username "john" % sets the localpart of your address to "john" + set realname "John Doe" % sets your realname to "John Doe" In this example, the resulting "From:" header is "John Doe <[email protected]>" -The sample slrn.rc file is well documented; feel free to make more changes -to it if you like. +The sample slrn.rc file is well documented; feel free to make more changes to +it if you like. + = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = Choosing a newsserver @@ -66,19 +68,20 @@ To set it permanently, add one of the following lines to the configuration file of your favourite shell: - NNTPSERVER='server_name' && export NNTPSERVER (for sh/ksh/bash/zsh) - setenv NNTPSERVER 'server_name' (for csh/tcsh) + NNTPSERVER='server_name' && export NNTPSERVER (for sh/ksh/bash/zsh) + setenv NNTPSERVER 'server_name' (for csh/tcsh) If you want to use more than one newsserver set the $NNTPSERVER to your primary server and access the other server by starting slrn with "slrn -h server.name". Note: When using different servers, you need to specify separate newsrc - files using the "server" configuration command. + files using the "server" configuration command or the "-f" command line + switch. If your newsserver requires authentication, you also need to use the -"nnrpaccess" command. "nnrpaccess" and "server" are described in detail in -the reference manual. +"nnrpaccess" command. "nnrpaccess" and "server" are described in detail in the +reference manual. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = @@ -86,10 +89,13 @@ = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -Run "slrn --create" at your shell prompt to start slrn and retrieve a list -of all active newsgroups from the server. This can take some time if your +Run "slrn --create" at your shell prompt to start slrn and retrieve a list of +all active newsgroups from the server. This can take some time if your connection is slow; future startups (without that flag) are much faster. +Note: If using multiple servers, you will need to use the "--create" option + for each of them. + When slrn switches to full screen mode, you can press 'q' to exit it again. @@ -116,15 +122,15 @@ are two ways to tell slrn which editor it should use. If you want to use the same editor for all applications on your system, just -set the enviroment variables "EDITOR" and/or "VISUAL" to your preferred -editor (if you haven't done this already). slrn will heed this. +set the enviroment variables "EDITOR" and/or "VISUAL" to your preferred editor +(if you haven't done this already). slrn will heed this. -If you want to use a special editor or just pass special arguments to it, -set the variable "editor_command" in your .slrnrc e.g.: +If you want to use a special editor or just pass special arguments to it, set +the variable "editor_command" in your .slrnrc e.g.: -set editor_command "vim '+set tw=72' +%d '%s'" + set editor_command "vim '+set tw=72' +%d '%s'" -starts vim with a textwidth of 72 chars and the cursor on the first line of +starts vim with a textwidth of 72 columns and the cursor on the first line of the messages body. For a more detailed discussion of this, see the entry "editor_command" in the reference manual. @@ -152,7 +158,9 @@ At first, you should have a look at the "README" file from the source distribution. It gives an overview of all the documentation distributed with -slrn. If you cannot find this file, <http://slrn.sourceforge.net/docs/> is a -good point to start. +slrn. If you cannot find this file, <http://www.jedsoft.org/slrn/docs.html/> +is a good point to start. -This document is written by Felix Schueller <[email protected]>. +This document was written by Felix Schueller <[email protected]> and +has been updated for slrn version 0.9.9 by Peter J Ross +<[email protected]>.