aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Großjohann2003-04-08 20:09:23 +0000
committerKai Großjohann2003-04-08 20:09:23 +0000
commit7e1907830e5204b5b8f01fa046257d41a5c1f95f (patch)
treef70d11314501249c8ebb02de462bbc6752b58178
parent83bbd71b252072c6b61d98c70f126c71876ae6cb (diff)
downloademacs-7e1907830e5204b5b8f01fa046257d41a5c1f95f.tar.gz
emacs-7e1907830e5204b5b8f01fa046257d41a5c1f95f.zip
2003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
* tramp.texi: Version 2.0.33 released. Remove installation chapter. Remove XEmacs specifics.
-rw-r--r--man/ChangeLog5
-rw-r--r--man/tramp.texi237
-rw-r--r--man/trampver.texi48
3 files changed, 79 insertions, 211 deletions
diff --git a/man/ChangeLog b/man/ChangeLog
index 2421b4f98c0..8b997dbde79 100644
--- a/man/ChangeLog
+++ b/man/ChangeLog
@@ -1,3 +1,8 @@
12003-04-08 Michael Albinus <Michael.Albinus@alcatel.de>
2
3 * tramp.texi: Version 2.0.33 released.
4 Remove installation chapter. Remove XEmacs specifics.
5
12003-03-29 Richard M. Stallman <rms@gnu.org> 62003-03-29 Richard M. Stallman <rms@gnu.org>
2 7
3 * tramp.texi (Top): Undo the previous renaming. 8 * tramp.texi (Top): Undo the previous renaming.
diff --git a/man/tramp.texi b/man/tramp.texi
index e0ee4080fcf..1b4050bc8ea 100644
--- a/man/tramp.texi
+++ b/man/tramp.texi
@@ -11,6 +11,10 @@
11@c In the Tramp CVS, the version number is auto-frobbed from 11@c In the Tramp CVS, the version number is auto-frobbed from
12@c configure.ac, so you should edit that file and run 12@c configure.ac, so you should edit that file and run
13@c "autoconf && ./configure" to change the version number. 13@c "autoconf && ./configure" to change the version number.
14
15@c Additionally, flags are set with respect to the Emacs flavor; and
16@c depending whether Tramp is packaged into (X)Emacs, or standalone.
17
14@include trampver.texi 18@include trampver.texi
15 19
16@c Entries for @command{install-info} to use 20@c Entries for @command{install-info} to use
@@ -25,33 +29,6 @@
25@sc{tramp} 29@sc{tramp}
26@end macro 30@end macro
27 31
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
31@c Emacs values.
32@ifset emacs
33@set emacs-name Emacs
34@set emacs-dir emacs
35@set ftp-package-name Ange-FTP
36@set tramp-prefix /
37@set tramp-prefix-single-hop
38@set tramp-postfix :
39@set tramp-postfix-single-hop :
40@set tramp-postfix-multi-hop :
41@end ifset
42
43@c XEmacs counterparts.
44@ifset xemacs
45@set emacs-name XEmacs
46@set emacs-dir xemacs
47@set ftp-package-name EFS
48@set tramp-prefix /[
49@set tramp-prefix-single-hop [
50@set tramp-postfix ]
51@set tramp-postfix-single-hop /
52@set tramp-postfix-multi-hop :
53@end ifset
54
55@c Macros for formatting a filename. 32@c Macros for formatting a filename.
56@c trampfn is for a full filename, trampfnmhp means method, host, localname 33@c trampfn is for a full filename, trampfnmhp means method, host, localname
57@c were given, and so on. 34@c were given, and so on.
@@ -118,6 +95,12 @@ programs, such as @command{ssh}/@command{scp}.
118You can find the latest version of this document on the web at 95You can find the latest version of this document on the web at
119@uref{http://www.freesoftware.fsf.org/tramp/}. 96@uref{http://www.freesoftware.fsf.org/tramp/}.
120 97
98@c Pointer to the other Emacs flavor is necessary only in case of
99@c standalone installation. Text taken from trampinst.texi.
100@ifset tramp-inst
101@otherflavor{}
102@end ifset
103
121@ifhtml 104@ifhtml
122This manual is also available as a @uref{tramp_ja.html, Japanese 105This manual is also available as a @uref{tramp_ja.html, Japanese
123translation}. 106translation}.
@@ -144,21 +127,33 @@ well as the usual Savannah archives.
144* Overview:: What @tramp{} can and cannot do. 127* Overview:: What @tramp{} can and cannot do.
145 128
146For the end user: 129For the end user:
130
147* Obtaining @tramp{}:: How to obtain @tramp{}. 131* Obtaining @tramp{}:: How to obtain @tramp{}.
148* History:: History of @tramp{}. 132* History:: History of @tramp{}.
133@ifset tramp-inst
149* Installation:: Installing @tramp{} with your @value{emacs-name}. 134* Installation:: Installing @tramp{} with your @value{emacs-name}.
135@end ifset
150* Configuration:: Configuring @tramp{} for use. 136* Configuration:: Configuring @tramp{} for use.
151* Usage:: An overview of the operation of @tramp{}. 137* Usage:: An overview of the operation of @tramp{}.
152* Bug Reports:: Reporting Bugs and Problems. 138* Bug Reports:: Reporting Bugs and Problems.
153* Frequently Asked Questions:: Questions and answers from the mailing list. 139* Frequently Asked Questions:: Questions and answers from the mailing list.
154 140
155For the developer: 141For the developer:
142
156* Version Control:: The inner workings of remote version control. 143* Version Control:: The inner workings of remote version control.
157* Files directories and localnames:: How file names, directories and localnames are mangled and managed. 144* Files directories and localnames:: How file names, directories and localnames are mangled and managed.
158* Issues:: Debatable Issues and What Was Decided. 145* Issues:: Debatable Issues and What Was Decided.
159 146
160@detailmenu 147@detailmenu
161 --- The Detailed Node Listing --- 148 --- The Detailed Node Listing ---
149@c
150@ifset tramp-inst
151Installing @tramp{} with your @value{emacs-name}
152
153* Installation parameters:: Parameters in order to control installation.
154* Load paths:: How to plug-in @tramp{} into your environment.
155
156@end ifset
162 157
163Configuring @tramp{} for use 158Configuring @tramp{} for use
164 159
@@ -194,7 +189,7 @@ Things related to Version Control that don't fit elsewhere
194* Remote File Ownership:: How VC determines who owns a workfile. 189* Remote File Ownership:: How VC determines who owns a workfile.
195* Back-end Versions:: How VC determines what release your RCS is. 190* Back-end Versions:: How VC determines what release your RCS is.
196 191
197How file names, directories and localnames are mangled and managed. 192How file names, directories and localnames are mangled and managed
198 193
199* Localname deconstruction:: Breaking a localname into its components. 194* Localname deconstruction:: Breaking a localname into its components.
200 195
@@ -438,188 +433,10 @@ The most recent addition of major features were the multi-hop methods
438added in April 2000 and the unification of @tramp{} and Ange-FTP 433added in April 2000 and the unification of @tramp{} and Ange-FTP
439filenames in July 2002. 434filenames in July 2002.
440 435
441 436@c Installation chapter is necessary only in case of standalone
442@node Installation 437@c installation. Text taken from trampinst.texi.
443@chapter Installing @tramp{} into @value{emacs-name}. 438@ifset tramp-inst
444@cindex installation 439@installationchapter{}
445
446If you use the version that comes with your @value{emacs-name}, the
447following information is not necessary. Installing @tramp{} into your
448@value{emacs-name} is a relatively easy process, at least compared
449to rebuilding your machine from scratch. ;)
450
451Seriously though, the installation should be a fairly simple matter.
452The easiest way to proceed is as follows:
453
454@itemize @bullet
455@item
456Choose a directory, say @file{~/@value{emacs-dir}/}. Change into that
457directory and unpack the tarball. This will give you a directory
458@file{~/@value{emacs-dir}/tramp-@trampver{}/} which contains
459subdirectories @file{lisp} for the Lisp code and @file{texi} for the
460documentation. Make a symbolic link:
461
462@example
463ln -s tramp-@trampver{} tramp
464@end example
465
466@item
467@command{cd} to @file{~/@value{emacs-dir}/tramp/} and type
468@command{./configure} to configure Tramp for your system.
469
470Running `configure' takes awhile. While running, it prints some
471messages telling which features it is checking for.
472
473@item
474Type @command{make} to build the byte-compiled Lisp files as well as
475the Info manual.
476
477@item
478Type @command{make install} to install the Tramp Lisp files and Info
479manual.
480
481@item
482You can remove the byte-compiled Lisp files and the Info manual from
483the source directory by typing @command{make clean}. To also remove
484the files that @command{configure} created, type @command{make
485distclean}.
486
487@item
488NOTE: If you run into problems running the example @command{make}
489command, don't despair. You can still byte compile the @file{*.el}
490files by opening @value{emacs-name} in @command{dired} (@command{C-x
491d}) mode, at @file{~/@value{emacs-dir}/tramp/lisp}. Mark the lisp files with
492@kbd{m}, then press @kbd{B} to byte compile your selections.
493
494Something similar can be done to create the info manual. Just change
495to directory @file{~/@value{emacs-dir}/tramp/texi} and load the
496@file{tramp.texi} file in @value{emacs-name}. Then press @kbd{M-x
497texinfo-format-buffer @key{RET}} to generate
498@file{~/@value{emacs-dir}/tramp/info/tramp}.
499@end itemize
500
501@menu
502* Installation parameters:: Parameters in order to control installation.
503* Load paths:: How to plug-in @tramp{} into your environment.
504@end menu
505
506@node Installation parameters
507@section Parameters in order to control installation.
508@cindex installation
509
510By default, @command{make install} will install @tramp{}'s files in
511@file{@value{lispdir}} and @file{@value{infodir}}. You can specify an
512installation prefix other than @file{@value{prefix}} by giving
513@command{configure} the option @command{--prefix=PATH}.
514
515If your installed copy of Emacs is named something other than
516@command{@value{emacs-dir}}, you will need to tell `make' where to find it so
517that it can correctly byte-compile the @tramp{} sources.
518
519Also, the @command{--prefix=PATH} option to @command{configure} may
520not be general enough to set the paths you want. If not, you can pass
521variables to the @command{make} command to control the installation.
522For a complete list of tweakable variables, look in the makefile.
523
524For example, to put the Lisp files in @file{~/elisp} and the Info file
525in @file{~/info}, you would type:
526
527@example
528./configure
529make
530make lispdir=~/elisp infodir=~/info install
531@end example
532
533@tramp{} has some packages in its @file{contrib} directory which are
534missing in older Emacsen. If you want to use them, you must use the
535@command{USE_CONTRIB} environment variable:
536
537@example
538make USE_CONTRIB=1
539make USE_CONTRIB=1 install
540@end example
541
542@node Load paths
543@section How to plug-in @tramp{} into your environment.
544@cindex installation
545
546If you don't install @tramp{} into the intended directories, but prefer
547to use from the source directory, you need to add the following lines
548into your @file{.emacs}:
549
550@lisp
551(add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/")
552(add-to-list 'load-path "~/@value{emacs-dir}/tramp/contrib/")
553(require 'tramp)
554@end lisp
555
556The second load-path must be used only if you've applied the
557@command{USE_CONTRIB} parameter.
558
559@ifset xemacs
560NOTE: For @value{emacs-name}, the package @file{fsf-compat} must be
561installed. For details on package installation, see @ref{Packages, ,
562,xemacs}.
563@ifhtml
564(If the previous link doesn't work, try the @value{emacs-name}
565documentation at
566@uref{http://www.xemacs.org/Documentation/packageGuide.html,the
567@value{emacs-name} site}.)
568@end ifhtml
569@end ifset
570
571To be able to read the Info documentation, create a file
572@file{~/@value{emacs-dir}/tramp/info/dir} using the
573@command{install-info} command, and add the directory to the search
574path for Info.
575
576NOTE:
577On systems using the @cite{gnu} version of @command{install-info}, the
578@command{install-info} syntax is very direct and simple. One can
579change to directory @file{~/@value{emacs-dir}/tramp/info} and type:
580
581@example
582install-info tramp dir
583@end example
584
585and a @file{dir} file will be created with the @tramp{}
586entry. The info reader will know how to interpret it, but must
587be told where to find it (see below). If you want anything fancier
588you'll need to look through @kbd{man install-info}.
589
590Debian gnu/linux doesn't default to @cite{gnu} @command{install-info}
591and uses its own version. This version does not create a @file{dir}
592file for you from scratch. You must provide a skeleton @file{dir}
593file it recognizes. One can be found in a default installation of
594@value{emacs-name} at @file{/usr/info/dir}. Copy the top of this file
595down to the first occurrence of @code{* Menu} including that line plus
596one more blank line, to your working directory
597@file{~/@value{emacs-dir}/tramp/info}, or use the sample
598@file{~/@value{emacs-dir}/tramp/texi/dir_sample}.
599
600Once a @file{dir} file is in place, this command will make the entry:
601
602@example
603install-info --infodir=. tramp
604@end example
605
606If you want it in a specific category see @kbd{man install-info} for
607further details.
608
609If the environment variable @env{INFOPATH} is set, add the directory
610@file{~/@value{emacs-dir}/tramp/info/} to it. Else, add the directory to
611@ifset emacs
612@code{Info-default-directory-list}, as follows:
613
614@lisp
615(add-to-list 'Info-default-directory-list "~/@value{emacs-dir}/tramp/info/")
616@end lisp
617@end ifset
618@ifset xemacs
619@code{Info-directory-list}, as follows:
620@lisp
621(add-to-list 'Info-directory-list "~/@value{emacs-dir}/tramp/info/")
622@end lisp
623@end ifset 440@end ifset
624 441
625@node Configuration 442@node Configuration
diff --git a/man/trampver.texi b/man/trampver.texi
index 7ff409491e3..943651691b4 100644
--- a/man/trampver.texi
+++ b/man/trampver.texi
@@ -5,10 +5,56 @@
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@macro trampver{} 7@macro trampver{}
82.0.31 82.0.33
9@end macro 9@end macro
10 10
11@c Other flags from configuration 11@c Other flags from configuration
12@set prefix /usr/local 12@set prefix /usr/local
13@set lispdir /usr/local/share/emacs/site-lisp 13@set lispdir /usr/local/share/emacs/site-lisp
14@set infodir /usr/local/info 14@set infodir /usr/local/info
15
16@c Some flags which make the text independent on the (X)Emacs flavor.
17@c "emacs" resp "xemacs" are set in the Makefile. Default is "emacs".
18
19@ifclear emacs
20@ifclear xemacs
21@set emacs
22@end ifclear
23@end ifclear
24
25@c Emacs values.
26@ifset emacs
27@set emacs-name Emacs
28@set emacs-dir emacs
29@set ftp-package-name Ange-FTP
30@set tramp-prefix /
31@set tramp-prefix-single-hop
32@set tramp-postfix :
33@set tramp-postfix-single-hop :
34@set tramp-postfix-multi-hop :
35@end ifset
36
37@c XEmacs counterparts.
38@ifset xemacs
39@set emacs-name XEmacs
40@set emacs-dir xemacs
41@set ftp-package-name EFS
42@set tramp-prefix /[
43@set tramp-prefix-single-hop [
44@set tramp-postfix ]
45@set tramp-postfix-single-hop /
46@set tramp-postfix-multi-hop :
47@end ifset
48
49@c Empty macro definitions in order to satisfy texi2dvi
50@macro otherflavor
51@end macro
52
53@macro installationchapter
54@end macro
55
56@c The installation chapter is needed only in case Tramp is installed
57@c standalone. That's why it is included from `trampinst.texi'.
58@c Otherwise, '/dev/null/' is tken, which leaves this part empty.
59
60