diff options
| author | Glenn Morris | 2012-10-05 21:42:02 -0400 |
|---|---|---|
| committer | Glenn Morris | 2012-10-05 21:42:02 -0400 |
| commit | 24636b2633c00ac63cc023f8b6e76e416fa1728a (patch) | |
| tree | 872d99960d2a1c1e38a435542e27cb73e5085a56 | |
| parent | a03bb33fb07f49255847eebdb4c47299ab38b45c (diff) | |
| download | emacs-24636b2633c00ac63cc023f8b6e76e416fa1728a.tar.gz emacs-24636b2633c00ac63cc023f8b6e76e416fa1728a.zip | |
Remove outdated information from ERC manual
* doc/misc/erc.texi: Include emacsver.texi, and use EMACSVER rather than
ERC version.
(Introduction): ERC is distributed with Emacs.
(Obtaining ERC, Installation): Remove chapters, no longer relevant.
(Getting Started): Simplify.
(Getting Help and Reporting Bugs): Refer to general Emacs lists.
(History): Mention ERC maintained as part of Emacs now.
* doc/misc/Makefile.in ($(buildinfodir)/erc$(INFO_EXT), erc.dvi, erc.pdf):
Add dependency on emacsver.texi.
| -rw-r--r-- | doc/misc/ChangeLog | 10 | ||||
| -rw-r--r-- | doc/misc/Makefile.in | 6 | ||||
| -rw-r--r-- | doc/misc/erc.texi | 246 |
3 files changed, 30 insertions, 232 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index f210af4e5f3..5fdd4acde95 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,5 +1,15 @@ | |||
| 1 | 2012-10-06 Glenn Morris <rgm@gnu.org> | 1 | 2012-10-06 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * erc.texi: Include emacsver.texi, and use EMACSVER rather than | ||
| 4 | ERC version. | ||
| 5 | (Introduction): ERC is distributed with Emacs. | ||
| 6 | (Obtaining ERC, Installation): Remove chapters, no longer relevant. | ||
| 7 | (Getting Started): Simplify. | ||
| 8 | (Getting Help and Reporting Bugs): Refer to general Emacs lists. | ||
| 9 | (History): Mention ERC maintained as part of Emacs now. | ||
| 10 | * Makefile.in ($(buildinfodir)/erc$(INFO_EXT), erc.dvi, erc.pdf): | ||
| 11 | Add dependency on emacsver.texi. | ||
| 12 | |||
| 3 | * erc.texi: Remove hand-written node pointers. | 13 | * erc.texi: Remove hand-written node pointers. |
| 4 | 14 | ||
| 5 | 2012-10-05 Glenn Morris <rgm@gnu.org> | 15 | 2012-10-05 Glenn Morris <rgm@gnu.org> |
diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in index cc76d53a8a9..5ce6d82e683 100644 --- a/doc/misc/Makefile.in +++ b/doc/misc/Makefile.in | |||
| @@ -336,12 +336,12 @@ epa.pdf: ${srcdir}/epa.texi | |||
| 336 | $(ENVADD) $(TEXI2PDF) ${srcdir}/epa.texi | 336 | $(ENVADD) $(TEXI2PDF) ${srcdir}/epa.texi |
| 337 | 337 | ||
| 338 | erc : $(buildinfodir)/erc$(INFO_EXT) | 338 | erc : $(buildinfodir)/erc$(INFO_EXT) |
| 339 | $(buildinfodir)/erc$(INFO_EXT): ${srcdir}/erc.texi | 339 | $(buildinfodir)/erc$(INFO_EXT): ${srcdir}/erc.texi $(emacsdir)/emacsver.texi |
| 340 | $(mkinfodir) | 340 | $(mkinfodir) |
| 341 | $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/erc.texi | 341 | $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/erc.texi |
| 342 | erc.dvi: ${srcdir}/erc.texi | 342 | erc.dvi: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi |
| 343 | $(ENVADD) $(TEXI2DVI) ${srcdir}/erc.texi | 343 | $(ENVADD) $(TEXI2DVI) ${srcdir}/erc.texi |
| 344 | erc.pdf: ${srcdir}/erc.texi | 344 | erc.pdf: ${srcdir}/erc.texi $(emacsdir)/emacsver.texi |
| 345 | $(ENVADD) $(TEXI2PDF) ${srcdir}/erc.texi | 345 | $(ENVADD) $(TEXI2PDF) ${srcdir}/erc.texi |
| 346 | 346 | ||
| 347 | ert : $(buildinfodir)/ert$(INFO_EXT) | 347 | ert : $(buildinfodir)/ert$(INFO_EXT) |
diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index e28eda00b53..378180bef31 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi | |||
| @@ -3,13 +3,13 @@ | |||
| 3 | @setfilename ../../info/erc | 3 | @setfilename ../../info/erc |
| 4 | @settitle ERC Manual | 4 | @settitle ERC Manual |
| 5 | @syncodeindex fn cp | 5 | @syncodeindex fn cp |
| 6 | @include emacsver.texi | ||
| 6 | @c %**end of header | 7 | @c %**end of header |
| 7 | 8 | ||
| 8 | @copying | 9 | @copying |
| 9 | This manual is for ERC version 5.3. | 10 | This manual is for ERC as distributed with Emacs @value{EMACSVER}. |
| 10 | 11 | ||
| 11 | Copyright @copyright{} 2005-2012 | 12 | Copyright @copyright{} 2005-2012 Free Software Foundation, Inc. |
| 12 | Free Software Foundation, Inc. | ||
| 13 | 13 | ||
| 14 | @quotation | 14 | @quotation |
| 15 | Permission is granted to copy, distribute and/or modify this document | 15 | Permission is granted to copy, distribute and/or modify this document |
| @@ -56,9 +56,6 @@ and modified without restriction. | |||
| 56 | 56 | ||
| 57 | @menu | 57 | @menu |
| 58 | * Introduction:: What is ERC? | 58 | * Introduction:: What is ERC? |
| 59 | * Obtaining ERC:: How to get ERC releases and development | ||
| 60 | versions. | ||
| 61 | * Installation:: Compiling and installing ERC. | ||
| 62 | * Getting Started:: Quick Start guide to using ERC. | 59 | * Getting Started:: Quick Start guide to using ERC. |
| 63 | * Keystroke Summary:: Keystrokes used in ERC buffers. | 60 | * Keystroke Summary:: Keystrokes used in ERC buffers. |
| 64 | * Modules:: Available modules for ERC. | 61 | * Modules:: Available modules for ERC. |
| @@ -75,11 +72,6 @@ and modified without restriction. | |||
| 75 | @detailmenu | 72 | @detailmenu |
| 76 | --- The Detailed Node Listing --- | 73 | --- The Detailed Node Listing --- |
| 77 | 74 | ||
| 78 | Obtaining ERC | ||
| 79 | |||
| 80 | * Releases:: Released versions of ERC. | ||
| 81 | * Development:: Latest unreleased development changes. | ||
| 82 | |||
| 83 | Getting Started | 75 | Getting Started |
| 84 | 76 | ||
| 85 | * Sample Session:: Example of connecting to the #emacs channel | 77 | * Sample Session:: Example of connecting to the #emacs channel |
| @@ -98,6 +90,7 @@ Advanced Usage | |||
| 98 | @chapter Introduction | 90 | @chapter Introduction |
| 99 | 91 | ||
| 100 | ERC is a powerful, modular, and extensible IRC client for Emacs. | 92 | ERC is a powerful, modular, and extensible IRC client for Emacs. |
| 93 | It is distributed with Emacs since version 22.1. | ||
| 101 | 94 | ||
| 102 | It comes with the following capabilities enabled by default. | 95 | It comes with the following capabilities enabled by default. |
| 103 | 96 | ||
| @@ -117,212 +110,13 @@ It comes with the following capabilities enabled by default. | |||
| 117 | 110 | ||
| 118 | @end itemize | 111 | @end itemize |
| 119 | 112 | ||
| 120 | @node Obtaining ERC | ||
| 121 | @chapter Obtaining ERC | ||
| 122 | |||
| 123 | @menu | ||
| 124 | * Releases:: Released versions of ERC. | ||
| 125 | * Development:: Latest unreleased development changes. | ||
| 126 | @end menu | ||
| 127 | |||
| 128 | Note that some ERC files are not included with Emacs due to copyright or | ||
| 129 | dependency issues. If desired, they may be found at the following | ||
| 130 | locations, or from your local GNU mirror. | ||
| 131 | |||
| 132 | @itemize @bullet | ||
| 133 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.tar.gz} | ||
| 134 | @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.zip} | ||
| 135 | @end itemize | ||
| 136 | |||
| 137 | The rest of this chapter may be skipped if you are using the version of | ||
| 138 | ERC that comes with Emacs. | ||
| 139 | |||
| 140 | @node Releases | ||
| 141 | @section Releases | ||
| 142 | |||
| 143 | Choose to install a release if you want to minimize risk. | ||
| 144 | |||
| 145 | Errors are corrected in development first. User-visible changes will be | ||
| 146 | announced on the @email{erc-discuss@@gnu.org} mailing list. | ||
| 147 | @pxref{Getting Help and Reporting Bugs}. | ||
| 148 | |||
| 149 | @cindex releases, Debian package | ||
| 150 | @cindex Debian package for ERC | ||
| 151 | Debian users can get ERC via apt-get. The @file{erc} package is | ||
| 152 | available in the official Debian repository. | ||
| 153 | |||
| 154 | @cindex releases, from source | ||
| 155 | Alternatively, you can download the latest release from | ||
| 156 | @uref{http://ftp.gnu.org/gnu/erc}, or your local GNU mirror. | ||
| 157 | |||
| 158 | @node Development | ||
| 159 | @section Development | ||
| 160 | @cindex development | ||
| 161 | |||
| 162 | Choose the development version if you want to live on the bleeding edge | ||
| 163 | of ERC development or try out new features before release. | ||
| 164 | |||
| 165 | @cindex git version control system, using | ||
| 166 | The git version control system allows you to keep up-to-date with the | ||
| 167 | latest changes to the development version of ERC. It also allows you | ||
| 168 | to contribute changes (via commits, if you are have developer access to | ||
| 169 | the repository, or via patches, otherwise). If you would like to | ||
| 170 | contribute to ERC development, it is highly recommended that you use | ||
| 171 | git. | ||
| 172 | |||
| 173 | If you are new to git, you might find this tutorial helpful: | ||
| 174 | @uref{http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html}. | ||
| 175 | |||
| 176 | Downloading ERC with git and staying up-to-date involves the following | ||
| 177 | steps. | ||
| 178 | |||
| 179 | @enumerate | ||
| 180 | @item Install git. | ||
| 181 | |||
| 182 | @itemize @bullet | ||
| 183 | @item Debian and Ubuntu: @kbd{apt-get install git-core}. | ||
| 184 | @item Windows: @uref{http://git.or.cz/gitwiki/WindowsInstall}. | ||
| 185 | @item Other operating systems: download, compile, and install the source | ||
| 186 | from @uref{http://www.kernel.org/pub/software/scm/git/}, or find a git | ||
| 187 | package for your operating system. | ||
| 188 | @end itemize | ||
| 189 | |||
| 190 | @item Download the ERC development branch. | ||
| 191 | |||
| 192 | If you have developer access to ERC, do: | ||
| 193 | |||
| 194 | @example | ||
| 195 | git clone ssh://loginname@@git.sv.gnu.org/srv/git/erc.git | ||
| 196 | @end example | ||
| 197 | |||
| 198 | otherwise, do: | ||
| 199 | |||
| 200 | @example | ||
| 201 | git clone git://git.sv.gnu.org/erc.git | ||
| 202 | @end example | ||
| 203 | |||
| 204 | If you are behind a restrictive firewall, and do not have developer | ||
| 205 | access, then do the following instead: | ||
| 206 | |||
| 207 | @example | ||
| 208 | git clone http://git.sv.gnu.org/r/erc.git | ||
| 209 | @end example | ||
| 210 | |||
| 211 | @item List upstream changes that are missing from your local copy. | ||
| 212 | Do this whenever you want to see whether new changes have been committed | ||
| 213 | to ERC. If you wish, you may skip this step and proceed directly to | ||
| 214 | the ``update'' step. | ||
| 215 | |||
| 216 | @example | ||
| 217 | # Change to the source directory you are interested in. | ||
| 218 | cd erc | ||
| 219 | |||
| 220 | # Fetch new changes from the repository, but don't apply them yet | ||
| 221 | git fetch origin | ||
| 222 | |||
| 223 | # Display log messages for the new changes | ||
| 224 | git log HEAD..origin | ||
| 225 | @end example | ||
| 226 | |||
| 227 | ``origin'' is git's name for the location where you originally got ERC | ||
| 228 | from. You can change this location at any time by editing the | ||
| 229 | @file{.git/config} file in the directory where the ERC source was | ||
| 230 | placed. | ||
| 231 | |||
| 232 | @cindex updating ERC with git | ||
| 233 | @item Update to the latest version by pulling in any missing changes. | ||
| 234 | |||
| 235 | @example | ||
| 236 | cd erc | ||
| 237 | git pull origin | ||
| 238 | @end example | ||
| 239 | |||
| 240 | git will show how many files changed, and will provide a visual display | ||
| 241 | for how many lines were changed in each file. | ||
| 242 | |||
| 243 | @end enumerate | ||
| 244 | |||
| 245 | There are other ways to interact with the ERC repository. | ||
| 246 | |||
| 247 | @itemize | ||
| 248 | @item Browse git repo: @uref{http://git.sv.gnu.org/gitweb/?p=erc.git} | ||
| 249 | @item Latest development snapshot: @uref{http://mwolson.org/static/dist/erc-latest.tar.gz} | ||
| 250 | @item Latest development snapshot (zip file): @uref{http://mwolson.org/static/dist/erc-latest.zip} | ||
| 251 | @end itemize | ||
| 252 | |||
| 253 | The latest development snapshot can lag behind the git repo by as much | ||
| 254 | as 20 minutes, but never more than that. | ||
| 255 | |||
| 256 | For further information on committing changes to ERC and performing | ||
| 257 | development, please consult | ||
| 258 | @uref{http://emacswiki.org/cgi-bin/wiki/ErcDevelopment}. | ||
| 259 | |||
| 260 | |||
| 261 | @node Installation | ||
| 262 | @chapter Installation | ||
| 263 | |||
| 264 | ERC may be compiled and installed on your machine. | ||
| 265 | |||
| 266 | This section may be skipped if you are using the version of ERC that | ||
| 267 | comes with Emacs. | ||
| 268 | |||
| 269 | @subsubheading Compilation | ||
| 270 | |||
| 271 | This is an optional step, since Emacs Lisp source code does not | ||
| 272 | necessarily have to be byte-compiled. It will yield a speed increase, | ||
| 273 | though. | ||
| 274 | |||
| 275 | A working copy of Emacs or XEmacs is needed in order to compile ERC. By | ||
| 276 | default, the program that is installed with the name @command{emacs} | ||
| 277 | will be used. | ||
| 278 | |||
| 279 | If you want to use the @command{xemacs} binary to perform the | ||
| 280 | compilation, you would need to edit @file{Makefile} in the top-level | ||
| 281 | directory as follows. You can put either a full path to an Emacs or | ||
| 282 | XEmacs binary or just the command name, as long as it is in the | ||
| 283 | @env{PATH}. | ||
| 284 | |||
| 285 | @example | ||
| 286 | EMACS = xemacs | ||
| 287 | SITEFLAG = -no-site-file | ||
| 288 | @end example | ||
| 289 | |||
| 290 | Running @code{make} should compile the ERC source files in the | ||
| 291 | @file{lisp} directory. | ||
| 292 | |||
| 293 | @subsubheading Installation | ||
| 294 | |||
| 295 | ERC may be installed into your file hierarchy by doing the following. | ||
| 296 | |||
| 297 | Edit the @file{Makefile} file so that @env{ELISPDIR} points to where you | ||
| 298 | want the source and compiled ERC files to be installed and | ||
| 299 | @env{INFODIR} indicates where to put the ERC manual. Of course, you | ||
| 300 | will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the | ||
| 301 | Compilation section if you are using XEmacs. | ||
| 302 | |||
| 303 | If you are installing ERC on a Debian system, you might want to change | ||
| 304 | the value of @env{INSTALLINFO} as specified in @file{Makefile}. | ||
| 305 | |||
| 306 | Run @code{make} as a normal user. | ||
| 307 | |||
| 308 | Run @code{make install} as the root user if you have chosen installation | ||
| 309 | locations that require this. | ||
| 310 | |||
| 311 | 113 | ||
| 312 | @node Getting Started | 114 | @node Getting Started |
| 313 | @chapter Getting Started | 115 | @chapter Getting Started |
| 314 | @cindex settings | 116 | @cindex settings |
| 315 | 117 | ||
| 316 | To use ERC, add the directory containing its files to your | 118 | The command @kbd{M-x erc} will start ERC and prompt for the server to |
| 317 | @code{load-path} variable, in your @file{.emacs} file. Then, load ERC | 119 | connect to. |
| 318 | itself. An example follows. | ||
| 319 | |||
| 320 | @lisp | ||
| 321 | (require 'erc) | ||
| 322 | @end lisp | ||
| 323 | |||
| 324 | Once ERC is loaded, the command @kbd{M-x erc} will start ERC and | ||
| 325 | prompt for the server to connect to. | ||
| 326 | 120 | ||
| 327 | If you want to place ERC settings in their own file, you can place them | 121 | If you want to place ERC settings in their own file, you can place them |
| 328 | in @file{~/.emacs.d/.ercrc.el}, creating it if necessary. | 122 | in @file{~/.emacs.d/.ercrc.el}, creating it if necessary. |
| @@ -936,31 +730,20 @@ or if you have bugs to report, there are several places you can go. | |||
| 936 | 730 | ||
| 937 | @item | 731 | @item |
| 938 | @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the | 732 | @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the |
| 939 | emacswiki.org page for ERC. Anyone may add tips, hints, or bug | 733 | emacswiki.org page for ERC. Anyone may add tips, hints, etc. to it. |
| 940 | descriptions to it. | ||
| 941 | 734 | ||
| 942 | @item | 735 | @item |
| 943 | There are several mailing lists for ERC. To subscribe, visit | 736 | You can ask questions about using ERC on the Emacs mailing list, |
| 944 | @uref{http://savannah.gnu.org/mail/?group=erc}. | 737 | @uref{http://lists.gnu.org/mailman/listinfo/help-gnu-emacs}. |
| 945 | |||
| 946 | The mailing lists are also available on Gmane. | ||
| 947 | (@url{http://gmane.org/}). Gmane provides additional methods for | ||
| 948 | accessing the mailing lists, adding content to them, and searching them. | ||
| 949 | |||
| 950 | @enumerate | ||
| 951 | @item gmane.emacs.erc.announce: Announcements | ||
| 952 | |||
| 953 | @item gmane.emacs.erc.discuss: General discussion | ||
| 954 | |||
| 955 | @item gmane.emacs.erc.cvs: Log messages for changes to the ERC source code | ||
| 956 | |||
| 957 | @end enumerate | ||
| 958 | 738 | ||
| 959 | @item | 739 | @item |
| 960 | You can visit the IRC Freenode channel @samp{#emacs}. Many of the | 740 | You can visit the IRC Freenode channel @samp{#emacs}. Many of the |
| 961 | contributors are frequently around and willing to answer your | 741 | contributors are frequently around and willing to answer your |
| 962 | questions. | 742 | questions. |
| 963 | 743 | ||
| 744 | @item | ||
| 745 | To report a bug in ERC, use @kbd{M-x report-emacs-bug}. | ||
| 746 | |||
| 964 | @end itemize | 747 | @end itemize |
| 965 | 748 | ||
| 966 | 749 | ||
| @@ -1027,6 +810,11 @@ our revision control system. Our mailing list address changed as well. | |||
| 1027 | 810 | ||
| 1028 | We switched to using git for our version control system. | 811 | We switched to using git for our version control system. |
| 1029 | 812 | ||
| 813 | @item 2009+ | ||
| 814 | |||
| 815 | Since about 2009, ERC is no longer developed as a separate project, but | ||
| 816 | is maintained as part of Emacs. | ||
| 817 | |||
| 1030 | @end itemize | 818 | @end itemize |
| 1031 | 819 | ||
| 1032 | @node Copying | 820 | @node Copying |