Subversion Repositories

.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH LSFTP 1 "Aug 21 2002" lsftp "lsh manuals"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
lsftp \- lsh's sftp client
.SH SYNOPSIS
.B lsftp
.RI [ transport-options ] [-- " command" ...]
.SH DESCRIPTION
This manual page documents briefly the
.B lsftp
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
Instead, it has documentation in the GNU Info format; see below.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBlsftp\fP is a program that connects to a remote sftp server, and can be
used to upload download files \['a] la FTP. When invoked with no command arguments,
lsftp enters interactive mode, much like \fBftp (1)\fP. However, when the
\fI--\fP argument and subsequent commands are passed to lsftp, lsftp simply
executes those commands and exits.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of program.
.SH COMMANDS
.TP
.B cd \fIdirectory\fP
Change the current directory on the remote server to \fIdirectory\fP.
.TP
.B rm \fIfilespec\fP
Removes files or directories. To delete directories, the \-r option needs to be
specified. The rm command doesn't accept wildcards by default, to enable these
you must specify the \-g option.
.TP
.B delete
Alias for \fBrm\fP.
.TP
.B mkdir \fIdir\fP
Make directory \fIdir\fP.
.TP
.B about
Display information about lsftp.
.TP
.B help
Displays a list of commands.
.TP
.B ?
Alias for \fBhelp\fP.
.TP
.B longhelp
Displays the list of commands with detailed information about each command.
.TP
.B ls \fIfilespec\fP
List remote files and folders.
.TP
.B list
Alias for \fBls\fP.
.TP
.B dir
(Another) Alias for \fBls\fP.
.TP
.B pwd
Print the current working directory.
.TP
.B quit
Quit lsftp.
.TP
.B exit
Quit lsftp.
.TP
.B set [\fIvar=value\fP]
Sets or shows variables. Without an argument, \fIset\fP displays the current variable state. With
a \fIvar=value\fP argument, \fBset\fP sets the appropriate variable in the environment.
.TP
.B mail
Runs the \fBmail (1)\fP command.
.TP
.B umask [\fIvalue\fP]
Sets or displays the remote umask.
.TP
.B jobs
Prints information about currently running jobs.
.TP
.B open \fIsite\fP
Open a sftp connection to \fIsite\fP.
.TP
.B close
Close the current connection.
.TP
.B mv \fIold\-filename\fP \fInew\-filename\fP
Rename file \fIold\-filename\fP to \fInew\-filename\fP.
.TP
.B rename
Alias for \fBmv\fP.
.TP
.B ln \fIfile\fP \fIlink\fP
Make \fIlink\fP a symlink to \fIfile\fP.
.TP
.B get \fIremote\-file\fP
Retrieve \fIremote\-file\fP on the remote system to the local system.
.TP
.B put \fIlocal\-file\fP
Send \fIlocal\-file\fP on the local system to the remote system.
.TP
.B chown \fIuid\fP \fIfile\fP
Change the ownership of \fIfile\fP to be owned by the user represented by
\fIuid\fP.
.TP
.B chgrp \fIgid\fP \fIfile\fP
Change the group ownership of \fIfile\fP to be owned by the group represented by
\fIgid\fP.
.TP
.B lcd \fIdir\fP
Change the current local directory to \fIdir\fP.
.TP
.B lrm \fIfile\fP
Remove \fIfile\fP from the \fBlocal\fP system.
.TP
.B ldelete
Alias for \fBlrm\fP.
.TP
.B lls
List files on the local system.
.TP
.B llist
Alias for \fBlls\fP.
.TP
.B lpwd
Print the current local working directory.
.TP
.B ! \fIcommand\fP
Executes \fIcommand\fP in a shell on the local system.
.SH ENVIRONMENT
.TP
.B LSFTP_RSH
The program to use for the SSH tunnel. If the variable is not set, lsftp
defaults to using lshg.
.TP
.B LSFTP_BEFORE_ARGS
.TP
.B LSFTP_AFTER_ARGS
.SH SEE ALSO
.BR lshc (1),
.BR mail (1),
.BR lshd (8),
.BR lshg (8).
.BR
The programs are documented fully by
.IR "Lsh" ,
available via the Info system.
.SH AUTHOR
This manual page was written by Timshel Knoll <timshel@debian.org>,
for the Debian GNU/Linux system (but may be used by others).