diff options
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 51 | ||||
| -rw-r--r-- | doc/misc/Makefile.in | 13 | ||||
| -rw-r--r-- | doc/misc/auth.texi | 74 | ||||
| -rw-r--r-- | doc/misc/calc.texi | 235 | ||||
| -rw-r--r-- | doc/misc/message.texi | 28 | ||||
| -rw-r--r-- | doc/misc/tramp.texi | 29 | ||||
| -rw-r--r-- | doc/misc/trampver.texi | 2 |
7 files changed, 299 insertions, 133 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 2c5f998737a..50f0e4e45b9 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,54 @@ | |||
| 1 | 2011-03-17 Jay Belanger <jay.p.belanger@gmail.com> | ||
| 2 | |||
| 3 | * calc.texi (Logarithmic Units): Update the function names. | ||
| 4 | |||
| 5 | 2011-03-15 Lars Magne Ingebrigtsen <larsi@gnus.org> | ||
| 6 | |||
| 7 | * message.texi (Various Commands): Document format specs in the | ||
| 8 | ellipsis. | ||
| 9 | |||
| 10 | 2011-03-15 Antoine Levitt <antoine.levitt@gmail.com> | ||
| 11 | |||
| 12 | * message.texi (Insertion Variables): Document message-cite-style. | ||
| 13 | |||
| 14 | 2011-03-14 Michael Albinus <michael.albinus@gmx.de> | ||
| 15 | |||
| 16 | * tramp.texi (Remote processes): New subsection "Running shell on | ||
| 17 | a remote host". | ||
| 18 | |||
| 19 | 2011-03-12 Teodor Zlatanov <tzz@lifelogs.com> | ||
| 20 | |||
| 21 | * auth.texi (Help for developers): Update docs to explain that the | ||
| 22 | :save-function will only run the first time. | ||
| 23 | |||
| 24 | 2011-03-12 Glenn Morris <rgm@gnu.org> | ||
| 25 | |||
| 26 | * Makefile.in (emacs-faq.html): Fix some more cross-refs. | ||
| 27 | (emacs-faq.text): New target. | ||
| 28 | (clean): Add emacs-faq. | ||
| 29 | |||
| 30 | 2011-03-12 Michael Albinus <michael.albinus@gmx.de> | ||
| 31 | |||
| 32 | Sync with Tramp 2.2.1. | ||
| 33 | |||
| 34 | * trampver.texi: Update release number. | ||
| 35 | |||
| 36 | 2011-03-11 Glenn Morris <rgm@gnu.org> | ||
| 37 | |||
| 38 | * Makefile.in (HTML_TARGETS): New. | ||
| 39 | (clean): Delete $HTML_TARGETS. | ||
| 40 | (emacs-faq.html): New, for use with the gnu.org Emacs webpage. | ||
| 41 | |||
| 42 | 2011-03-08 Teodor Zlatanov <tzz@lifelogs.com> | ||
| 43 | |||
| 44 | * auth.texi (Help for developers): Show example of using | ||
| 45 | `auth-source-search' with prompts and :save-function. | ||
| 46 | |||
| 47 | 2011-03-07 Antoine Levitt <antoine.levitt@gmail.com> | ||
| 48 | |||
| 49 | * message.texi (Message Buffers): Update default value of | ||
| 50 | message-generate-new-buffers. | ||
| 51 | |||
| 1 | 2011-03-06 Jay Belanger <jay.p.belanger@gmail.com> | 52 | 2011-03-06 Jay Belanger <jay.p.belanger@gmail.com> |
| 2 | 53 | ||
| 3 | * calc.texi (Logarithmic Units): Rename calc-logunits-dblevel | 54 | * calc.texi (Logarithmic Units): Rename calc-logunits-dblevel |
diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in index 0a28d417c70..450199a33c5 100644 --- a/doc/misc/Makefile.in +++ b/doc/misc/Makefile.in | |||
| @@ -197,6 +197,8 @@ PDF_TARGETS = \ | |||
| 197 | widget.pdf \ | 197 | widget.pdf \ |
| 198 | woman.pdf | 198 | woman.pdf |
| 199 | 199 | ||
| 200 | HTML_TARGETS = emacs-faq.html | ||
| 201 | |||
| 200 | TEXI2DVI = texi2dvi | 202 | TEXI2DVI = texi2dvi |
| 201 | TEXI2PDF = texi2pdf | 203 | TEXI2PDF = texi2pdf |
| 202 | 204 | ||
| @@ -401,6 +403,15 @@ faq.dvi: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi | |||
| 401 | $(ENVADD) $(TEXI2DVI) $< | 403 | $(ENVADD) $(TEXI2DVI) $< |
| 402 | faq.pdf: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi | 404 | faq.pdf: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi |
| 403 | $(ENVADD) $(TEXI2PDF) $< | 405 | $(ENVADD) $(TEXI2PDF) $< |
| 406 | ## This is the name used on the Emacs web-page. | ||
| 407 | ## sed fixes up links to point to split version of the manual. | ||
| 408 | emacs-faq.html: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi | ||
| 409 | $(MAKEINFO) $(MAKEINFO_OPTS) --no-split \ | ||
| 410 | --css-ref='/layout.css' --html -o $@ $< | ||
| 411 | sed -i -e 's|a href="\([a-z]*\)\.html#\([^"]*\)"|a href="manual/html_node/\1/\2.html"|g' \ | ||
| 412 | -e 's|/Top\.html|/|g' $@ | ||
| 413 | emacs-faq.text: ${srcdir}/faq.texi $(emacsdir)/emacsver.texi | ||
| 414 | $(MAKEINFO) $(MAKEINFO_OPTS) --plaintext -o $@ $< | ||
| 404 | 415 | ||
| 405 | flymake : $(infodir)/flymake | 416 | flymake : $(infodir)/flymake |
| 406 | $(infodir)/flymake: flymake.texi | 417 | $(infodir)/flymake: flymake.texi |
| @@ -684,7 +695,7 @@ mostlyclean: | |||
| 684 | rm -f gnustmp.* | 695 | rm -f gnustmp.* |
| 685 | 696 | ||
| 686 | clean: mostlyclean | 697 | clean: mostlyclean |
| 687 | rm -f $(DVI_TARGETS) $(PDF_TARGETS) | 698 | rm -f $(DVI_TARGETS) $(PDF_TARGETS) $(HTML_TARGETS) emacs-faq.text |
| 688 | 699 | ||
| 689 | distclean: clean | 700 | distclean: clean |
| 690 | # rm -f Makefile | 701 | # rm -f Makefile |
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi index 23ac23dce5b..a16da92343e 100644 --- a/doc/misc/auth.texi +++ b/doc/misc/auth.texi | |||
| @@ -131,11 +131,11 @@ library encourages this confusion by accepting both, as you'll see | |||
| 131 | later. | 131 | later. |
| 132 | 132 | ||
| 133 | If you have problems with the search, set @code{auth-source-debug} to | 133 | If you have problems with the search, set @code{auth-source-debug} to |
| 134 | @code{t} and see what host, port, and user the library is checking in | 134 | @code{'trivia} and see what host, port, and user the library is |
| 135 | the @code{*Messages*} buffer. Ditto for any other problems, your | 135 | checking in the @code{*Messages*} buffer. Ditto for any other |
| 136 | first step is always to see what's being checked. The second step, of | 136 | problems, your first step is always to see what's being checked. The |
| 137 | course, is to write a blog entry about it and wait for the answer in | 137 | second step, of course, is to write a blog entry about it and wait for |
| 138 | the comments. | 138 | the answer in the comments. |
| 139 | 139 | ||
| 140 | You can customize the variable @code{auth-sources}. The following may | 140 | You can customize the variable @code{auth-sources}. The following may |
| 141 | be needed if you are using an older version of Emacs or if the | 141 | be needed if you are using an older version of Emacs or if the |
| @@ -232,6 +232,14 @@ TODO: how does it work generally, how does secrets.el work, some examples. | |||
| 232 | @node Help for developers | 232 | @node Help for developers |
| 233 | @chapter Help for developers | 233 | @chapter Help for developers |
| 234 | 234 | ||
| 235 | The auth-source library lets you control logging output easily. | ||
| 236 | |||
| 237 | @defvar auth-source-debug | ||
| 238 | Set this variable to 'trivia to see lots of output in *Messages*, or | ||
| 239 | set it to a function that behaves like @code{message} to do your own | ||
| 240 | logging. | ||
| 241 | @end defvar | ||
| 242 | |||
| 235 | The auth-source library only has a few functions for external use. | 243 | The auth-source library only has a few functions for external use. |
| 236 | 244 | ||
| 237 | @defun auth-source-search SPEC | 245 | @defun auth-source-search SPEC |
| @@ -240,6 +248,62 @@ TODO: how to include docstring? | |||
| 240 | 248 | ||
| 241 | @end defun | 249 | @end defun |
| 242 | 250 | ||
| 251 | Let's take a look at an example of using @code{auth-source-search} | ||
| 252 | from Gnus' @code{nnimap.el}. | ||
| 253 | |||
| 254 | @example | ||
| 255 | (defun nnimap-credentials (address ports) | ||
| 256 | (let* ((auth-source-creation-prompts | ||
| 257 | '((user . "IMAP user at %h: ") | ||
| 258 | (secret . "IMAP password for %u@@%h: "))) | ||
| 259 | (found (nth 0 (auth-source-search :max 1 | ||
| 260 | :host address | ||
| 261 | :port ports | ||
| 262 | :require '(:user :secret) | ||
| 263 | :create t)))) | ||
| 264 | (if found | ||
| 265 | (list (plist-get found :user) | ||
| 266 | (let ((secret (plist-get found :secret))) | ||
| 267 | (if (functionp secret) | ||
| 268 | (funcall secret) | ||
| 269 | secret)) | ||
| 270 | (plist-get found :save-function)) | ||
| 271 | nil))) | ||
| 272 | @end example | ||
| 273 | |||
| 274 | This call requires the user and password (secret) to be in the | ||
| 275 | results. It also requests that an entry be created if it doesn't | ||
| 276 | exist already. While the created entry is being assembled, the shown | ||
| 277 | prompts will be used to interact with the user. The caller can also | ||
| 278 | pass data in @code{auth-source-creation-defaults} to supply defaults | ||
| 279 | for any of the prompts. | ||
| 280 | |||
| 281 | Note that the password needs to be evaluated if it's a function. It's | ||
| 282 | wrapped in a function to provide some security. | ||
| 283 | |||
| 284 | Later, after a successful login, @code{nnimal.el} calls the | ||
| 285 | @code{:save-function} like so: | ||
| 286 | |||
| 287 | @example | ||
| 288 | (when (functionp (nth 2 credentials)) | ||
| 289 | (funcall (nth 2 credentials))) | ||
| 290 | @end example | ||
| 291 | |||
| 292 | This will work whether the @code{:save-function} was provided or not. | ||
| 293 | @code{:save-function} will be provided only when a new entry was | ||
| 294 | created, so this effectively says ``after a successful login, save the | ||
| 295 | authentication information we just used, if it was newly created.'' | ||
| 296 | |||
| 297 | After the first time it's called, the @code{:save-function} will not | ||
| 298 | run again (but it will log something if you have set | ||
| 299 | @code{auth-source-debug} to @code{'trivia}). This is so it won't ask | ||
| 300 | the same question again, which is annoying. This is so it won't ask | ||
| 301 | the same question again, which is annoying. This is so it won't ask | ||
| 302 | the same question again, which is annoying. | ||
| 303 | |||
| 304 | So the responsibility of the API user that specified @code{:create t} | ||
| 305 | is to call the @code{:save-function} if it's provided. | ||
| 306 | |||
| 243 | @defun auth-source-delete SPEC | 307 | @defun auth-source-delete SPEC |
| 244 | 308 | ||
| 245 | TODO: how to include docstring? | 309 | TODO: how to include docstring? |
diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 88103fc0034..f732eff5690 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi | |||
| @@ -28126,47 +28126,15 @@ tell Calc to use a different file for the Calc init file.) | |||
| 28126 | @section Logarithmic Units | 28126 | @section Logarithmic Units |
| 28127 | 28127 | ||
| 28128 | The units @code{dB} (decibels) and @code{Np} (nepers) are logarithmic | 28128 | The units @code{dB} (decibels) and @code{Np} (nepers) are logarithmic |
| 28129 | units which are typically manipulated differently than standard units. | 28129 | units which are manipulated differently than standard units. Calc |
| 28130 | Calc provides commands to work with these logarithmic units. | 28130 | provides commands to work with these logarithmic units. |
| 28131 | 28131 | ||
| 28132 | Decibels and nepers are used to measure power quantities as well as | 28132 | Decibels and nepers are used to measure power quantities as well as |
| 28133 | field quantities (quantities whose squares are proportional to power). | 28133 | field quantities (quantities whose squares are proportional to power); |
| 28134 | The decibel and neper values of a quantity are relative to | 28134 | these two types of quantities are handled slightly different from each |
| 28135 | a reference quantity; for example, the decibel value of a sound | 28135 | other. By default the Calc commands work as if power quantities are |
| 28136 | pressure level of | 28136 | being used; with the @kbd{H} prefix the Calc commands work as if field |
| 28137 | @infoline @math{60 uPa} | 28137 | quantities are being used. |
| 28138 | @texline @math{60 \mu{\rm Pa}} | ||
| 28139 | relative to | ||
| 28140 | @infoline @math{20 uPa} | ||
| 28141 | @texline @math{20 \mu{\rm Pa}} | ||
| 28142 | (the threshhold of human hearing) is | ||
| 28143 | @infoline @math{20 log10(60 uPa/ 20 uPa) dB = 20 log10(3) dB}, | ||
| 28144 | @texline @math{20 \log_{10}(60 \mu{\rm Pa}/20 \mu{\rm Pa}) {\rm dB} = 20 \log_{10}(3) {\rm dB}}, | ||
| 28145 | which is about | ||
| 28146 | @infoline @math{9.54 dB}. | ||
| 28147 | @texline @math{9.54 {\rm dB}}. | ||
| 28148 | Note that in taking the ratio, the original units cancel and so these | ||
| 28149 | logarithmic units are dimensionless. | ||
| 28150 | |||
| 28151 | @vindex calc-logunits-power-reference | ||
| 28152 | @vindex calc-logunits-field-reference | ||
| 28153 | The Calc commands for the logarithmic units assume that power quantities | ||
| 28154 | are being used unless the @kbd{H} prefix is used, in which case they assume that | ||
| 28155 | field quantities are being used. For power quantities, Calc uses | ||
| 28156 | @infoline @math{1 mW} | ||
| 28157 | @texline @math{1 {\rm mW}} | ||
| 28158 | as the default reference quantity; this default can be changed by changing | ||
| 28159 | the value of the customizable variable | ||
| 28160 | @code{calc-logunits-power-reference} (@pxref{Customizing Calc}). | ||
| 28161 | For field quantities, Calc uses | ||
| 28162 | @infoline @math{20 uPa} | ||
| 28163 | @texline @math{20 \mu{\rm Pa}} | ||
| 28164 | as the default reference quantity; this is the value used in acoustics | ||
| 28165 | which is where decibels are commonly encountered. This default can be | ||
| 28166 | changed by changing the value of the customizable variable | ||
| 28167 | @code{calc-logunits-field-reference} (@pxref{Customizing Calc}). A | ||
| 28168 | non-default reference quantity will be read from the stack if the | ||
| 28169 | capital @kbd{O} prefix is used. | ||
| 28170 | 28138 | ||
| 28171 | The decibel level of a power | 28139 | The decibel level of a power |
| 28172 | @infoline @math{P1}, | 28140 | @infoline @math{P1}, |
| @@ -28214,6 +28182,20 @@ relative to a reference | |||
| 28214 | is defined as | 28182 | is defined as |
| 28215 | @infoline @math{20 log10(F1/F0) dB}. | 28183 | @infoline @math{20 log10(F1/F0) dB}. |
| 28216 | @texline @math{20 \log_{10}(F_{1}/F_{0}) {\rm dB}}. | 28184 | @texline @math{20 \log_{10}(F_{1}/F_{0}) {\rm dB}}. |
| 28185 | For example, the decibel value of a sound pressure level of | ||
| 28186 | @infoline @math{60 uPa} | ||
| 28187 | @texline @math{60 \mu{\rm Pa}} | ||
| 28188 | relative to | ||
| 28189 | @infoline @math{20 uPa} | ||
| 28190 | @texline @math{20 \mu{\rm Pa}} | ||
| 28191 | (the threshhold of human hearing) is | ||
| 28192 | @infoline @math{20 log10(60 uPa/ 20 uPa) dB = 20 log10(3) dB}, | ||
| 28193 | @texline @math{20 \log_{10}(60 \mu{\rm Pa}/20 \mu{\rm Pa}) {\rm dB} = 20 \log_{10}(3) {\rm dB}}, | ||
| 28194 | which is about | ||
| 28195 | @infoline @math{9.54 dB}. | ||
| 28196 | @texline @math{9.54 {\rm dB}}. | ||
| 28197 | Note that in taking the ratio, the original units cancel and so these | ||
| 28198 | logarithmic units are dimensionless. | ||
| 28217 | 28199 | ||
| 28218 | Nepers (named after John Napier, who is credited with inventing the | 28200 | Nepers (named after John Napier, who is credited with inventing the |
| 28219 | logarithm) are similar to bels except they use natural logarithms instead | 28201 | logarithm) are similar to bels except they use natural logarithms instead |
| @@ -28236,55 +28218,72 @@ is | |||
| 28236 | @infoline @math{ln(F1/F0) Np}. | 28218 | @infoline @math{ln(F1/F0) Np}. |
| 28237 | @texline @math{\ln(F_1/F_0) {\rm Np}}. | 28219 | @texline @math{\ln(F_1/F_0) {\rm Np}}. |
| 28238 | 28220 | ||
| 28221 | @vindex calc-lu-power-reference | ||
| 28222 | @vindex calc-lu-field-reference | ||
| 28223 | For power quantities, Calc uses | ||
| 28224 | @infoline @math{1 mW} | ||
| 28225 | @texline @math{1 {\rm mW}} | ||
| 28226 | as the default reference quantity; this default can be changed by changing | ||
| 28227 | the value of the customizable variable | ||
| 28228 | @code{calc-lu-power-reference} (@pxref{Customizing Calc}). | ||
| 28229 | For field quantities, Calc uses | ||
| 28230 | @infoline @math{20 uPa} | ||
| 28231 | @texline @math{20 \mu{\rm Pa}} | ||
| 28232 | as the default reference quantity; this is the value used in acoustics | ||
| 28233 | which is where decibels are commonly encountered. This default can be | ||
| 28234 | changed by changing the value of the customizable variable | ||
| 28235 | @code{calc-lu-field-reference} (@pxref{Customizing Calc}). A | ||
| 28236 | non-default reference quantity will be read from the stack if the | ||
| 28237 | capital @kbd{O} prefix is used. | ||
| 28238 | |||
| 28239 | @kindex l q | 28239 | @kindex l q |
| 28240 | @pindex calc-logunits-quantity | 28240 | @pindex calc-lu-quant |
| 28241 | @tindex powerquant | 28241 | @tindex lupquant |
| 28242 | @tindex fieldquant | 28242 | @tindex lufquant |
| 28243 | The @kbd{l q} (@code{calc-logunits-quantity}) [@code{powerquant}] | 28243 | The @kbd{l q} (@code{calc-lu-quant}) [@code{lupquant}] |
| 28244 | command computes the power quantity corresponding to a given number of | 28244 | command computes the power quantity corresponding to a given number of |
| 28245 | logarithmic units. With the capital @kbd{O} prefix, @kbd{O l q}, the | 28245 | logarithmic units. With the capital @kbd{O} prefix, @kbd{O l q}, the |
| 28246 | reference level will be read from the top of the stack. (In an | 28246 | reference level will be read from the top of the stack. (In an |
| 28247 | algebraic formula, @code{powerquant} can be given an optional second | 28247 | algebraic formula, @code{lupquant} can be given an optional second |
| 28248 | argument which will be used for the reference level.) For example, | 28248 | argument which will be used for the reference level.) For example, |
| 28249 | @code{20 dB @key{RET} l q} will return @code{100 mW}; | 28249 | @code{20 dB @key{RET} l q} will return @code{100 mW}; |
| 28250 | @code{20 dB @key{RET} 4 W @key{RET} O l q} will return @code{400 W}. | 28250 | @code{20 dB @key{RET} 4 W @key{RET} O l q} will return @code{400 W}. |
| 28251 | The @kbd{H l q} [@code{fieldquant}] command behaves like @kbd{l q} but | 28251 | The @kbd{H l q} [@code{lufquant}] command behaves like @kbd{l q} but |
| 28252 | computes field quantities instead of power quantities. | 28252 | computes field quantities instead of power quantities. |
| 28253 | 28253 | ||
| 28254 | @kindex l d | 28254 | @kindex l d |
| 28255 | @pindex calc-dblevel | 28255 | @pindex calc-db |
| 28256 | @tindex dbpowerlevel | 28256 | @tindex dbpower |
| 28257 | @tindex dbfieldlevel | 28257 | @tindex dbfield |
| 28258 | @kindex l n | 28258 | @kindex l n |
| 28259 | @pindex calc-nplevel | 28259 | @pindex calc-np |
| 28260 | @tindex nppowerlevel | 28260 | @tindex nppower |
| 28261 | @tindex npfieldlevel | 28261 | @tindex npfield |
| 28262 | The @kbd{l d} (@code{calc-dblevel}) [@code{dbpowerlevel}] | 28262 | The @kbd{l d} (@code{calc-db}) [@code{dbpower}] command will compute |
| 28263 | command will compute the decibel level of a power quantity using the | 28263 | the decibel level of a power quantity using the default reference |
| 28264 | default reference level; @kbd{H l d} [@code{dbfieldlevel}] will | 28264 | level; @kbd{H l d} [@code{dbfield}] will compute the decibel level of |
| 28265 | compute the decibel level of a field quantity. The commands @kbd{l n} | 28265 | a field quantity. The commands @kbd{l n} (@code{calc-np}) |
| 28266 | (@code{calc-nplevel}) [@code{nppowerlevel}] and @kbd{H l n} | 28266 | [@code{nppower}] and @kbd{H l n} [@code{npfield}] will similarly |
| 28267 | [@code{npfieldlevel}] will similarly compute neper levels. With the | 28267 | compute neper levels. With the capital @kbd{O} prefix these commands |
| 28268 | capital @kbd{O} prefix these commands will read a reference level | 28268 | will read a reference level from the stack; in an algebraic formula |
| 28269 | from the stack; in an algebraic formula the reference level can be | 28269 | the reference level can be given as an optional second argument. |
| 28270 | given as an optional second argument. | ||
| 28271 | 28270 | ||
| 28272 | @kindex l + | 28271 | @kindex l + |
| 28273 | @pindex calc-logunits-add | 28272 | @pindex calc-lu-plus |
| 28274 | @tindex lupoweradd | 28273 | @tindex lupadd |
| 28275 | @tindex lufieldadd | 28274 | @tindex lufadd |
| 28276 | @kindex l - | 28275 | @kindex l - |
| 28277 | @pindex calc-logunits-sub | 28276 | @pindex calc-lu-minus |
| 28278 | @tindex lupowersub | 28277 | @tindex lupsub |
| 28279 | @tindex lufieldsub | 28278 | @tindex lufsub |
| 28280 | @kindex l * | 28279 | @kindex l * |
| 28281 | @pindex calc-logunits-mul | 28280 | @pindex calc-lu-times |
| 28282 | @tindex lupowermul | 28281 | @tindex lupmul |
| 28283 | @tindex lufieldmul | 28282 | @tindex lufmul |
| 28284 | @kindex l / | 28283 | @kindex l / |
| 28285 | @pindex calc-logunits-div | 28284 | @pindex calc-lu-divide |
| 28286 | @tindex lupowerdiv | 28285 | @tindex lupdiv |
| 28287 | @tindex lufielddiv | 28286 | @tindex lufdiv |
| 28288 | The sum of two power or field quantities doesn't correspond to the sum | 28287 | The sum of two power or field quantities doesn't correspond to the sum |
| 28289 | of the corresponding decibel or neper levels. If the powers | 28288 | of the corresponding decibel or neper levels. If the powers |
| 28290 | corresponding to decibel levels | 28289 | corresponding to decibel levels |
| @@ -28305,13 +28304,13 @@ $$ 10 \log_{10}(10^{D_1/10} + 10^{D_2/10}) {\rm dB}.$$ | |||
| 28305 | @end tex | 28304 | @end tex |
| 28306 | 28305 | ||
| 28307 | @noindent | 28306 | @noindent |
| 28308 | When field quantities are combined, it often means the | 28307 | When field quantities are combined, it often means the corresponding |
| 28309 | corresponding powers are added and so the above formula might be used. | 28308 | powers are added and so the above formula might be used. In |
| 28310 | In acoustics, for example, the decibel sound pressure level is defined | 28309 | acoustics, for example, the sound pressure level is a field quantity |
| 28311 | using the field formula but the sound pressure levels are combined | 28310 | and so the decibels are often defined using the field formula, but the |
| 28312 | as the sound power levels, and so the above formula should be used. If | 28311 | sound pressure levels are combined as the sound power levels, and so |
| 28313 | two field quantities themselves are added, the new decibel level will be | 28312 | the above formula should be used. If two field quantities themselves |
| 28314 | 28313 | are added, the new decibel level will be | |
| 28315 | 28314 | ||
| 28316 | @ifnottex | 28315 | @ifnottex |
| 28317 | @example | 28316 | @example |
| @@ -28349,20 +28348,18 @@ $$ D + 20 \log_{10}(N) {\rm dB}.$$ | |||
| 28349 | @end tex | 28348 | @end tex |
| 28350 | 28349 | ||
| 28351 | @noindent | 28350 | @noindent |
| 28352 | There are similar formulas for combining nepers. | 28351 | There are similar formulas for combining nepers. The @kbd{l +} |
| 28353 | The @kbd{l +} (@code{calc-logunits-add}) [@code{lupoweradd}] command | 28352 | (@code{calc-lu-plus}) [@code{lupadd}] command will ``add'' two |
| 28354 | will ``add'' two logarithmic unit power levels this way; with the | 28353 | logarithmic unit power levels this way; with the @kbd{H} prefix, |
| 28355 | @kbd{H} prefix, @kbd{H l +} [@code{lufieldadd}] will add logarithmic | 28354 | @kbd{H l +} [@code{lufadd}] will add logarithmic unit field levels. |
| 28356 | unit field levels. Similarly, logarithmic units can be | 28355 | Similarly, logarithmic units can be ``subtracted'' with @kbd{l -} |
| 28357 | ``subtracted'' with @kbd{l -} (@code{calc-logunits-sub}) | 28356 | (@code{calc-lu-minus}) [@code{lupsub}] or @kbd{H l -} [@code{lufsub}]. |
| 28358 | [@code{lupowersub}] or @kbd{H l -} [@code{lufieldsub}]. | 28357 | The @kbd{l *} (@code{calc-lu-times}) [@code{lupmul}] and @kbd{H l *} |
| 28359 | The @kbd{l *} (@code{calc-logunits-mul}) [@code{lupowermul}] | 28358 | [@code{lufmul}] commands will ``multiply'' a logarithmic unit by a |
| 28360 | and @kbd{H l *} [@code{lufieldmul}] commands will ``multiply'' | 28359 | number; the @kbd{l /} (@code{calc-lu-divide}) [@code{lupdiv}] and |
| 28361 | a logarithmic unit by a number; the @kbd{l /} | 28360 | @kbd{H l /} [@code{lufdiv}] commands will ``divide'' a logarithmic |
| 28362 | (@code{calc-logunits-divide}) [@code{lupowerdiv}] and | 28361 | unit by a number. Note that the reference quantities don't play a role |
| 28363 | @kbd{H l /} [@code{lufielddiv}] commands will ``divide'' a | 28362 | in this arithmetic. |
| 28364 | logarithmic unit by a number. Note that the reference quantities don't | ||
| 28365 | play a role in this arithmetic. | ||
| 28366 | 28363 | ||
| 28367 | @node Musical Notes, , Logarithmic Units, Units | 28364 | @node Musical Notes, , Logarithmic Units, Units |
| 28368 | @section Musical Notes | 28365 | @section Musical Notes |
| @@ -35539,16 +35536,16 @@ should also be added to @code{calc-embedded-announce-formula-alist} | |||
| 35539 | and @code{calc-embedded-open-close-plain-alist}. | 35536 | and @code{calc-embedded-open-close-plain-alist}. |
| 35540 | @end defvar | 35537 | @end defvar |
| 35541 | 35538 | ||
| 35542 | @defvar calc-logunits-power-reference | 35539 | @defvar calc-lu-power-reference |
| 35543 | @defvarx calc-logunits-field-reference | 35540 | @defvarx calc-lu-field-reference |
| 35544 | See @ref{Logarithmic Units}.@* | 35541 | See @ref{Logarithmic Units}.@* |
| 35545 | The variables @code{calc-logunits-power-reference} and | 35542 | The variables @code{calc-lu-power-reference} and |
| 35546 | @code{calc-logunits-field-reference} are unit expressions (written as | 35543 | @code{calc-lu-field-reference} are unit expressions (written as |
| 35547 | strings) which Calc will use as reference quantities for logarithmic | 35544 | strings) which Calc will use as reference quantities for logarithmic |
| 35548 | units. | 35545 | units. |
| 35549 | 35546 | ||
| 35550 | The default value of @code{calc-logunits-power-reference} is @code{"mW"} | 35547 | The default value of @code{calc-lu-power-reference} is @code{"mW"} |
| 35551 | and the default value of @code{calc-logunits-field-reference} is | 35548 | and the default value of @code{calc-lu-field-reference} is |
| 35552 | @code{"20 uPa"}. | 35549 | @code{"20 uPa"}. |
| 35553 | @end defvar | 35550 | @end defvar |
| 35554 | 35551 | ||
| @@ -36209,26 +36206,26 @@ keystrokes are not listed in this summary. | |||
| 36209 | @r{ v x@: I k T @: @: @:ltpt@:(x,v)} | 36206 | @r{ v x@: I k T @: @: @:ltpt@:(x,v)} |
| 36210 | 36207 | ||
| 36211 | @c | 36208 | @c |
| 36212 | @r{ a b@: l + @: @: @:lupoweradd@:(a,b)} | 36209 | @r{ a b@: l + @: @: @:lupadd@:(a,b)} |
| 36213 | @r{ a b@: H l + @: @: @:lufieldadd@:(a,b)} | 36210 | @r{ a b@: H l + @: @: @:lufadd@:(a,b)} |
| 36214 | @r{ a b@: l - @: @: @:lupowersub@:(a,b)} | 36211 | @r{ a b@: l - @: @: @:lupsub@:(a,b)} |
| 36215 | @r{ a b@: H l - @: @: @:lufieldsub@:(a,b)} | 36212 | @r{ a b@: H l - @: @: @:lufsub@:(a,b)} |
| 36216 | @r{ a b@: l * @: @: @:lupowermul@:(a,b)} | 36213 | @r{ a b@: l * @: @: @:lupmul@:(a,b)} |
| 36217 | @r{ a b@: H l * @: @: @:lufieldmul@:(a,b)} | 36214 | @r{ a b@: H l * @: @: @:lufmul@:(a,b)} |
| 36218 | @r{ a b@: l / @: @: @:lupowerdiv@:(a,b)} | 36215 | @r{ a b@: l / @: @: @:lupdiv@:(a,b)} |
| 36219 | @r{ a b@: H l / @: @: @:lufielddiv@:(a,b)} | 36216 | @r{ a b@: H l / @: @: @:lufdiv@:(a,b)} |
| 36220 | @r{ a@: l d @: @: @:dbpowerlevel@:(a)} | 36217 | @r{ a@: l d @: @: @:dbpower@:(a)} |
| 36221 | @r{ a b@: O l d @: @: @:dbpowerlevel@:(a,b)} | 36218 | @r{ a b@: O l d @: @: @:dbpower@:(a,b)} |
| 36222 | @r{ a@: H l d @: @: @:dbfieldlevel@:(a)} | 36219 | @r{ a@: H l d @: @: @:dbfield@:(a)} |
| 36223 | @r{ a b@: O H l d @: @: @:dbfieldlevel@:(a,b)} | 36220 | @r{ a b@: O H l d @: @: @:dbfield@:(a,b)} |
| 36224 | @r{ a@: l n @: @: @:nppowerlevel@:(a)} | 36221 | @r{ a@: l n @: @: @:nppower@:(a)} |
| 36225 | @r{ a b@: O l n @: @: @:nppowerlevel@:(a,b)} | 36222 | @r{ a b@: O l n @: @: @:nppower@:(a,b)} |
| 36226 | @r{ a@: H l n @: @: @:npfieldlevel@:(a)} | 36223 | @r{ a@: H l n @: @: @:npfield@:(a)} |
| 36227 | @r{ a b@: O H l n @: @: @:npfieldlevel@:(a,b)} | 36224 | @r{ a b@: O H l n @: @: @:npfield@:(a,b)} |
| 36228 | @r{ a@: l q @: @: @:powerquant@:(a)} | 36225 | @r{ a@: l q @: @: @:lupquant@:(a)} |
| 36229 | @r{ a b@: O l q @: @: @:powerquant@:(a,b)} | 36226 | @r{ a b@: O l q @: @: @:lupquant@:(a,b)} |
| 36230 | @r{ a@: H l q @: @: @:fieldquant@:(a)} | 36227 | @r{ a@: H l q @: @: @:lufquant@:(a)} |
| 36231 | @r{ a b@: O H l q @: @: @:fieldquant@:(a,b)} | 36228 | @r{ a b@: O H l q @: @: @:lufquant@:(a,b)} |
| 36232 | @r{ a@: l s @: @: @:spn@:(a)} | 36229 | @r{ a@: l s @: @: @:spn@:(a)} |
| 36233 | @r{ a@: l m @: @: @:midi@:(a)} | 36230 | @r{ a@: l m @: @: @:midi@:(a)} |
| 36234 | @r{ a@: l f @: @: @:freq@:(a)} | 36231 | @r{ a@: l f @: @: @:freq@:(a)} |
diff --git a/doc/misc/message.texi b/doc/misc/message.texi index b28639907ed..48d0028e452 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi | |||
| @@ -1202,6 +1202,10 @@ The text is killed and replaced with the contents of the variable | |||
| 1202 | @code{message-elide-ellipsis}. The default value is to use an ellipsis | 1202 | @code{message-elide-ellipsis}. The default value is to use an ellipsis |
| 1203 | (@samp{[...]}). | 1203 | (@samp{[...]}). |
| 1204 | 1204 | ||
| 1205 | This is a format-spec string, and you can use @samp{%l} to say how | ||
| 1206 | many lines were removed, and @samp{%c} to say how many characters were | ||
| 1207 | removed. | ||
| 1208 | |||
| 1205 | @item C-c M-k | 1209 | @item C-c M-k |
| 1206 | @kindex C-c M-k | 1210 | @kindex C-c M-k |
| 1207 | @findex message-kill-address | 1211 | @findex message-kill-address |
| @@ -1930,6 +1934,25 @@ posting a prepared news message. | |||
| 1930 | @section Insertion Variables | 1934 | @section Insertion Variables |
| 1931 | 1935 | ||
| 1932 | @table @code | 1936 | @table @code |
| 1937 | @item message-cite-style | ||
| 1938 | @vindex message-cite-style | ||
| 1939 | The overall style to be used when replying to messages. This controls | ||
| 1940 | things like where the reply should be put relative to the original, | ||
| 1941 | how the citation is formatted, where the signature goes, etc. | ||
| 1942 | |||
| 1943 | Value is either @code{nil} (no variable overrides) or a let-style list | ||
| 1944 | of pairs @code{(VARIABLE VALUE)} to override default values. | ||
| 1945 | |||
| 1946 | See @code{gnus-posting-styles} to set this variable for specific | ||
| 1947 | groups. Presets to impersonate popular mail agents are available in the | ||
| 1948 | @code{message-cite-style-*} variables. | ||
| 1949 | |||
| 1950 | @item message-cite-reply-position | ||
| 1951 | @vindex message-cite-reply-position | ||
| 1952 | Where the reply should be positioned. Available styles are | ||
| 1953 | @code{traditional} to reply inline, @code{above} for top-posting, and | ||
| 1954 | @code{below} for bottom-posting | ||
| 1955 | |||
| 1933 | @item message-ignored-cited-headers | 1956 | @item message-ignored-cited-headers |
| 1934 | @vindex message-ignored-cited-headers | 1957 | @vindex message-ignored-cited-headers |
| 1935 | All headers that match this regexp will be removed from yanked | 1958 | All headers that match this regexp will be removed from yanked |
| @@ -2298,8 +2321,7 @@ created. | |||
| 2298 | 2321 | ||
| 2299 | @item unique | 2322 | @item unique |
| 2300 | @item t | 2323 | @item t |
| 2301 | Create the new buffer with the name generated in the Message way. This | 2324 | Create the new buffer with the name generated in the Message way. |
| 2302 | is the default. | ||
| 2303 | 2325 | ||
| 2304 | @item unsent | 2326 | @item unsent |
| 2305 | Similar to @code{unique} but the buffer name begins with "*unsent ". | 2327 | Similar to @code{unique} but the buffer name begins with "*unsent ". |
| @@ -2315,7 +2337,7 @@ type, the To address and the group name (any of these may be | |||
| 2315 | @code{nil}). The function should return the new buffer name. | 2337 | @code{nil}). The function should return the new buffer name. |
| 2316 | @end table | 2338 | @end table |
| 2317 | 2339 | ||
| 2318 | The default value is @code{unique}. | 2340 | The default value is @code{unsent}. |
| 2319 | 2341 | ||
| 2320 | @item message-max-buffers | 2342 | @item message-max-buffers |
| 2321 | @vindex message-max-buffers | 2343 | @vindex message-max-buffers |
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index bdbba437af7..e1c4a806de2 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -2540,7 +2540,28 @@ Another trick might be that you put @code{ForwardX11 yes} or | |||
| 2540 | that host. | 2540 | that host. |
| 2541 | 2541 | ||
| 2542 | 2542 | ||
| 2543 | @subsection Running shell-command on a remote host | 2543 | @subsection Running @code{shell} on a remote host |
| 2544 | @cindex shell | ||
| 2545 | |||
| 2546 | Calling @code{M-x shell} in a buffer related to a remote host runs the | ||
| 2547 | local shell as defined in @option{shell-file-name}. This might be | ||
| 2548 | also a valid path name for a shell to be applied on the remote host, | ||
| 2549 | but it will fail at least when your local and remote hosts belong to | ||
| 2550 | different system types, like @samp{windows-nt} and @samp{gnu/linux}. | ||
| 2551 | |||
| 2552 | You must set the variable @option{explicit-shell-file-name} to the | ||
| 2553 | shell path name on the remote host, in order to start that shell on | ||
| 2554 | the remote host. | ||
| 2555 | |||
| 2556 | @ifset emacs | ||
| 2557 | Starting with Emacs 24 this won't be necessary, if you call | ||
| 2558 | @code{shell} interactively. You will be asked for the remote shell | ||
| 2559 | path, if you are on a remote buffer, and if | ||
| 2560 | @option{explicit-shell-file-name} is equal to @code{nil}. | ||
| 2561 | @end ifset | ||
| 2562 | |||
| 2563 | |||
| 2564 | @subsection Running @code{shell-command} on a remote host | ||
| 2544 | @cindex shell-command | 2565 | @cindex shell-command |
| 2545 | 2566 | ||
| 2546 | @code{shell-command} allows to execute commands in a shell, either | 2567 | @code{shell-command} allows to execute commands in a shell, either |
| @@ -2556,13 +2577,13 @@ You will see the buffer @file{*Async Shell Command*}, containing the | |||
| 2556 | continuous output of the @command{tail} command. | 2577 | continuous output of the @command{tail} command. |
| 2557 | 2578 | ||
| 2558 | 2579 | ||
| 2559 | @subsection Running eshell on a remote host | 2580 | @subsection Running @code{eshell} on a remote host |
| 2560 | @cindex eshell | 2581 | @cindex eshell |
| 2561 | 2582 | ||
| 2562 | @value{tramp} is integrated into @file{eshell.el}. That is, you can | 2583 | @value{tramp} is integrated into @file{eshell.el}. That is, you can |
| 2563 | open an interactive shell on your remote host, and run commands there. | 2584 | open an interactive shell on your remote host, and run commands there. |
| 2564 | After you have started @code{eshell}, you could perform commands like | 2585 | After you have started @code{M-x eshell}, you could perform commands |
| 2565 | this: | 2586 | like this: |
| 2566 | 2587 | ||
| 2567 | @example | 2588 | @example |
| 2568 | @b{~ $} cd @trampfn{sudo, , , /etc} @key{RET} | 2589 | @b{~ $} cd @trampfn{sudo, , , /etc} @key{RET} |
diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 437b1372c11..e4c444980c8 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi | |||
| @@ -8,7 +8,7 @@ | |||
| 8 | @c In the Tramp CVS, the version number is auto-frobbed from | 8 | @c In the Tramp CVS, the version number is auto-frobbed from |
| 9 | @c configure.ac, so you should edit that file and run | 9 | @c configure.ac, so you should edit that file and run |
| 10 | @c "autoconf && ./configure" to change the version number. | 10 | @c "autoconf && ./configure" to change the version number. |
| 11 | @set trampver 2.2.1-pre | 11 | @set trampver 2.2.1 |
| 12 | 12 | ||
| 13 | @c Other flags from configuration | 13 | @c Other flags from configuration |
| 14 | @set instprefix /usr/local | 14 | @set instprefix /usr/local |