8 |
@c This is *so* much nicer :) |
@c This is *so* much nicer :) |
9 |
@footnotestyle end |
@footnotestyle end |
10 |
|
|
11 |
@c In the Tramp CVS, the version number is auto-frobbed from the |
@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 |
@c configure.ac, so you should edit that file and run |
13 |
@c the version number. |
@c "autoconf && ./configure" to change the version number. |
14 |
@macro trampver{} |
@include trampver.texi |
|
2.0.30 |
|
|
@end macro |
|
15 |
|
|
16 |
@c Entries for @command{install-info} to use |
@c Entries for @command{install-info} to use |
17 |
@dircategory Emacs |
@dircategory Emacs |
25 |
@sc{tramp} |
@sc{tramp} |
26 |
@end macro |
@end macro |
27 |
|
|
|
@c Distinguish between GNU Emacs and XEmacs. Derived from the |
|
|
@c Makefile variable $(EMACS-ID). Valid values are `emacs' and `xemacs'. |
|
|
@set emacs |
|
|
|
|
28 |
@c Some flags which make the text independent on the (X)Emacs flavor. |
@c Some flags which make the text independent on the (X)Emacs flavor. |
29 |
|
@c "emacs" resp "xemacs" are set in the Makefile. |
30 |
|
|
31 |
@c GNU Emacs values. |
@c GNU Emacs values. |
32 |
@ifset emacs |
@ifset emacs |
33 |
@set emacs-name GNU Emacs |
@set emacs-name GNU Emacs |
380 |
@chapter Obtaining @tramp{}. |
@chapter Obtaining @tramp{}. |
381 |
@cindex obtaining Tramp |
@cindex obtaining Tramp |
382 |
|
|
383 |
@tramp{} is freely available on the Internet and the latest release may be |
@tramp{} is freely available on the Internet and the latest release |
384 |
downloaded from |
may be downloaded from |
385 |
@uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz}. This |
@uref{http://savannah.nongnu.org/download/tramp/}. This |
386 |
release includes the full documentation and code for @tramp{}, suitable |
release includes the full documentation and code for @tramp{}, |
387 |
for installation. But Emacs (21.4 or later) includes @tramp{} |
suitable for installation. But Emacs (21.4 or later) includes |
388 |
already, and there is a @tramp{} package for XEmacs, as well. So |
@tramp{} already, and there is a @tramp{} package for XEmacs, as well. |
389 |
maybe it is easier to just use those. But if you want the bleeding |
So maybe it is easier to just use those. But if you want the bleeding |
390 |
edge, read on@dots{...} |
edge, read on@dots{...} |
391 |
|
|
392 |
For the especially brave, @tramp{} is available from CVS. The CVS version |
For the especially brave, @tramp{} is available from CVS. The CVS |
393 |
is the latest version of the code and may contain incomplete features or |
version is the latest version of the code and may contain incomplete |
394 |
new issues. Use these versions at your own risk. |
features or new issues. Use these versions at your own risk. |
395 |
|
|
396 |
Instructions for obtaining the latest development version of @tramp{} |
Instructions for obtaining the latest development version of @tramp{} |
397 |
from CVS can be found by going to the Savannah project page at the |
from CVS can be found by going to the Savannah project page at the |
398 |
following URL and then clicking on the CVS link in the navigation bar at |
following URL and then clicking on the CVS link in the navigation bar |
399 |
the top. |
at the top. |
400 |
|
|
401 |
@noindent |
@noindent |
402 |
@uref{http://savannah.gnu.org/projects/tramp/} |
@uref{http://savannah.gnu.org/projects/tramp/} |
416 |
@end example |
@end example |
417 |
|
|
418 |
@noindent |
@noindent |
419 |
You should now have a directory @file{~/@value{emacs-dir}/tramp} containing the latest |
You should now have a directory @file{~/@value{emacs-dir}/tramp} |
420 |
version of @tramp{}. You can fetch the latest updates from the repository |
containing the latest version of @tramp{}. You can fetch the latest |
421 |
by issuing the command: |
updates from the repository by issuing the command: |
422 |
|
|
423 |
@example |
@example |
424 |
] @strong{cd ~/@value{emacs-dir}/tramp} |
] @strong{cd ~/@value{emacs-dir}/tramp} |
425 |
] @strong{cvs update -d} |
] @strong{cvs update -d} |
426 |
@end example |
@end example |
427 |
|
|
428 |
|
@noindent |
429 |
|
Once you've got updated files from the CVS repository, you need to run |
430 |
|
@command{autoconf} in order to get an up-to-date @file{configure} |
431 |
|
script: |
432 |
|
|
433 |
|
@example |
434 |
|
] @strong{cd ~/@value{emacs-dir}/tramp} |
435 |
|
] @strong{autoconf} |
436 |
|
@end example |
437 |
|
|
438 |
|
|
439 |
@node History |
@node History |
440 |
@chapter History of @tramp{} |
@chapter History of @tramp{} |
464 |
to rebuilding your machine from scratch. ;) |
to rebuilding your machine from scratch. ;) |
465 |
|
|
466 |
Seriously though, the installation should be a fairly simple matter. |
Seriously though, the installation should be a fairly simple matter. |
|
|
|
467 |
The easiest way to proceed is as follows: |
The easiest way to proceed is as follows: |
468 |
|
|
469 |
@itemize @bullet |
@itemize @bullet |
470 |
@item |
@item |
471 |
Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that |
Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that |
472 |
directory and unpack the tarball. This will give you a directory |
directory and unpack the tarball. This will give you a directory |
473 |
@file{~/@value{emacs-dir}/tramp/} which contains subdirectories |
@file{~/@value{emacs-dir}/tramp-@trampver{}/} which contains |
474 |
@file{lisp} for the Lisp code and @file{texi} for the documentation. |
subdirectories @file{lisp} for the Lisp code and @file{texi} for the |
475 |
|
documentation. Make a symbolic link: |
|
@item |
|
|
Optionally byte-compile all files in the Lisp directory, |
|
|
@file{~/@value{emacs-dir}/tramp/lisp/}, by issuing a command like the |
|
|
following from the top level directory |
|
|
@file{~/@value{emacs-dir}/tramp/}: |
|
476 |
|
|
477 |
@example |
@example |
478 |
make EMACS=@value{emacs-dir} all |
ln -s tramp-@trampver{} tramp |
479 |
@end example |
@end example |
480 |
|
|
481 |
If there are missing libraries reported it is likely they are provided |
@item |
482 |
in the @file{~/@value{emacs-dir}/tramp/contrib/} directory. This |
@command{cd} to @file{~/@value{emacs-dir}/tramp/} and type |
483 |
case, you need to call @command{make} like this: |
@command{./configure} to configure Tramp for your system. |
484 |
|
|
485 |
@example |
Running `configure' takes awhile. While running, it prints some |
486 |
make EMACS=@value{emacs-dir} USE_CONTRIB=1 all |
messages telling which features it is checking for. |
487 |
@end example |
|
488 |
|
@item |
489 |
|
Type @command{make} to build the byte-compiled Lisp files as well as |
490 |
|
the Info manual. |
491 |
|
|
492 |
|
@item |
493 |
|
Type @command{make install} to install the Tramp Lisp files and Info |
494 |
|
manual. |
495 |
|
|
496 |
|
@item |
497 |
|
You can remove the byte-compiled Lisp files and the Info manual from |
498 |
|
the source directory by typing @command{make clean}. To also remove |
499 |
|
the files that @command{configure} created, type @command{make |
500 |
|
distclean}. |
501 |
|
|
502 |
@item |
@item |
503 |
NOTE: If you run into problems running the example @command{make} |
NOTE: If you run into problems running the example @command{make} |
509 |
Something similar can be done to create the info manual. Just change |
Something similar can be done to create the info manual. Just change |
510 |
to directory @file{~/@value{emacs-dir}/tramp/texi} and load the |
to directory @file{~/@value{emacs-dir}/tramp/texi} and load the |
511 |
@file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x |
@file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x |
512 |
texinfo-format-buffer @key{RET}} to generate @file{tramp.info}. |
texinfo-format-buffer @key{RET}} to generate |
513 |
|
@file{~/@value{emacs-dir}/tramp/info/tramp}. |
514 |
|
@end itemize |
515 |
|
|
516 |
@item |
@menu |
517 |
Tell @value{emacs-name} about the new Lisp directory and the |
* Installation parameters:: Parameters in order to control installation. |
518 |
@tramp{} package with the following lines in @file{~/.emacs}: |
* Load paths:: How to plug-in @tramp{} into your environment. |
519 |
|
@end menu |
520 |
|
|
521 |
|
@node Installation parameters |
522 |
|
@section Parameters in order to control installation. |
523 |
|
@cindex installation |
524 |
|
|
525 |
|
By default, @command{make install} will install @tramp{}'s files in |
526 |
|
@file{@value{lispdir}} and @file{@value{infodir}}. You can specify an |
527 |
|
installation prefix other than @file{@value{prefix}} by giving |
528 |
|
@command{configure} the option @command{--prefix=PATH}. |
529 |
|
|
530 |
|
If your installed copy of Emacs is named something other than |
531 |
|
@command{@value{emacs-dir}}, you will need to tell `make' where to find it so |
532 |
|
that it can correctly byte-compile the @tramp{} sources. |
533 |
|
|
534 |
|
For example, to force the use of @value{emacs-other-name} you might do |
535 |
|
this: |
536 |
|
|
537 |
|
@example |
538 |
|
./configure --with-@value{emacs-other-dir} |
539 |
|
make |
540 |
|
make install |
541 |
|
@end example |
542 |
|
|
543 |
|
or this: |
544 |
|
|
545 |
|
@example |
546 |
|
./configure |
547 |
|
make EMACS=/usr/bin/@value{emacs-other-dir}-21.4 |
548 |
|
make install |
549 |
|
@end example |
550 |
|
|
551 |
|
The syntax of @tramp{} file names is different for @value{emacs-name} |
552 |
|
and @value{emacs-other-name}. The Info manual will be generated for |
553 |
|
the Emacs flavor choosen in the @command{configure} phase. If you want |
554 |
|
the Info manual for the other version, you need to set the variable |
555 |
|
@command{EMACS_INFO} to @command{make}: |
556 |
|
|
557 |
|
@example |
558 |
|
./configure --with-@value{emacs-dir} |
559 |
|
make EMACS_INFO=@value{emacs-other-dir} |
560 |
|
@end example |
561 |
|
|
562 |
|
Also, the @command{--prefix=PATH} option to @command{configure} may |
563 |
|
not be general enough to set the paths you want. If not, you can pass |
564 |
|
variables to the @command{make} command to control the installation. |
565 |
|
For a complete list of tweakable variables, look in the makefile. |
566 |
|
|
567 |
|
For example, to put the Lisp files in @file{~/elisp} and the Info file |
568 |
|
in @file{~/info}, you would type: |
569 |
|
|
570 |
|
@example |
571 |
|
./configure |
572 |
|
make |
573 |
|
make lispdir=~/elisp infodir=~/info install |
574 |
|
@end example |
575 |
|
|
576 |
|
@tramp{} has some packages in its @file{contrib} directory which are |
577 |
|
missing in older Emacsen. If you want to use them, you must use the |
578 |
|
@command{USE_CONTRIB} environment variable: |
579 |
|
|
580 |
|
@example |
581 |
|
make USE_CONTRIB=1 |
582 |
|
make USE_CONTRIB=1 install |
583 |
|
@end example |
584 |
|
|
585 |
|
@node Load paths |
586 |
|
@section How to plug-in @tramp{} into your environment. |
587 |
|
@cindex installation |
588 |
|
|
589 |
|
If you don't install @tramp{} into the intended directories, but prefer |
590 |
|
to use from the source directory, you need to add the following lines |
591 |
|
into your @file{.emacs}: |
592 |
|
|
593 |
@lisp |
@lisp |
594 |
(add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/") |
(add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/") |
596 |
(require 'tramp) |
(require 'tramp) |
597 |
@end lisp |
@end lisp |
598 |
|
|
599 |
The second @command{add-to-list} must be used only if you've compiled |
The second load-path must be used only if you've applied the |
600 |
with the @command{USE_CONTRIB} parameter. |
@command{USE_CONTRIB} parameter. |
601 |
|
|
602 |
|
@ifset xemacs |
603 |
|
NOTE: For @value{emacs-name}, the package @file{fsf-compat} must be |
604 |
|
installed. For details on package installation, see @ref{Packages, , |
605 |
|
,xemacs}. |
606 |
|
@ifhtml |
607 |
|
(If the previous link doesn't work, try the @value{emacs-name} |
608 |
|
documentation at |
609 |
|
@uref{http://www.xemacs.org/Documentation/packageGuide.html,the |
610 |
|
@value{emacs-name} site}.) |
611 |
|
@end ifhtml |
612 |
|
@end ifset |
613 |
|
|
|
@item |
|
614 |
To be able to read the Info documentation, create a file |
To be able to read the Info documentation, create a file |
615 |
@file{~/@value{emacs-dir}/tramp/texi/dir} using the |
@file{~/@value{emacs-dir}/tramp/info/dir} using the |
616 |
@command{install-info} command, and add the directory to the search |
@command{install-info} command, and add the directory to the search |
617 |
path for Info. |
path for Info. |
618 |
|
|
619 |
NOTE: |
NOTE: |
620 |
On systems using the @cite{gnu} version of @command{install-info}, the |
On systems using the @cite{gnu} version of @command{install-info}, the |
621 |
@command{install-info} syntax is very direct and simple. One can |
@command{install-info} syntax is very direct and simple. One can |
622 |
change to directory @file{~/@value{emacs-dir}/tramp/texi} and type: |
change to directory @file{~/@value{emacs-dir}/tramp/info} and type: |
623 |
|
|
624 |
@example |
@example |
625 |
install-info tramp.info dir |
install-info tramp dir |
626 |
@end example |
@end example |
627 |
|
|
628 |
and a @file{dir} file will be created with the @tramp{} |
and a @file{dir} file will be created with the @tramp{} |
630 |
be told where to find it (see below). If you want anything fancier |
be told where to find it (see below). If you want anything fancier |
631 |
you'll need to look through @kbd{man install-info}. |
you'll need to look through @kbd{man install-info}. |
632 |
|
|
|
If you want to read the info pages for @value{emacs-other-name}, |
|
|
simply use the option @command{EMACS=@value{emacs-other-dir}} applying |
|
|
@command{make} instead of in the example described above. |
|
|
|
|
633 |
Debian gnu/linux doesn't default to @cite{gnu} @command{install-info} |
Debian gnu/linux doesn't default to @cite{gnu} @command{install-info} |
634 |
and uses its own version. This version does not create a @file{dir} |
and uses its own version. This version does not create a @file{dir} |
635 |
file for you from scratch. You must provide a skeleton @file{dir} |
file for you from scratch. You must provide a skeleton @file{dir} |
637 |
@value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file |
@value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file |
638 |
down to the first occurrence of @code{* Menu} including that line plus |
down to the first occurrence of @code{* Menu} including that line plus |
639 |
one more blank line, to your working directory |
one more blank line, to your working directory |
640 |
@file{~/@value{emacs-dir}/tramp/texi}, or use the sample |
@file{~/@value{emacs-dir}/tramp/info}, or use the sample |
641 |
@file{~/@value{emacs-dir}/tramp/texi/dir_sample}. |
@file{~/@value{emacs-dir}/tramp/texi/dir_sample}. |
642 |
|
|
643 |
Once a @file{dir} file is in place, this command will make the entry: |
Once a @file{dir} file is in place, this command will make the entry: |
644 |
|
|
645 |
@example |
@example |
646 |
install-info --infodir=. tramp.info |
install-info --infodir=. tramp |
647 |
@end example |
@end example |
648 |
|
|
649 |
If you want it in a specific category see @kbd{man install-info} for |
If you want it in a specific category see @kbd{man install-info} for |
650 |
further details. |
further details. |
651 |
|
|
652 |
If the environment variable @env{INFOPATH} is set, add the directory |
If the environment variable @env{INFOPATH} is set, add the directory |
653 |
@file{~/@value{emacs-dir}/tramp/texi/} to it. Else, add the directory to |
@file{~/@value{emacs-dir}/tramp/info/} to it. Else, add the directory to |
654 |
@ifset emacs |
@ifset emacs |
655 |
@code{Info-default-directory-list}, as follows: |
@code{Info-default-directory-list}, as follows: |
656 |
|
|
657 |
@lisp |
@lisp |
658 |
(add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/texi/") |
(add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/info/") |
659 |
@end lisp |
@end lisp |
660 |
@end ifset |
@end ifset |
661 |
@ifset xemacs |
@ifset xemacs |
662 |
@code{Info-directory-list}, as follows: |
@code{Info-directory-list}, as follows: |
663 |
@lisp |
@lisp |
664 |
(add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/texi/") |
(add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/info/") |
665 |
@end lisp |
@end lisp |
666 |
@end ifset |
@end ifset |
667 |
|
|
|
@end itemize |
|
|
|
|
|
@ifset xemacs |
|
|
For @value{emacs-name}, the package @file{fsf-compat} must be installed. |
|
|
For details on package installation, see @ref{Packages, , ,xemacs}. |
|
|
@ifhtml |
|
|
(If the previous link doesn't work, try the @value{emacs-name} |
|
|
documentation at |
|
|
@uref{http://www.xemacs.org/Documentation/packageGuide.html,the |
|
|
@value{emacs-name} site}.) |
|
|
@end ifhtml |
|
|
@end ifset |
|
|
|
|
668 |
@node Configuration |
@node Configuration |
669 |
@chapter Configuring @tramp{} for use |
@chapter Configuring @tramp{} for use |
670 |
@cindex configuration |
@cindex configuration |
1832 |
@tramp{} is available under the URL below. |
@tramp{} is available under the URL below. |
1833 |
|
|
1834 |
@noindent |
@noindent |
1835 |
@uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/tramp.tar.gz} |
@uref{http://savannah.nongnu.org/download/tramp/} |
1836 |
|
|
1837 |
@noindent |
@noindent |
1838 |
There is also a Savannah project page. |
There is also a Savannah project page. |