[Emacs-diffs] Changes to emacs/man/tramp.texi

[Kai Großjohann]

Index: emacs/man/tramp.texi
diff -c emacs/man/tramp.texi:1.17 emacs/man/tramp.texi:1.18
*** emacs/man/tramp.texi:1.17   Wed Feb  5 15:10:58 2003
--- emacs/man/tramp.texi        Fri Feb 28 13:29:33 2003
***************
*** 12,18 ****
  @c Makefile, so you should edit the top-level Makefile to change
  @c the version number.
  @macro trampver{}
! 2.0.29
  @end macro
  
  @c Entries for @command{install-info} to use
--- 12,18 ----
  @c Makefile, so you should edit the top-level Makefile to change
  @c the version number.
  @macro trampver{}
! 2.0.30
  @end macro
  
  @c Entries for @command{install-info} to use
***************
*** 57,73 ****
  @end ifset
  
  @c Macros for formatting a filename.
! @c trampfn is for a full filename, trampfnmhp means method, host, path
  @c were given, and so on.
! @macro trampfn(method, user, host, path)
! @address@hidden@value{user}@@@address@hidden@value{path}
  @end macro
  
  @copying
  Copyright @copyright{} 1999, 2000, 2001, 2002, 2003 Free Software
  Foundation, Inc.
  
! @quotation
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.1 or
  any later version published by the Free Software Foundation; with no
--- 57,73 ----
  @end ifset
  
  @c Macros for formatting a filename.
! @c trampfn is for a full filename, trampfnmhp means method, host, localname
  @c were given, and so on.
! @macro trampfn(method, user, host, localname)
! @address@hidden@value{user}@@@address@hidden@value{localname}
  @end macro
  
  @copying
  Copyright @copyright{} 1999, 2000, 2001, 2002, 2003 Free Software
  Foundation, Inc.
  
! @quotation     
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.1 or
  any later version published by the Free Software Foundation; with no
***************
*** 158,164 ****
  
  For the developer:
  * Version Control::             The inner workings of remote version control.
! * Files directories and paths::  How file names, directories and paths are 
mangled and managed.
  * Issues::                      Debatable Issues and What Was Decided.
  
  @detailmenu
--- 158,164 ----
  
  For the developer:
  * Version Control::             The inner workings of remote version control.
! * Files directories and localnames::  How file names, directories and 
localnames are mangled and managed.
  * Issues::                      Debatable Issues and What Was Decided.
  
  @detailmenu
***************
*** 197,205 ****
  * Remote File Ownership::       How VC determines who owns a workfile.
  * Back-end Versions::           How VC determines what release your RCS is.
  
! How file names, directories and paths are mangled and managed.
  
! * Path deconstruction::         Breaking a path into its components.
  
  @end detailmenu
  @end menu
--- 197,205 ----
  * Remote File Ownership::       How VC determines who owns a workfile.
  * Back-end Versions::           How VC determines what release your RCS is.
  
! How file names, directories and localnames are mangled and managed.
  
! * Localname deconstruction::         Breaking a localname into its components.
  
  @end detailmenu
  @end menu
***************
*** 447,466 ****
  
  @itemize @bullet
  @item
! Choose a directory, say @file{~/@value{emacs-dir}/}.  Change into that 
directory and
! unpack the tarball.  This will give you a directory
! @file{~/@value{emacs-dir}/tramp/} which contains subdirectories @file{lisp} 
for the
! Lisp code and @file{texi} for the documentation.
  
  @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/}:
  
  @example
  make address@hidden all
  @end example
  
  @item
  NOTE: If you run into problems running the example @command{make}
  command, don't despair.  You can still byte compile the @file{*.el}
--- 447,475 ----
  
  @itemize @bullet
  @item
! Choose a directory, say @file{~/@value{emacs-dir}/}.  Change into that
! directory and unpack the tarball.  This will give you a directory
! @file{~/@value{emacs-dir}/tramp/} which contains subdirectories
! @file{lisp} for the Lisp code and @file{texi} for the documentation.
  
  @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/}:
  
  @example
  make address@hidden all
  @end example
  
+ If there are missing libraries reported it is likely they are provided
+ in the @file{~/@value{emacs-dir}/tramp/contrib/} directory.  This
+ case, you need to call @command{make} like this:
+ 
+ @example
+ make address@hidden USE_CONTRIB=1 all
+ @end example
+ 
  @item
  NOTE: If you run into problems running the example @command{make}
  command, don't despair.  You can still byte compile the @file{*.el}
***************
*** 479,487 ****
--- 488,500 ----
  
  @lisp
  (add-to-list 'load-path "~/@value{emacs-dir}/tramp/lisp/")
+ (add-to-list 'load-path "~/@value{emacs-dir}/tramp/contrib/")
  (require 'tramp)
  @end lisp
  
+ The second @command{add-to-list} must be used only if you've compiled
+ with the @command{USE_CONTRIB} parameter.
+ 
  @item
  To be able to read the Info documentation, create a file
  @file{~/@value{emacs-dir}/tramp/texi/dir} using the
***************
*** 978,984 ****
  far, it is tested towards MS Windows NT, MS Windows 2000, and MS
  Windows XP.
  
! The first directory in the path must be a share name on the remote
  host.  Remember, that the @code{$} character in which default shares
  usually end, must be written @code{$$} due to environment variable
  substitution in file names.  If no share name is given (i.e. remote
--- 991,997 ----
  far, it is tested towards MS Windows NT, MS Windows 2000, and MS
  Windows XP.
  
! The first directory in the localname must be a share name on the remote
  host.  Remember, that the @code{$} character in which default shares
  usually end, must be written @code{$$} due to environment variable
  substitution in file names.  If no share name is given (i.e. remote
***************
*** 1026,1033 ****
  
  @cindex method multi
  @cindex multi method
! A multi-hop file name specifies a method, a number of hops, and a path
! name on the remote system.  The method name is always
  @option{multi}.
  
  Each hop consists of a @dfn{hop method} specification, a user name and
--- 1039,1046 ----
  
  @cindex method multi
  @cindex multi method
! A multi-hop file name specifies a method, a number of hops, and a
! localname (path name on the remote system).  The method name is always
  @option{multi}.
  
  Each hop consists of a @dfn{hop method} specification, a user name and
***************
*** 1108,1114 ****
  When you select an appropriate transfer method for your typical usage
  you should set the variable @var{tramp-default-method} to reflect that
  choice.  This variable controls which method will be used when a method
! is not specified in the @tramp{} file path.  For example:
  
  @lisp
  (setq tramp-default-method "scp")
--- 1121,1127 ----
  When you select an appropriate transfer method for your typical usage
  you should set the variable @var{tramp-default-method} to reflect that
  choice.  This variable controls which method will be used when a method
! is not specified in the @tramp{} file name.  For example:
  
  @lisp
  (setq tramp-default-method "scp")
***************
*** 1202,1208 ****
  
  @defun tramp-set-completion-function method function-list
  This function sets @var{function-list} as list of completion functions
! for @var{method}.
  
  Example:
  @example
--- 1215,1221 ----
  
  @defun tramp-set-completion-function method function-list
  This function sets @var{function-list} as list of completion functions
! for @var{method}. 
  
  Example:
  @example
***************
*** 1487,1495 ****
  @cindex filename syntax
  @cindex filename examples
  
! To access the file @var{path} on the remote machine @var{machine} you
  would specify the filename
! @address@hidden@address@hidden@var{path}}.
  This will connect to @var{machine} and transfer the file using the
  default method.  @xref{Default Method}.
  
--- 1500,1508 ----
  @cindex filename syntax
  @cindex filename examples
  
! To access the file @var{localname} on the remote machine @var{machine} you
  would specify the filename
! @address@hidden@address@hidden@var{localname}}.
  This will connect to @var{machine} and transfer the file using the
  default method.  @xref{Default Method}.
  
***************
*** 1885,1890 ****
--- 1898,1913 ----
  fi
  @end example
  
+ 
+ @item @tramp{} doesn't transfer strings with more than 500 characters
+ correctly
+ 
+ On some few systems, the implementation of @code{process-send-string}
+ seems to be broken for longer strings.  This case, you should
+ customize the variable @code{tramp-chunksize} to 500.  For a
+ description how to determine whether this is necessary see the
+ documentation of @code{tramp-chunksize}.
+ 
  @end itemize
  
  
***************
*** 1936,1942 ****
  
  In the case of a remote file, the @code{shell-command} interface is
  used, with some wrapper code, to provide the same functionality on the
! remote machine as would be seen on the local machine.
  
  
  @node Changed workfiles
--- 1959,1965 ----
  
  In the case of a remote file, the @code{shell-command} interface is
  used, with some wrapper code, to provide the same functionality on the
! remote machine as would be seen on the local machine. 
  
  
  @node Changed workfiles
***************
*** 2034,2060 ****
  system basis and the results cached to improve performance.
  
  
! @node Files directories and paths
! @chapter How file names, directories and paths are mangled and managed.
  
  @menu
! * Path deconstruction::         Breaking a path into its components.
  @end menu
  
  
! @node Path deconstruction
! @section Breaking a path into its components.
  
! @tramp{} filenames are somewhat different, obviously, to ordinary path
  names. As such, the lisp functions @code{file-name-directory} and
! @code{file-name-nondirectory} are overridden within the @tramp{} package.
  
  Their replacements are reasonably simplistic in their approach. They
! dissect the filename, call the original handler on the remote path and
! then rebuild the @tramp{} path with the result.
  
  This allows the platform specific hacks in the original handlers to take
! effect while preserving the @tramp{} path information.
  
  
  @node Issues
--- 2057,2084 ----
  system basis and the results cached to improve performance.
  
  
! @node Files directories and localnames
! @chapter How file names, directories and localnames are mangled and managed.
  
  @menu
! * Localname deconstruction::    Breaking a localname into its components.
  @end menu
  
  
! @node Localname deconstruction
! @section Breaking a localname into its components.
  
! @tramp{} file names are somewhat different, obviously, to ordinary file
  names. As such, the lisp functions @code{file-name-directory} and
! @code{file-name-nondirectory} are overridden within the @tramp{}
! package.
  
  Their replacements are reasonably simplistic in their approach. They
! dissect the filename, call the original handler on the localname and
! then rebuild the @tramp{} file name with the result.
  
  This allows the platform specific hacks in the original handlers to take
! effect while preserving the @tramp{} file name information.
  
  
  @node Issues