diff options
| author | Kai Großjohann | 2003-03-29 15:16:57 +0000 |
|---|---|---|
| committer | Kai Großjohann | 2003-03-29 15:16:57 +0000 |
| commit | b1a2b924ce45cc99bd148afc65637841e88e314b (patch) | |
| tree | 71a7254ba9aa43491c0e075c43524bd2603df99c /man | |
| parent | ef6e365d099f5f2cd75d8ca783436e503fa5dabe (diff) | |
| download | emacs-b1a2b924ce45cc99bd148afc65637841e88e314b.tar.gz emacs-b1a2b924ce45cc99bd148afc65637841e88e314b.zip | |
* tramp.el: Version 2.0.31 released.
(tramp-handle-expand-file-name): Do not allow ".." to
cross file handler boundaries, so that "/user@host:/../foo"
expands to itself, rather than "/foo". This is intended to work
in conjunction with a change in `file-relative-name' which makes
sure to use absolute file names if FILE and DIRECTORY have
different handlers.
(tramp-handle-insert-directory): Comment out XEmacs
kludge. Suggested by Katsumi Yamaoka <yamaoka@jpl.org>.
* Makefile.in (../info/tramp): Compile Emacs, instead of XEmacs,
version of manual.
* tramp.texi (Auto-save and Backup): New node.
Diffstat (limited to 'man')
| -rw-r--r-- | man/ChangeLog | 22 | ||||
| -rw-r--r-- | man/Makefile.in | 2 | ||||
| -rw-r--r-- | man/tramp.texi | 280 | ||||
| -rw-r--r-- | man/trampver.texi | 14 |
4 files changed, 245 insertions, 73 deletions
diff --git a/man/ChangeLog b/man/ChangeLog index 0757be1618d..9ffd9145fd7 100644 --- a/man/ChangeLog +++ b/man/ChangeLog | |||
| @@ -1,3 +1,25 @@ | |||
| 1 | 2003-03-29 Kai Gro,A_(Bjohann <kai.grossjohann@gmx.net> | ||
| 2 | |||
| 3 | * Makefile.in (../info/tramp): Compile Emacs, instead of XEmacs, | ||
| 4 | version of manual. | ||
| 5 | |||
| 6 | * tramp.texi (Auto-save and Backup): New node. | ||
| 7 | |||
| 8 | 2003-03-29 Michael Albinus <Michael.Albinus@alcatel.de> | ||
| 9 | |||
| 10 | * tramp.texi (Top): Include trampver.texi. Rename "Emacs" to "GNU | ||
| 11 | Emacs" in order to have better differentiation to "XEmacs". | ||
| 12 | `emacs-other-name', `emacs-other-dir' and `emacs-other-file-name' | ||
| 13 | are new macros in order to point to the other Emacs flavor where | ||
| 14 | appropriate. In info case, point to node `Installation' in order | ||
| 15 | to explain how to generate the other way. In html case, make a | ||
| 16 | link to the other html file. | ||
| 17 | (Obtaining TRAMP): Added a paragraph saying to perform `autoconf' | ||
| 18 | after CVS checkout/update. | ||
| 19 | (Installation): Completely rewritten. | ||
| 20 | (Installation parameters, Load paths): New sections under | ||
| 21 | `Installation'. | ||
| 22 | |||
| 1 | 2003-02-28 Kai Gro,A_(Bjohann <kai.grossjohann@uni-duisburg.de> | 23 | 2003-02-28 Kai Gro,A_(Bjohann <kai.grossjohann@uni-duisburg.de> |
| 2 | 24 | ||
| 3 | * tramp.texi: Version 2.0.30 released. | 25 | * tramp.texi: Version 2.0.30 released. |
diff --git a/man/Makefile.in b/man/Makefile.in index 54bc0709a50..bb179e7d545 100644 --- a/man/Makefile.in +++ b/man/Makefile.in | |||
| @@ -268,7 +268,7 @@ emacs-mime.dvi: emacs-mime.texi | |||
| 268 | $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-mime.texi | 268 | $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-mime.texi |
| 269 | 269 | ||
| 270 | ../info/tramp: tramp.texi | 270 | ../info/tramp: tramp.texi |
| 271 | cd $(srcdir); $(MAKEINFO) tramp.texi | 271 | cd $(srcdir); $(MAKEINFO) -D emacs tramp.texi |
| 272 | tramp.dvi: tramp.texi | 272 | tramp.dvi: tramp.texi |
| 273 | $(ENVADD) $(TEXI2DVI) ${srcdir}/tramp.texi | 273 | $(ENVADD) $(TEXI2DVI) ${srcdir}/tramp.texi |
| 274 | 274 | ||
diff --git a/man/tramp.texi b/man/tramp.texi index 2d7be7d001b..3deb7872d8c 100644 --- a/man/tramp.texi +++ b/man/tramp.texi | |||
| @@ -8,12 +8,10 @@ | |||
| 8 | @c This is *so* much nicer :) | 8 | @c This is *so* much nicer :) |
| 9 | @footnotestyle end | 9 | @footnotestyle end |
| 10 | 10 | ||
| 11 | @c In the Tramp CVS, the version number is auto-frobbed from the | 11 | @c In the Tramp CVS, the version number is auto-frobbed from |
| 12 | @c Makefile, so you should edit the top-level Makefile to change | 12 | @c configure.ac, so you should edit that file and run |
| 13 | @c the version number. | 13 | @c "autoconf && ./configure" to change the version number. |
| 14 | @macro trampver{} | 14 | @include trampver.texi |
| 15 | 2.0.30 | ||
| 16 | @end macro | ||
| 17 | 15 | ||
| 18 | @c Entries for @command{install-info} to use | 16 | @c Entries for @command{install-info} to use |
| 19 | @dircategory Emacs | 17 | @dircategory Emacs |
| @@ -27,15 +25,16 @@ | |||
| 27 | @sc{tramp} | 25 | @sc{tramp} |
| 28 | @end macro | 26 | @end macro |
| 29 | 27 | ||
| 30 | @c Distinguish between GNU Emacs and XEmacs. Derived from the | ||
| 31 | @c Makefile variable $(EMACS-ID). Valid values are `emacs' and `xemacs'. | ||
| 32 | @set emacs | ||
| 33 | |||
| 34 | @c Some flags which make the text independent on the (X)Emacs flavor. | 28 | @c Some flags which make the text independent on the (X)Emacs flavor. |
| 29 | @c "emacs" resp "xemacs" are set in the Makefile. | ||
| 30 | |||
| 35 | @c GNU Emacs values. | 31 | @c GNU Emacs values. |
| 36 | @ifset emacs | 32 | @ifset emacs |
| 37 | @set emacs-name Emacs | 33 | @set emacs-name GNU Emacs |
| 38 | @set emacs-dir emacs | 34 | @set emacs-dir emacs |
| 35 | @set emacs-other-name XEmacs | ||
| 36 | @set emacs-other-dir xemacs | ||
| 37 | @set emacs-other-file-name tramp-xemacs.html | ||
| 39 | @set ftp-package-name Ange-FTP | 38 | @set ftp-package-name Ange-FTP |
| 40 | @set tramp-prefix / | 39 | @set tramp-prefix / |
| 41 | @set tramp-prefix-single-hop | 40 | @set tramp-prefix-single-hop |
| @@ -48,6 +47,9 @@ | |||
| 48 | @ifset xemacs | 47 | @ifset xemacs |
| 49 | @set emacs-name XEmacs | 48 | @set emacs-name XEmacs |
| 50 | @set emacs-dir xemacs | 49 | @set emacs-dir xemacs |
| 50 | @set emacs-other-name GNU Emacs | ||
| 51 | @set emacs-other-dir emacs | ||
| 52 | @set emacs-other-file-name tramp-emacs.html | ||
| 51 | @set ftp-package-name EFS | 53 | @set ftp-package-name EFS |
| 52 | @set tramp-prefix /[ | 54 | @set tramp-prefix /[ |
| 53 | @set tramp-prefix-single-hop [ | 55 | @set tramp-prefix-single-hop [ |
| @@ -122,6 +124,16 @@ programs, such as @command{ssh}/@command{scp}. | |||
| 122 | You can find the latest version of this document on the web at | 124 | You can find the latest version of this document on the web at |
| 123 | @uref{http://www.freesoftware.fsf.org/tramp/}. | 125 | @uref{http://www.freesoftware.fsf.org/tramp/}. |
| 124 | 126 | ||
| 127 | The manual has been generated for @value{emacs-name}. | ||
| 128 | @ifinfo | ||
| 129 | If you want to read the info pages for @value{emacs-other-name}, you | ||
| 130 | should read in @ref{Installation} how to create them. | ||
| 131 | @end ifinfo | ||
| 132 | @ifhtml | ||
| 133 | If you're using the other Emacs flavour, you should read the | ||
| 134 | @uref{@value{emacs-other-file-name}, @value{emacs-other-name}} pages. | ||
| 135 | @end ifhtml | ||
| 136 | |||
| 125 | @ifhtml | 137 | @ifhtml |
| 126 | This manual is also available as a @uref{tramp_ja.html, Japanese | 138 | This manual is also available as a @uref{tramp_ja.html, Japanese |
| 127 | translation}. | 139 | translation}. |
| @@ -176,6 +188,7 @@ Configuring @tramp{} for use | |||
| 176 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. | 188 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. |
| 177 | * Remote shell setup:: Remote shell setup hints. | 189 | * Remote shell setup:: Remote shell setup hints. |
| 178 | * Windows setup hints:: Issues with Cygwin ssh. | 190 | * Windows setup hints:: Issues with Cygwin ssh. |
| 191 | * Auto-save and Backup:: Auto-save and Backup. | ||
| 179 | 192 | ||
| 180 | Using @tramp | 193 | Using @tramp |
| 181 | 194 | ||
| @@ -199,7 +212,7 @@ Things related to Version Control that don't fit elsewhere | |||
| 199 | 212 | ||
| 200 | How file names, directories and localnames are mangled and managed. | 213 | How file names, directories and localnames are mangled and managed. |
| 201 | 214 | ||
| 202 | * Localname deconstruction:: Breaking a localname into its components. | 215 | * Localname deconstruction:: Breaking a localname into its components. |
| 203 | 216 | ||
| 204 | @end detailmenu | 217 | @end detailmenu |
| 205 | @end menu | 218 | @end menu |
| @@ -368,23 +381,23 @@ behind the scenes when you open a file with @tramp{}. | |||
| 368 | @chapter Obtaining @tramp{}. | 381 | @chapter Obtaining @tramp{}. |
| 369 | @cindex obtaining Tramp | 382 | @cindex obtaining Tramp |
| 370 | 383 | ||
| 371 | @tramp{} is freely available on the Internet and the latest release may be | 384 | @tramp{} is freely available on the Internet and the latest release |
| 372 | downloaded from | 385 | may be downloaded from |
| 373 | @uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz}. This | 386 | @uref{http://savannah.nongnu.org/download/tramp/}. This |
| 374 | release includes the full documentation and code for @tramp{}, suitable | 387 | release includes the full documentation and code for @tramp{}, |
| 375 | for installation. But Emacs (21.4 or later) includes @tramp{} | 388 | suitable for installation. But Emacs (21.4 or later) includes |
| 376 | already, and there is a @tramp{} package for XEmacs, as well. So | 389 | @tramp{} already, and there is a @tramp{} package for XEmacs, as well. |
| 377 | maybe it is easier to just use those. But if you want the bleeding | 390 | So maybe it is easier to just use those. But if you want the bleeding |
| 378 | edge, read on@dots{...} | 391 | edge, read on@dots{...} |
| 379 | 392 | ||
| 380 | For the especially brave, @tramp{} is available from CVS. The CVS version | 393 | For the especially brave, @tramp{} is available from CVS. The CVS |
| 381 | is the latest version of the code and may contain incomplete features or | 394 | version is the latest version of the code and may contain incomplete |
| 382 | new issues. Use these versions at your own risk. | 395 | features or new issues. Use these versions at your own risk. |
| 383 | 396 | ||
| 384 | Instructions for obtaining the latest development version of @tramp{} | 397 | Instructions for obtaining the latest development version of @tramp{} |
| 385 | from CVS can be found by going to the Savannah project page at the | 398 | from CVS can be found by going to the Savannah project page at the |
| 386 | following URL and then clicking on the CVS link in the navigation bar at | 399 | following URL and then clicking on the CVS link in the navigation bar |
| 387 | the top. | 400 | at the top. |
| 388 | 401 | ||
| 389 | @noindent | 402 | @noindent |
| 390 | @uref{http://savannah.gnu.org/projects/tramp/} | 403 | @uref{http://savannah.gnu.org/projects/tramp/} |
| @@ -404,15 +417,25 @@ CVS password: @strong{(just hit RET here)} | |||
| 404 | @end example | 417 | @end example |
| 405 | 418 | ||
| 406 | @noindent | 419 | @noindent |
| 407 | You should now have a directory @file{~/@value{emacs-dir}/tramp} containing the latest | 420 | You should now have a directory @file{~/@value{emacs-dir}/tramp} |
| 408 | version of @tramp{}. You can fetch the latest updates from the repository | 421 | containing the latest version of @tramp{}. You can fetch the latest |
| 409 | by issuing the command: | 422 | updates from the repository by issuing the command: |
| 410 | 423 | ||
| 411 | @example | 424 | @example |
| 412 | ] @strong{cd ~/@value{emacs-dir}/tramp} | 425 | ] @strong{cd ~/@value{emacs-dir}/tramp} |
| 413 | ] @strong{cvs update -d} | 426 | ] @strong{cvs update -d} |
| 414 | @end example | 427 | @end example |
| 415 | 428 | ||
| 429 | @noindent | ||
| 430 | Once you've got updated files from the CVS repository, you need to run | ||
| 431 | @command{autoconf} in order to get an up-to-date @file{configure} | ||
| 432 | script: | ||
| 433 | |||
| 434 | @example | ||
| 435 | ] @strong{cd ~/@value{emacs-dir}/tramp} | ||
| 436 | ] @strong{autoconf} | ||
| 437 | @end example | ||
| 438 | |||
| 416 | 439 | ||
| 417 | @node History | 440 | @node History |
| 418 | @chapter History of @tramp{} | 441 | @chapter History of @tramp{} |
| @@ -442,33 +465,40 @@ following information is not necessary. Installing @tramp{} into your | |||
| 442 | to rebuilding your machine from scratch. ;) | 465 | to rebuilding your machine from scratch. ;) |
| 443 | 466 | ||
| 444 | Seriously though, the installation should be a fairly simple matter. | 467 | Seriously though, the installation should be a fairly simple matter. |
| 445 | |||
| 446 | The easiest way to proceed is as follows: | 468 | The easiest way to proceed is as follows: |
| 447 | 469 | ||
| 448 | @itemize @bullet | 470 | @itemize @bullet |
| 449 | @item | 471 | @item |
| 450 | Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that | 472 | Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that |
| 451 | directory and unpack the tarball. This will give you a directory | 473 | directory and unpack the tarball. This will give you a directory |
| 452 | @file{~/@value{emacs-dir}/tramp/} which contains subdirectories | 474 | @file{~/@value{emacs-dir}/tramp-@trampver{}/} which contains |
| 453 | @file{lisp} for the Lisp code and @file{texi} for the documentation. | 475 | subdirectories @file{lisp} for the Lisp code and @file{texi} for the |
| 454 | 476 | documentation. Make a symbolic link: | |
| 455 | @item | ||
| 456 | Optionally byte-compile all files in the Lisp directory, | ||
| 457 | @file{~/@value{emacs-dir}/tramp/lisp/}, by issuing a command like the | ||
| 458 | following from the top level directory | ||
| 459 | @file{~/@value{emacs-dir}/tramp/}: | ||
| 460 | 477 | ||
| 461 | @example | 478 | @example |
| 462 | make EMACS=@value{emacs-dir} all | 479 | ln -s tramp-@trampver{} tramp |
| 463 | @end example | 480 | @end example |
| 464 | 481 | ||
| 465 | If there are missing libraries reported it is likely they are provided | 482 | @item |
| 466 | in the @file{~/@value{emacs-dir}/tramp/contrib/} directory. This | 483 | @command{cd} to @file{~/@value{emacs-dir}/tramp/} and type |
| 467 | case, you need to call @command{make} like this: | 484 | @command{./configure} to configure Tramp for your system. |
| 468 | 485 | ||
| 469 | @example | 486 | Running `configure' takes awhile. While running, it prints some |
| 470 | make EMACS=@value{emacs-dir} USE_CONTRIB=1 all | 487 | messages telling which features it is checking for. |
| 471 | @end example | 488 | |
| 489 | @item | ||
| 490 | Type @command{make} to build the byte-compiled Lisp files as well as | ||
| 491 | the Info manual. | ||
| 492 | |||
| 493 | @item | ||
| 494 | Type @command{make install} to install the Tramp Lisp files and Info | ||
| 495 | manual. | ||
| 496 | |||
| 497 | @item | ||
| 498 | You can remove the byte-compiled Lisp files and the Info manual from | ||
| 499 | the source directory by typing @command{make clean}. To also remove | ||
| 500 | the files that @command{configure} created, type @command{make | ||
| 501 | distclean}. | ||
| 472 | 502 | ||
| 473 | @item | 503 | @item |
| 474 | NOTE: If you run into problems running the example @command{make} | 504 | NOTE: If you run into problems running the example @command{make} |
| @@ -480,11 +510,86 @@ d}) mode, at @file{~/@value{emacs-dir}/tramp/lisp}. Mark the lisp files with | |||
| 480 | Something similar can be done to create the info manual. Just change | 510 | Something similar can be done to create the info manual. Just change |
| 481 | to directory @file{~/@value{emacs-dir}/tramp/texi} and load the | 511 | to directory @file{~/@value{emacs-dir}/tramp/texi} and load the |
| 482 | @file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x | 512 | @file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x |
| 483 | texinfo-format-buffer @key{RET}} to generate @file{tramp.info}. | 513 | texinfo-format-buffer @key{RET}} to generate |
| 514 | @file{~/@value{emacs-dir}/tramp/info/tramp}. | ||
| 515 | @end itemize | ||
| 484 | 516 | ||
| 485 | @item | 517 | @menu |
| 486 | Tell @value{emacs-name} about the new Lisp directory and the | 518 | * Installation parameters:: Parameters in order to control installation. |
| 487 | @tramp{} package with the following lines in @file{~/.emacs}: | 519 | * Load paths:: How to plug-in @tramp{} into your environment. |
| 520 | @end menu | ||
| 521 | |||
| 522 | @node Installation parameters | ||
| 523 | @section Parameters in order to control installation. | ||
| 524 | @cindex installation | ||
| 525 | |||
| 526 | By default, @command{make install} will install @tramp{}'s files in | ||
| 527 | @file{@value{lispdir}} and @file{@value{infodir}}. You can specify an | ||
| 528 | installation prefix other than @file{@value{prefix}} by giving | ||
| 529 | @command{configure} the option @command{--prefix=PATH}. | ||
| 530 | |||
| 531 | If your installed copy of Emacs is named something other than | ||
| 532 | @command{@value{emacs-dir}}, you will need to tell `make' where to find it so | ||
| 533 | that it can correctly byte-compile the @tramp{} sources. | ||
| 534 | |||
| 535 | For example, to force the use of @value{emacs-other-name} you might do | ||
| 536 | this: | ||
| 537 | |||
| 538 | @example | ||
| 539 | ./configure --with-@value{emacs-other-dir} | ||
| 540 | make | ||
| 541 | make install | ||
| 542 | @end example | ||
| 543 | |||
| 544 | or this: | ||
| 545 | |||
| 546 | @example | ||
| 547 | ./configure | ||
| 548 | make EMACS=/usr/bin/@value{emacs-other-dir}-21.4 | ||
| 549 | make install | ||
| 550 | @end example | ||
| 551 | |||
| 552 | The syntax of @tramp{} file names is different for @value{emacs-name} | ||
| 553 | and @value{emacs-other-name}. The Info manual will be generated for | ||
| 554 | the Emacs flavor choosen in the @command{configure} phase. If you want | ||
| 555 | the Info manual for the other version, you need to set the variable | ||
| 556 | @command{EMACS_INFO} to @command{make}: | ||
| 557 | |||
| 558 | @example | ||
| 559 | ./configure --with-@value{emacs-dir} | ||
| 560 | make EMACS_INFO=@value{emacs-other-dir} | ||
| 561 | @end example | ||
| 562 | |||
| 563 | Also, the @command{--prefix=PATH} option to @command{configure} may | ||
| 564 | not be general enough to set the paths you want. If not, you can pass | ||
| 565 | variables to the @command{make} command to control the installation. | ||
| 566 | For a complete list of tweakable variables, look in the makefile. | ||
| 567 | |||
| 568 | For example, to put the Lisp files in @file{~/elisp} and the Info file | ||
| 569 | in @file{~/info}, you would type: | ||
| 570 | |||
| 571 | @example | ||
| 572 | ./configure | ||
| 573 | make | ||
| 574 | make lispdir=~/elisp infodir=~/info install | ||
| 575 | @end example | ||
| 576 | |||
| 577 | @tramp{} has some packages in its @file{contrib} directory which are | ||
| 578 | missing in older Emacsen. If you want to use them, you must use the | ||
| 579 | @command{USE_CONTRIB} environment variable: | ||
| 580 | |||
| 581 | @example | ||
| 582 | make USE_CONTRIB=1 | ||
| 583 | make USE_CONTRIB=1 install | ||
| 584 | @end example | ||
| 585 | |||
| 586 | @node Load paths | ||
| 587 | @section How to plug-in @tramp{} into your environment. | ||
| 588 | @cindex installation | ||
| 589 | |||
| 590 | If you don't install @tramp{} into the intended directories, but prefer | ||
| 591 | to use from the source directory, you need to add the following lines | ||
| 592 | into your @file{.emacs}: | ||
| 488 | 593 | ||
| 489 | @lisp | 594 | @lisp |
| 490 | (add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/") | 595 | (add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/") |
| @@ -492,22 +597,33 @@ Tell @value{emacs-name} about the new Lisp directory and the | |||
| 492 | (require 'tramp) | 597 | (require 'tramp) |
| 493 | @end lisp | 598 | @end lisp |
| 494 | 599 | ||
| 495 | The second @command{add-to-list} must be used only if you've compiled | 600 | The second load-path must be used only if you've applied the |
| 496 | with the @command{USE_CONTRIB} parameter. | 601 | @command{USE_CONTRIB} parameter. |
| 602 | |||
| 603 | @ifset xemacs | ||
| 604 | NOTE: For @value{emacs-name}, the package @file{fsf-compat} must be | ||
| 605 | installed. For details on package installation, see @ref{Packages, , | ||
| 606 | ,xemacs}. | ||
| 607 | @ifhtml | ||
| 608 | (If the previous link doesn't work, try the @value{emacs-name} | ||
| 609 | documentation at | ||
| 610 | @uref{http://www.xemacs.org/Documentation/packageGuide.html,the | ||
| 611 | @value{emacs-name} site}.) | ||
| 612 | @end ifhtml | ||
| 613 | @end ifset | ||
| 497 | 614 | ||
| 498 | @item | ||
| 499 | To be able to read the Info documentation, create a file | 615 | To be able to read the Info documentation, create a file |
| 500 | @file{~/@value{emacs-dir}/tramp/texi/dir} using the | 616 | @file{~/@value{emacs-dir}/tramp/info/dir} using the |
| 501 | @command{install-info} command, and add the directory to the search | 617 | @command{install-info} command, and add the directory to the search |
| 502 | path for Info. | 618 | path for Info. |
| 503 | 619 | ||
| 504 | NOTE: | 620 | NOTE: |
| 505 | On systems using the @cite{gnu} version of @command{install-info}, the | 621 | On systems using the @cite{gnu} version of @command{install-info}, the |
| 506 | @command{install-info} syntax is very direct and simple. One can | 622 | @command{install-info} syntax is very direct and simple. One can |
| 507 | change to directory @file{~/@value{emacs-dir}/tramp/texi} and type: | 623 | change to directory @file{~/@value{emacs-dir}/tramp/info} and type: |
| 508 | 624 | ||
| 509 | @example | 625 | @example |
| 510 | install-info tramp.info dir | 626 | install-info tramp dir |
| 511 | @end example | 627 | @end example |
| 512 | 628 | ||
| 513 | and a @file{dir} file will be created with the @tramp{} | 629 | and a @file{dir} file will be created with the @tramp{} |
| @@ -522,47 +638,34 @@ file it recognizes. One can be found in a default installation of | |||
| 522 | @value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file | 638 | @value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file |
| 523 | down to the first occurrence of @code{* Menu} including that line plus | 639 | down to the first occurrence of @code{* Menu} including that line plus |
| 524 | one more blank line, to your working directory | 640 | one more blank line, to your working directory |
| 525 | @file{~/@value{emacs-dir}/tramp/texi}, or use the sample | 641 | @file{~/@value{emacs-dir}/tramp/info}, or use the sample |
| 526 | @file{~/@value{emacs-dir}/tramp/texi/dir_sample}. | 642 | @file{~/@value{emacs-dir}/tramp/texi/dir_sample}. |
| 527 | 643 | ||
| 528 | Once a @file{dir} file is in place, this command will make the entry: | 644 | Once a @file{dir} file is in place, this command will make the entry: |
| 529 | 645 | ||
| 530 | @example | 646 | @example |
| 531 | install-info --infodir=. tramp.info | 647 | install-info --infodir=. tramp |
| 532 | @end example | 648 | @end example |
| 533 | 649 | ||
| 534 | If you want it in a specific category see @kbd{man install-info} for | 650 | If you want it in a specific category see @kbd{man install-info} for |
| 535 | further details. | 651 | further details. |
| 536 | 652 | ||
| 537 | If the environment variable @env{INFOPATH} is set, add the directory | 653 | If the environment variable @env{INFOPATH} is set, add the directory |
| 538 | @file{~/@value{emacs-dir}/tramp/texi/} to it. Else, add the directory to | 654 | @file{~/@value{emacs-dir}/tramp/info/} to it. Else, add the directory to |
| 539 | @ifset emacs | 655 | @ifset emacs |
| 540 | @code{Info-default-directory-list}, as follows: | 656 | @code{Info-default-directory-list}, as follows: |
| 541 | 657 | ||
| 542 | @lisp | 658 | @lisp |
| 543 | (add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/texi/") | 659 | (add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/info/") |
| 544 | @end lisp | 660 | @end lisp |
| 545 | @end ifset | 661 | @end ifset |
| 546 | @ifset xemacs | 662 | @ifset xemacs |
| 547 | @code{Info-directory-list}, as follows: | 663 | @code{Info-directory-list}, as follows: |
| 548 | @lisp | 664 | @lisp |
| 549 | (add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/texi/") | 665 | (add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/info/") |
| 550 | @end lisp | 666 | @end lisp |
| 551 | @end ifset | 667 | @end ifset |
| 552 | 668 | ||
| 553 | @end itemize | ||
| 554 | |||
| 555 | @ifset xemacs | ||
| 556 | For @value{emacs-name}, the package @file{fsf-compat} must be installed. | ||
| 557 | For details on package installation, see @ref{Packages, , ,xemacs}. | ||
| 558 | @ifhtml | ||
| 559 | (If the previous link doesn't work, try the @value{emacs-name} | ||
| 560 | documentation at | ||
| 561 | @uref{http://www.xemacs.org/Documentation/packageGuide.html,the | ||
| 562 | @value{emacs-name} site}.) | ||
| 563 | @end ifhtml | ||
| 564 | @end ifset | ||
| 565 | |||
| 566 | @node Configuration | 669 | @node Configuration |
| 567 | @chapter Configuring @tramp{} for use | 670 | @chapter Configuring @tramp{} for use |
| 568 | @cindex configuration | 671 | @cindex configuration |
| @@ -596,6 +699,7 @@ can use to connect to remote machines and transfer files | |||
| 596 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. | 699 | * Remote Programs:: How @tramp{} finds and uses programs on the remote machine. |
| 597 | * Remote shell setup:: Remote shell setup hints. | 700 | * Remote shell setup:: Remote shell setup hints. |
| 598 | * Windows setup hints:: Issues with Cygwin ssh. | 701 | * Windows setup hints:: Issues with Cygwin ssh. |
| 702 | * Auto-save and Backup:: Auto-save and Backup. | ||
| 599 | @end menu | 703 | @end menu |
| 600 | 704 | ||
| 601 | 705 | ||
| @@ -1419,6 +1523,38 @@ the variables @code{tramp-actions-before-shell} and | |||
| 1419 | @end table | 1523 | @end table |
| 1420 | 1524 | ||
| 1421 | 1525 | ||
| 1526 | @node Auto-save and Backup | ||
| 1527 | @section Auto-save and Backup configuration | ||
| 1528 | @cindex auto-save | ||
| 1529 | @cindex backup | ||
| 1530 | @vindex backup-directory-alist | ||
| 1531 | |||
| 1532 | Explaining auto-save is still to do. | ||
| 1533 | |||
| 1534 | Normally, Emacs writes backup files to the same directory as the | ||
| 1535 | original files, but this behavior can be changed via the variable | ||
| 1536 | @code{backup-directory-alist}. In connection with @tramp{}, this can | ||
| 1537 | have unexpected side effects. Suppose that you specify that all backups | ||
| 1538 | should go to the directory @file{~/.emacs.d/backups/}, and then you edit | ||
| 1539 | the file @file{/su:root@@localhost:/etc/secretfile}. The effect is that | ||
| 1540 | the backup file will be owned by you and not by root, thus possibly | ||
| 1541 | enabling others to see it even if they were not intended to see it. | ||
| 1542 | |||
| 1543 | When @code{backup-directory-alist} is nil (the default), such problems | ||
| 1544 | do not occur. | ||
| 1545 | |||
| 1546 | If you wish to customize the variable, the workaround is to include | ||
| 1547 | special settings for Tramp files. For example, the following statement | ||
| 1548 | effectively `turns off' the effect of @code{backup-directory-alist} for | ||
| 1549 | @tramp{} files: | ||
| 1550 | |||
| 1551 | @lisp | ||
| 1552 | (require 'tramp) | ||
| 1553 | (add-to-list 'backup-directory-alist | ||
| 1554 | (cons tramp-file-name-regexp nil)) | ||
| 1555 | @end lisp | ||
| 1556 | |||
| 1557 | |||
| 1422 | @node Windows setup hints | 1558 | @node Windows setup hints |
| 1423 | @section Issues with Cygwin ssh | 1559 | @section Issues with Cygwin ssh |
| 1424 | @cindex Cygwin, issues | 1560 | @cindex Cygwin, issues |
| @@ -1730,7 +1866,7 @@ Where can I get the latest @tramp{}? | |||
| 1730 | @tramp{} is available under the URL below. | 1866 | @tramp{} is available under the URL below. |
| 1731 | 1867 | ||
| 1732 | @noindent | 1868 | @noindent |
| 1733 | @uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz} | 1869 | @uref{http://savannah.nongnu.org/download/tramp/} |
| 1734 | 1870 | ||
| 1735 | @noindent | 1871 | @noindent |
| 1736 | There is also a Savannah project page. | 1872 | There is also a Savannah project page. |
diff --git a/man/trampver.texi b/man/trampver.texi new file mode 100644 index 00000000000..7ff409491e3 --- /dev/null +++ b/man/trampver.texi | |||
| @@ -0,0 +1,14 @@ | |||
| 1 | @c -*-texinfo-*- | ||
| 2 | @c texi/trampver.texi. Generated from trampver.texi.in by configure. | ||
| 3 | |||
| 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 | ||
| 6 | @c "autoconf && ./configure" to change the version number. | ||
| 7 | @macro trampver{} | ||
| 8 | 2.0.31 | ||
| 9 | @end macro | ||
| 10 | |||
| 11 | @c Other flags from configuration | ||
| 12 | @set prefix /usr/local | ||
| 13 | @set lispdir /usr/local/share/emacs/site-lisp | ||
| 14 | @set infodir /usr/local/info | ||