debian/patches/netrc-doc.dpatch

   1 #! /bin/sh /usr/share/dpatch/dpatch-run
   2 ## netrc-doc.dpatch by Sebastian Harl <sh@tokkee.org>
   3 ##
   4 ## DP: Document the .netrc file support.
   5
   6 @DPATCH@
   7
   8 --- a/doc/cadaver.1     2007-01-08 15:32:18.000000000 +0100
   9 +++ b/doc/cadaver.1     2007-01-08 15:32:13.000000000 +0100
  10 @@ -14,6 +14,12 @@
  11  .BR smbclient (1).
  12  A user familiar with these tools should be quite
  13  comfortable with cadaver.
  14 +
  15 +.B cadaver
  16 +supports automatically logging in to servers requiring authentication via
  17 +a .netrc file (similar to
  18 +.BR ftp (1)
  19 +- see section "THE .netrc FILE" below).
  20  .SH OPTIONS
  21  .IP "-e, --expect100"
  22  Enable sending of `Expect: 100-continue' header.
  23 @@ -93,6 +99,55 @@
  24  Logout of authentication session
  25  .IP "help [command]"
  26  Display help message
  27 +.SH THE .netrc FILE
  28 +The file
  29 +.I ~/.netrc
  30 +may be used to automatically login to a server requiring authentication. The
  31 +following tokens (separated by spaces, tabs or newlines) may be used:
  32 +
  33 +.B machine
  34 +.I host
  35 +.RS
  36 +Identify a remote machine
  37 +.I host
  38 +which is compared with the hostname given on the command line or as an
  39 +argument to the
  40 +.B open
  41 +command.
  42 +Any subsequent tokens up to the end of file or the next
  43 +.B machine
  44 +or
  45 +.B default
  46 +token are associated with this entry.
  47 +.RE
  48 +
  49 +.B default
  50 +.RS
  51 +This is equivalent to the
  52 +.B machine
  53 +token but matches any hostname. Only one
  54 +.B default
  55 +token may be used and it must be after all
  56 +.B machine
  57 +tokens.
  58 +.RE
  59 +
  60 +.B login
  61 +.I username
  62 +.RS
  63 +Specifies the username to use when logging in to the remote machine.
  64 +.RE
  65 +
  66 +.B password
  67 +.I string
  68 +.br
  69 +.B passwd
  70 +.I string
  71 +.RS
  72 +Specifies the password to use when logging in to the remote machine.
  73 +.RE
  74 +
  75 +Any other tokens (as described in ftp(1)) are ignored.
  76  .SH EXAMPLES
  77  .IP "cadaver http://dav.example.com/"
  78  Connects to the server myserver.example.com, opening the root collection.
  79 @@ -105,6 +160,9 @@
  80  .SH FILES
  81  .IP "~/.cadaverrc"
  82  Individual user settings that can override cadaver defaults.
  83 +.IP "~/.netrc"
  84 +Login and initialization information used by the auto-login process. See
  85 +section "THE .netrc FILE" for details.
  86  .SH AUTHOR
  87  Joe Orton <cadaver@webdav.org>
  88  .SH SEE ALSO