aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorMiles Bader2007-12-29 02:39:17 +0000
committerMiles Bader2007-12-29 02:39:17 +0000
commita0c92ed92d3d62d4926dafb1d595d87843df4688 (patch)
tree78f12dd6f97a0f96b846fbf08e3f8ce39a701f8e /doc/misc
parent9aeb99f00a02c695b14f2ee349141eb9641ca6da (diff)
parent870356897e927f380841268667a92b40fb9e6782 (diff)
downloademacs-a0c92ed92d3d62d4926dafb1d595d87843df4688.tar.gz
emacs-a0c92ed92d3d62d4926dafb1d595d87843df4688.zip
Merge from emacs--devo--0
Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-306
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/ChangeLog49
-rw-r--r--doc/misc/cc-mode.texi4
-rw-r--r--doc/misc/dbus.texi93
-rw-r--r--doc/misc/gnus.texi19
-rw-r--r--doc/misc/rcirc.texi320
-rw-r--r--doc/misc/trampver.texi2
6 files changed, 398 insertions, 89 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 8e4eab56b15..07d74fc32ed 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,52 @@
12007-12-29 Reiner Steib <Reiner.Steib@gmx.de>
2
3 * gnus.texi (Group Parameters): Reorder the text and add a note about
4 `gnus-parameters' near the beginning of the node.
5
62007-12-29 IRIE Tetsuya <irie@t.email.ne.jp> (tiny change)
7
8 * gnus.texi (Score File Editing): Fix function name.
9
102007-12-23 Michael Albinus <michael.albinus@gmx.de>
11
12 Sync with Tramp 2.1.12.
13
14 * trampver.texi: Update release number.
15
162007-12-22 Michael Albinus <michael.albinus@gmx.de>
17
18 * dbus.texi (Type Conversion): Correct input parameters mapping.
19
202007-12-21 Michael Albinus <michael.albinus@gmx.de>
21
22 * dbus.texi (Type Conversion): Extend for D-Bus compound types.
23 (Errors and Events): Mention wrong-type-argument error.
24
252007-12-21 Alex Schroeder <alex@gnu.org>
26
27 * rcirc.texi: Changed single spaces after sentence end to double
28 spaces. Fixed some typos.
29 (Internet Relay Chat): Explain relay.
30 (Getting started with rcirc): Change items to reflect prompts.
31 Add more explanation to rcirc-track-minor-mode and added a comment to
32 warn future maintainers that this section is a copy.
33 (People): Changed /ignore example.
34 (Keywords): Not keywords.
35
362007-12-20 Alex Schroeder <alex@gnu.org>
37
38 * rcirc.texi (Top): Fighting Information Overload chapter added.
39 (Getting started with rcirc): Add notice of rcirc-track-minor-mode.
40 (rcirc commands): Moved /ignore command to the new chapter.
41 (Fighting Information Overload): New chapter documenting /keyword,
42 /bright, /dim, channel ignore, and low priority channels.
43 (Configuration): Document rcirc-server-alist, remove
44 rcirc-startup-channels-alist and rcirc-default-server.
45
462007-12-16 Michael Albinus <michael.albinus@gmx.de>
47
48 * dbus.texi (Signals): Fix example in dbus-register-signal.
49
12007-12-14 Sven Joachim <svenjoac@gmx.de> 502007-12-14 Sven Joachim <svenjoac@gmx.de>
2 51
3 * gnus.texi (Score Variables): Fix typo. 52 * gnus.texi (Score Variables): Fix typo.
diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi
index 7c9a2ac1f1b..80c9332996a 100644
--- a/doc/misc/cc-mode.texi
+++ b/doc/misc/cc-mode.texi
@@ -487,8 +487,8 @@ work just fine right out of the box. Note however that you might not
487have the latest @ccmode{} release and might want to upgrade your copy 487have the latest @ccmode{} release and might want to upgrade your copy
488(see below). 488(see below).
489 489
490You should probably start by skimming through the entire chapter 490You should probably start by skimming through the entire Commands chapter
491@ref{Commands} to get an overview of @ccmode{}'s capabilities. 491(@pxref{Commands}) to get an overview of @ccmode{}'s capabilities.
492 492
493After trying out some commands, you may dislike some aspects of 493After trying out some commands, you may dislike some aspects of
494@ccmode{}'s default configuration. Here is an outline of how to 494@ccmode{}'s default configuration. Here is an outline of how to
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi
index b5c8ce3efb1..352e57f0faa 100644
--- a/doc/misc/dbus.texi
+++ b/doc/misc/dbus.texi
@@ -238,7 +238,7 @@ D-Bus method calls and signals accept usually several arguments as
238parameters, either as input parameter, or as output parameter. Every 238parameters, either as input parameter, or as output parameter. Every
239argument belongs to a D-Bus type. 239argument belongs to a D-Bus type.
240 240
241Such arguments must be mapped between the the value encoded as a D-Bus 241Such arguments must be mapped between the value encoded as a D-Bus
242type, and the corresponding type of Lisp objects. The mapping is 242type, and the corresponding type of Lisp objects. The mapping is
243applied Lisp object @expansion{} D-Bus type for input parameters, and 243applied Lisp object @expansion{} D-Bus type for input parameters, and
244D-Bus type @expansion{} Lisp object for output parameters. 244D-Bus type @expansion{} Lisp object for output parameters.
@@ -247,8 +247,7 @@ D-Bus type @expansion{} Lisp object for output parameters.
247@section Input parameters. 247@section Input parameters.
248 248
249Input parameters for D-Bus methods and signals occur as arguments of a 249Input parameters for D-Bus methods and signals occur as arguments of a
250Lisp function call. Only some primitive Lisp types are supported in 250Lisp function call. The following mapping to D-Bus types is
251the current implementation. The following mapping to D-Bus types is
252applied, when the corresponding D-Bus message is created: 251applied, when the corresponding D-Bus message is created:
253 252
254@example 253@example
@@ -260,30 +259,91 @@ applied, when the corresponding D-Bus message is created:
260@item integer @tab @expansion{} @tab DBUS_TYPE_INT32 259@item integer @tab @expansion{} @tab DBUS_TYPE_INT32
261@item float @tab @expansion{} @tab DBUS_TYPE_DOUBLE 260@item float @tab @expansion{} @tab DBUS_TYPE_DOUBLE
262@item string @tab @expansion{} @tab DBUS_TYPE_STRING 261@item string @tab @expansion{} @tab DBUS_TYPE_STRING
262@item list @tab @expansion{} @tab DBUS_TYPE_ARRAY
263@end multitable 263@end multitable
264@end example 264@end example
265 265
266Other Lisp objects, like symbols or hash tables, are not accepted as
267input parameter.
268
269If it is necessary to use another D-Bus type, a corresponding type
270symbol can be preceeded to the corresponding Lisp object. Basic D-Bus
271types are represented by the type symbols @code{:byte},
272@code{:boolean}, @code{:int16}, @code{:uint16}, @code{:int32},
273@code{:uint32}, @code{:int64}, @code{:uint64}, @code{:double},
274@code{:string}, @code{:object-path} and @code{:signature}.
275
266@noindent 276@noindent
267Other Lisp types, especially lists, are not supported (yet). 277Example:
278
279@lisp
280(dbus-call-method ... @var{NUMBER} @var{STRING})
281@end lisp
282
283is equivalent to
284
285@lisp
286(dbus-call-method ... :uint32 @var{NUMBER} :string @var{STRING})
287@end lisp
288
289but different to
290
291@lisp
292(dbus-call-method ... :int32 @var{NUMBER} :signature @var{STRING})
293@end lisp
294
295A D-Bus compound type is always represented as list. The car of this
296list can be the type symbol @code{:array}, @code{:variant},
297@code{:struct} or @code{:dict-entry}, which would result in a
298corresponding D-Bus container. @code{:array} is optional, because
299this is the default compoud type for a list.
300
301The objects being elements of the list are checked according to the
302D-Bus compound type rules.
303
304@itemize
305@item An array must contain only elements of the same D-Bus type.
306@item A variant must contain only one single element.
307@item A dictionary entry must be element of an array, and it must
308contain only a key-value pair of two element, with a basic type key.
309@item There is no restriction for structs.
310@end itemize
311
312@noindent
313Example:
314
315@lisp
316(dbus-send-signal ...
317 :object-path STRING '(:variant :boolean BOOL)
318 '(:array NUMBER NUMBER) '(:array BOOL :boolean BOOL)
319 '(:struct BOOL :boolean BOOL BOOL
320 (:array NUMBER NUMBER) (:array BOOL BOOL))
321 '(:struct NUMBER NUMBER) '((:dict-entry NUMBER (NUMBER)))
322 '(:array (:dict-entry NUMBER :int32 NUMBER)))
323@end lisp
268 324
269 325
270@section Output parameters. 326@section Output parameters.
271 327
272Output parameters of D-Bus methods and signals are mapped to Lisp 328Output parameters of D-Bus methods and signals are mapped to Lisp
273objects. This mapping is more powerful than the one for input 329objects.
274parameters, i.e., more D-Bus types are supported by the current
275implementation.
276 330
277@example 331@example
278@multitable {DBUS_TYPE_OBJECT_PATH} {@expansion{}} {@code{t} or @code{nil}} 332@multitable {DBUS_TYPE_OBJECT_PATH} {@expansion{}} {@code{t} or @code{nil}}
279@item D-Bus type @tab @tab Lisp type 333@item D-Bus type @tab @tab Lisp type
280@item 334@item
281@item DBUS_TYPE_BOOLEAN @tab @expansion{} @tab @code{t} or @code{nil} 335@item DBUS_TYPE_BOOLEAN @tab @expansion{} @tab @code{t} or @code{nil}
282@item DBUS_TYPE_UINT32 @tab @expansion{} @tab number 336@item DBUS_TYPE_BYTE @tab @expansion{} @tab number
283@item DBUS_TYPE_INT32 @tab @expansion{} @tab number 337@item DBUS_TYPE_UINT16 @tab @expansion{} @tab number
338@item DBUS_TYPE_INT16 @tab @expansion{} @tab number
339@item DBUS_TYPE_UINT32 @tab @expansion{} @tab number or float
340@item DBUS_TYPE_INT32 @tab @expansion{} @tab number or float
341@item DBUS_TYPE_UINT64 @tab @expansion{} @tab number or float
342@item DBUS_TYPE_INT64 @tab @expansion{} @tab number or float
284@item DBUS_TYPE_DOUBLE @tab @expansion{} @tab float 343@item DBUS_TYPE_DOUBLE @tab @expansion{} @tab float
285@item DBUS_TYPE_STRING @tab @expansion{} @tab string 344@item DBUS_TYPE_STRING @tab @expansion{} @tab string
286@item DBUS_TYPE_OBJECT_PATH @tab @expansion{} @tab string 345@item DBUS_TYPE_OBJECT_PATH @tab @expansion{} @tab string
346@item DBUS_TYPE_SIGNATURE @tab @expansion{} @tab string
287@item DBUS_TYPE_ARRAY @tab @expansion{} @tab list 347@item DBUS_TYPE_ARRAY @tab @expansion{} @tab list
288@item DBUS_TYPE_VARIANT @tab @expansion{} @tab list 348@item DBUS_TYPE_VARIANT @tab @expansion{} @tab list
289@item DBUS_TYPE_STRUCT @tab @expansion{} @tab list 349@item DBUS_TYPE_STRUCT @tab @expansion{} @tab list
@@ -291,6 +351,11 @@ implementation.
291@end multitable 351@end multitable
292@end example 352@end example
293 353
354A float object in case of @code{DBUS_TYPE_UINT32},
355@code{DBUS_TYPE_INT32}, @code{DBUS_TYPE_UINT64} and
356@code{DBUS_TYPE_INT6432} is returned, when the C value exceeds the
357Emacs number size range.
358
294The resulting list of the last 4 D-Bus compound types contains as 359The resulting list of the last 4 D-Bus compound types contains as
295elements the elements of the D-Bus container, mapped according to the 360elements the elements of the D-Bus container, mapped according to the
296same rules. 361same rules.
@@ -469,8 +534,9 @@ received. It must accept as arguments the output parameters
469 "org.freedesktop.Hal.Manager" "DeviceAdded" 534 "org.freedesktop.Hal.Manager" "DeviceAdded"
470 'my-dbus-signal-handler) 535 'my-dbus-signal-handler)
471 536
472@result{} (:system ":1.3" "/org/freedesktop/Hal/Manager" 537@result{} ((:system "org.freedesktop.Hal.Manager" "DeviceAdded")
473 "org.freedesktop.Hal.Manager" "DeviceAdded") 538 ("org.freedesktop.Hal" "/org/freedesktop/Hal/Manager"
539 my-signal-handler))
474@end example 540@end example
475 541
476As we know from the inspection data of interface 542As we know from the inspection data of interface
@@ -497,6 +563,11 @@ result of a preceding @code{dbus-register-signal} call.
497@cindex errors 563@cindex errors
498@cindex events 564@cindex events
499 565
566Input parameters of @code{dbus-call-method} and
567@code{dbus-register-signal} are checked for correct D-Bus types. If
568there is a type mismatch, the Lisp error @code{wrong-type-argument}
569@code{D-Bus ARG} is raised.
570
500All errors raised by D-Bus are signaled with the error symbol 571All errors raised by D-Bus are signaled with the error symbol
501@code{dbus-error}. As usual, such an error can be trapped with a 572@code{dbus-error}. As usual, such an error can be trapped with a
502@code{condition-case} form. If possible, error messages from D-Bus 573@code{condition-case} form. If possible, error messages from D-Bus
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 4a165c62b25..521ac05c6fb 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -2741,6 +2741,15 @@ newsgroups.
2741@cindex group parameters 2741@cindex group parameters
2742 2742
2743The group parameters store information local to a particular group. 2743The group parameters store information local to a particular group.
2744
2745Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2746group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2747presents you with a Customize-like interface. The latter helps avoid
2748silly Lisp errors.) You might also be interested in reading about topic
2749parameters (@pxref{Topic Parameters}).
2750Additionally, you can set group parameters via the
2751@code{gnus-parameters} variable, see below.
2752
2744Here's an example group parameter list: 2753Here's an example group parameter list:
2745 2754
2746@example 2755@example
@@ -3130,12 +3139,6 @@ expired.
3130 3139
3131@end table 3140@end table
3132 3141
3133Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3134group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3135presents you with a Customize-like interface. The latter helps avoid
3136silly Lisp errors.) You might also be interested in reading about topic
3137parameters (@pxref{Topic Parameters}).
3138
3139@vindex gnus-parameters 3142@vindex gnus-parameters
3140Group parameters can be set via the @code{gnus-parameters} variable too. 3143Group parameters can be set via the @code{gnus-parameters} variable too.
3141But some variables, such as @code{visible}, have no effect (For this 3144But some variables, such as @code{visible}, have no effect (For this
@@ -20962,9 +20965,9 @@ additional commands:
20962 20965
20963@item C-c C-c 20966@item C-c C-c
20964@kindex C-c C-c (Score) 20967@kindex C-c C-c (Score)
20965@findex gnus-score-edit-done 20968@findex gnus-score-edit-exit
20966Save the changes you have made and return to the summary buffer 20969Save the changes you have made and return to the summary buffer
20967(@code{gnus-score-edit-done}). 20970(@code{gnus-score-edit-exit}).
20968 20971
20969@item C-c C-d 20972@item C-c C-d
20970@kindex C-c C-d (Score) 20973@kindex C-c C-d (Score)
diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi
index f6d807f971f..0591b951a89 100644
--- a/doc/misc/rcirc.texi
+++ b/doc/misc/rcirc.texi
@@ -54,6 +54,7 @@ just one other user.
54@menu 54@menu
55* Basics:: 55* Basics::
56* Reference:: 56* Reference::
57* Fighting Information Overload::
57* Hacking and Tweaking:: 58* Hacking and Tweaking::
58* GNU Free Documentation License:: 59* GNU Free Documentation License::
59* Key Index:: 60* Key Index::
@@ -74,6 +75,13 @@ Reference
74* Useful IRC commands:: 75* Useful IRC commands::
75* Configuration:: 76* Configuration::
76 77
78Fighting Information Overload
79
80* Channels::
81* People::
82* Keywords::
83* Notices::
84
77Hacking and Tweaking 85Hacking and Tweaking
78 86
79* Skipping /away messages using handlers:: 87* Skipping /away messages using handlers::
@@ -112,8 +120,8 @@ communication.
112@cindex server 120@cindex server
113@cindex network 121@cindex network
114Contrary to most Instant Messenger (IM) systems, users usually don't 122Contrary to most Instant Messenger (IM) systems, users usually don't
115connect to a central server. Instead, users connect to a random server 123connect to a central server. Instead, users connect to a random
116in a network, and the servers share information between them. 124server in a network, and servers relay messages from one to the next.
117 125
118Here's a typical example: 126Here's a typical example:
119 127
@@ -166,7 +174,7 @@ using a different nick. This will prompt you for four things:
166@table @asis 174@table @asis
167@cindex server, connecting 175@cindex server, connecting
168@cindex Freenode network 176@cindex Freenode network
169@item IRC server 177@item IRC Server
170What server do you want to connect to? All the servers in a particular 178What server do you want to connect to? All the servers in a particular
171network are equivalent. Some networks use a round-robin system where a 179network are equivalent. Some networks use a round-robin system where a
172single server redirects new connections to a random server in the 180single server redirects new connections to a random server in the
@@ -177,7 +185,7 @@ communities and organizations.''
177 185
178@cindex port, connecting 186@cindex port, connecting
179@cindex 6667, default IRC port 187@cindex 6667, default IRC port
180@item IRC port 188@item IRC Port
181All network connections require a port. Just as web servers and clients 189All network connections require a port. Just as web servers and clients
182use port 80 per default, IRC uses port 6667 per default. You rarely 190use port 80 per default, IRC uses port 6667 per default. You rarely
183have to use a different port. 191have to use a different port.
@@ -185,7 +193,7 @@ have to use a different port.
185@cindex nick, connecting 193@cindex nick, connecting
186@cindex changing nick 194@cindex changing nick
187@cindex name changes 195@cindex name changes
188@item IRC nick 196@item IRC Nick
189@vindex user-login-name 197@vindex user-login-name
190Every users needs a handle on-line. You will automatically be assigned 198Every users needs a handle on-line. You will automatically be assigned
191a slightly different nick if your chosen nick is already in use. If 199a slightly different nick if your chosen nick is already in use. If
@@ -195,7 +203,7 @@ in use, you might for example get assigned the nick @code{alex`}.
195@cindex channels, connecting 203@cindex channels, connecting
196@cindex initial channels 204@cindex initial channels
197@cindex startup channels 205@cindex startup channels
198@item Channels 206@item IRC Channels
199A space separated list of channels you want to join when connecting. 207A space separated list of channels you want to join when connecting.
200You don't need to join any channels, if you just want to have one-to-one 208You don't need to join any channels, if you just want to have one-to-one
201conversations with friends on the same network. If you're new to the 209conversations with friends on the same network. If you're new to the
@@ -211,7 +219,7 @@ and a channel buffer for each of the channels you wanted to join.
211@kindex RET 219@kindex RET
212@cindex talking 220@cindex talking
213@cindex communicating 221@cindex communicating
214To talk in a channel, just type in what you want to say in a channel 222To talk in a channel, just type what you want to say in a channel
215buffer, and press @key{RET}. 223buffer, and press @key{RET}.
216 224
217@kindex C-c C-c 225@kindex C-c C-c
@@ -225,7 +233,21 @@ C-c} to finish editing. You still need to press @key{RET} to send it,
225though. Generally, IRC users don't like people pasting more than around 233though. Generally, IRC users don't like people pasting more than around
226four lines of code, so use with care. 234four lines of code, so use with care.
227 235
228@node Reference, Hacking and Tweaking, Basics, Top 236@comment This section copied from the Channels section.
237@comment All index markers should point to the original!
238Once you are connected to multiple channels, or once you've turned you
239attention to other buffers in Emacs, you probably want to be notified
240of any activity in channels not currently visible. All you need to do
241is switch channel tracking on using @kbd{M-x rcirc-track-minor-mode}.
242To make this permanent, add the following to your init file:
243
244@example
245(rcirc-track-minor-mode 1)
246@end example
247
248Use @kbd{C-c C-@key{SPC}} to switch to these buffers.
249
250@node Reference, Fighting Information Overload, Basics, Top
229@chapter Reference 251@chapter Reference
230@cindex reference 252@cindex reference
231 253
@@ -382,24 +404,6 @@ buffer, you automatically quit the server and part all channels. (Also
382@code{/quit ZZZzzz...}.) 404@code{/quit ZZZzzz...}.)
383@end table 405@end table
384 406
385Some commands may not have a key binding, but only be available as typed
386commands, such as:
387
388@table @code
389@item /ignore
390@cindex /ignore
391@cindex ignoring other people
392@cindex trolls, ignoring
393@cindex hide some posts
394@cindex idiots online
395This command toggles the ignore status of a nick, if you provide one.
396If you don't provide a nick, the command lists all the nicks you are
397ignoring. All messages by ignored nicks are---you guessed it---ignored.
398Since only ``operators'' can kick people from channels, the
399ignore command is often the only way to deal with some of the more
400obnoxious fellows online. Example: @code{/ignore xah}.
401@end table
402
403@node Useful IRC commands, Configuration, rcirc commands, Reference 407@node Useful IRC commands, Configuration, rcirc commands, Reference
404@section Useful IRC commands 408@section Useful IRC commands
405@cindex irc commands 409@cindex irc commands
@@ -436,68 +440,99 @@ These are some variables you can change to configure @code{rcirc} to your
436liking. 440liking.
437 441
438@table @code 442@table @code
439@item rcirc-default-server 443@item rcirc-server-alist
440@vindex rcirc-default-server 444@vindex rcirc-server-alist
441the default server to connect to. 445@cindex channels, configuration
446@cindex initial channels, configuration
447@cindex startup channels, configuration
448@cindex servers, configuration
449@cindex initial servers, configuration
450@cindex startup servers, configuration
451This variable contains an alist of servers to connect to by default
452and the keywords parameters to use. The keyword parameters are
453optional. If you don't provide any, the defaults as documented below
454will be used.
442 455
443@item rcirc-default-port 456The most important parameter is the @code{:channels} parameter. It
444@vindex rcirc-default-port 457controls which channels you will join by default as soon as you are
445the default port to connect to. 458connected to the server.
459
460Here's an example of how to set it:
461
462@example
463(add-to-list 'rcirc-server-alist
464 '("otherworlders.org"
465 :channels ("#FUDGE" "#game-design")))
466@end example
467
468By default you will be connected to the @code{rcirc} support channel:
469@code{#rcirc} on @code{irc.freenode.net}.
470
471@table @code
472@item :nick
473This overrides @code{rcirc-default-nick}.
474
475@item :port
476This overrides @code{rcirc-default-port}.
477
478@item :user-name
479This overrides @code{rcirc-default-user-name}.
480
481@item :full-name
482This overrides @code{rcirc-default-full-name}.
483
484@item :channels
485This describes which channels to join when connecting to the server.
486If absent, no channels will be connected to automatically.
487
488@end table
446 489
447@item rcirc-default-nick 490@item rcirc-default-nick
448@vindex rcirc-default-nick 491@vindex rcirc-default-nick
449the default nick to use. 492This variable is used for the default nick. It defaults to the login
450@end table 493name returned by @code{user-login-name}.
451 494
452@example 495@example
453(setq rcirc-default-server "irc.mozilla.org" 496(setq rcirc-default-nick "kensanata")
454 rcirc-default-port 6666
455 rcirc-default-nick "alx")
456@end example 497@end example
457 498
499@item rcirc-default-port
500@vindex rcirc-default-port
501@cindex port
502This variable contains the default port to connect to. It is 6667 by
503default and rarely needs changing.
504
505@item rcirc-default-user-name
506@vindex rcirc-default-user-name
507@cindex user name
508This variable contains the default user name to report to the server.
509It defaults to the login name returned by @code{user-login-name}, just
510like @code{rcirc-default-nick}.
511
512@item rcirc-default-user-full-name
458@vindex rcirc-default-user-full-name 513@vindex rcirc-default-user-full-name
459@cindex full name 514@cindex full name
460@cindex real name 515@cindex real name
461@cindex surname 516@cindex surname
462@code{rcirc-default-user-full-name} is used to set your ``real name'' on 517This variable is used to set your ``real name'' on IRC. It defaults
463IRC. It defaults to @code{user-full-name}. If you want to hide your 518to the name returned by @code{user-full-name}. If you want to hide
464full name, you might want to set it to some pseudonym. 519your full name, you might want to set it to some pseudonym.
465 520
466@example 521@example
467(setq rcirc-default-user-full-name "Curious Minds Want To Know") 522(setq rcirc-default-user-full-name "Curious Minds Want To Know")
468@end example 523@end example
469 524
470@vindex rcirc-startup-channels-alist 525@item rcirc-authinfo
471@cindex channels, configuration
472@cindex initial channels, configuration
473@cindex startup channels, configuration
474@code{rcirc-startup-channels-alist} is the alist of channels to join
475when connecting to a particular network. An alist is a list of lists.
476Each sublist starts with a regular expression that is compared to the
477server address you're connecting to. The remaining sublist items are
478the channels to join.
479
480@example
481(setq rcirc-startup-channels-alist
482 '(("\\.freenode\\.net$" "#emacs" "#rcirc" "#wiki")))
483@end example
484
485Note the subtle problem, here --- IRC clients connect to servers, and
486there is no way of knowing which servers belong to a particular network.
487In the example above we're exploiting a naming convention used by within
488the Freenode network --- all servers within the network have a host in
489the @code{freenode.net} domain.
490
491@vindex rcirc-authinfo 526@vindex rcirc-authinfo
492@cindex authentification 527@cindex authentification
493@cindex identification 528@cindex identification
494@cindex nickserv 529@cindex nickserv
495@cindex login 530@cindex login
496@code{rcirc-authinfo} is an alist used to automatically identify 531This variable is an alist used to automatically identify yourself on
497yourself on networks. Each sublist starts with a regular expression 532networks. Each sublist starts with a regular expression that is
498that is compared to the server address you're connecting to. The second 533compared to the server address you're connecting to. The second
499element in the list is a symbol representing the method to use, followed 534element in the list is a symbol representing the method to use,
500by the arguments this method requires. 535followed by the arguments this method requires.
501 536
502Here is an example to illustrate how you would set it: 537Here is an example to illustrate how you would set it:
503 538
@@ -556,8 +591,33 @@ Later, you will tell Bitlbee about your accounts and passwords on all
556the other instant messaging services, and Bitlbee will log you in. All 591the other instant messaging services, and Bitlbee will log you in. All
557@code{rcirc} needs to know, is the login to your Bitlbee account. Don't 592@code{rcirc} needs to know, is the login to your Bitlbee account. Don't
558confuse the Bitlbee account with all the other accounts. 593confuse the Bitlbee account with all the other accounts.
594
595@end table
596
559@end table 597@end table
560 598
599@node Fighting Information Overload, Hacking and Tweaking, Reference, Top
600@chapter Fighting Information Overload
601@cindex information overload
602
603This is the section of the manual that caters to the busy person
604online. There are support channels with several hundred people in
605them. Trying to follow a conversation in these channels can be a
606daunting task. This chapters tells you how @code{rcirc} can help.
607
608@menu
609* Channels::
610* People::
611* Keywords::
612* Notices::
613@end menu
614
615@node Channels, People, Fighting Information Overload, Fighting Information Overload
616@section Channels
617@cindex channels
618@cindex modeline
619
620@comment This section copied to the Getting started with rcirc section
561@kindex C-c C-SPC 621@kindex C-c C-SPC
562@vindex rcirc-track-minor-mode 622@vindex rcirc-track-minor-mode
563@cindex switching channels 623@cindex switching channels
@@ -590,7 +650,133 @@ activation of this mode:
590 (rcirc-track-minor-mode 1))) 650 (rcirc-track-minor-mode 1)))
591@end example 651@end example
592 652
593@node Hacking and Tweaking, GNU Free Documentation License, Reference, Top 653@cindex busy channels
654If you've joined a very active support channel, tracking activity is
655no longer useful. The channel will be always active. Switching to
656active channels using @kbd{C-c C-@key{SPC}} no longer works as
657expected.
658
659@kindex C-c C-l
660@cindex low priority channels
661The solution is to mark this channel as as a low priority channel.
662Use @kbd{C-c C-l} to make the current channel a low-priority channel.
663Low priority channels have the modeline indicator ``LowPri''.
664@kbd{C-c C-@key{SPC}} will not switch to low priority channels unless
665you use the @kbd{C-u} prefix.
666
667@kindex C-c TAB
668@cindex ignored channels
669If you prefer a channel to never show up in the modeline, then you
670have to ignore it. Use @kbd{C-c @key{TAB}} to ignore the current
671channel.
672
673@node People, Keywords, Channels, Fighting Information Overload
674@section People
675@cindex people, how to ignore
676@cindex nicks, how to ignore
677@cindex friends
678@cindex buddies
679@cindex trolls
680
681The most important command available to the discerning IRC user is
682@code{/ignore}. It's the big equalizer online: If people aggravate
683you, just ignore them.
684
685This is of course a crude all-or-nothing solution. Fear not,
686@code{rcirc} offers alternatives: You can ``brighten'' your buddies
687and ``dim'' certain other nicks that you don't want to ignore
688altogether.
689
690@table @code
691@item /ignore
692@cindex /ignore
693@cindex ignoring other people
694@cindex trolls, ignoring
695@cindex hide some posts
696@cindex idiots online
697This command toggles the ignore status of a nick, if you provide one.
698If you don't provide a nick, the command lists all the nicks you are
699ignoring. All messages by ignored nicks are---you guessed it---ignored.
700Since only ``operators'' can kick people from channels, the
701ignore command is often the only way to deal with some of the more
702obnoxious fellows online. Example: @code{/ignore rudybot}.
703
704@item /bright
705@cindex /bright
706@cindex highlight other people
707@cindex friends, highlight
708@cindex buddies, highlight
709@cindex nicks, highlight
710@cindex brighten nicks
711This command toggles the bright status of a nick, if you provide one.
712If you don't provide a nick, the command lists all the ``brightened''
713nicks. All messages by brightened nicks are---you guessed
714it---brightened. Use this for your friends. Example: @code{/bright
715rcy}.
716
717@item /dim
718@cindex /dim
719@cindex soft-ignore other people
720@cindex obnoxious people online
721@cindex rabble online
722This command toggles the dim status of a nick, if you provide one. If
723you don't provide a nick, the command lists all the ``dimmed'' nicks.
724All messages by dimmed nicks are---you guessed it---dimmed. Use this
725for boring people and bots. If you are tracking channel activity,
726messages by dimmed nicks will not register as activity. Example:
727@code{/dim fsbot}.
728@end table
729
730
731@node Keywords, Notices, People, Fighting Information Overload
732@section Keywords
733@cindex keywords
734
735On a busy channel, you might want to ignore all activity (using
736@kbd{C-c @key{TAB}}) and just watch for certain keywords. The
737following command allows you to highlight certain keywords:
738
739@table @code
740@item /keyword
741@cindex /keyword
742This command toggles the highlighting of a keyword, if you provide
743one. If you don't provide a keyword, the current keywords are
744listed. Example: @code{/keyword manual}.
745@end table
746
747@node Notices, , Keywords, Fighting Information Overload
748@section Notices
749@cindex part notices, how to omit
750@cindex join notices, how to omit
751@cindex quit notices, how to omit
752@cindex nick notices, how to omit
753
754@kindex C-c C-o
755@cindex low priority channels
756In busy channels you might not be interested in all the joining,
757parting, quitting, and renaming that goes on. You can omit those
758notices using @kbd{C-c C-o}.
759
760@vindex rcirc-omit-responses
761@cindex away notices, how to omit
762You can control which notices get omitted via the
763@code{rcirc-omit-responses} variable. Here's an example of how to
764omit away messages:
765
766@example
767(setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY))
768@end example
769
770@vindex rcirc-omit-threshold
771Notice that these messages will not be omitted if the nick in question
772has recently been active. After all, you don't want to continue a
773conversation with somebody who just left. That's why @code{rcirc}
774checks recent lines in the buffer to figure out if a nick has been
775active and only omits a message if the nick has not been active. The
776window @code{rcirc} considers is controlled by the
777@code{rcirc-omit-threshold} variable.
778
779@node Hacking and Tweaking, GNU Free Documentation License, Fighting Information Overload, Top
594@chapter Hacking and Tweaking 780@chapter Hacking and Tweaking
595@cindex hacking and tweaking 781@cindex hacking and tweaking
596 782
diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi
index 44babab9f5e..74a1808686b 100644
--- a/doc/misc/trampver.texi
+++ b/doc/misc/trampver.texi
@@ -4,7 +4,7 @@
4@c In the Tramp CVS, the version number is auto-frobbed from 4@c In the Tramp CVS, the version number is auto-frobbed from
5@c configure.ac, so you should edit that file and run 5@c configure.ac, so you should edit that file and run
6@c "autoconf && ./configure" to change the version number. 6@c "autoconf && ./configure" to change the version number.
7@set trampver 2.1.12-pre 7@set trampver 2.1.12
8 8
9@c Other flags from configuration 9@c Other flags from configuration
10@set instprefix /usr/local 10@set instprefix /usr/local