annotate docs/gftp.1 @ 883:707b3502ae02

2007-3-12 Brian Masney <masneyb@gftp.org> * docs/gftp.1 - updated man page
author masneyb
date Tue, 13 Mar 2007 01:18:35 +0000
parents f3d499134cf7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
1 .TH GFTP 1 "MARCH 2007"
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
2 .SH NAME
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
3 gftp - file transfer client for *NIX based machines.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
4 .SH SYNOPSIS
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
5 .B gftp [options] [[proto://][
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
6 .I user
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
7 .B :
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
8 .I [pass]
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
9 .B @]
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
10 .I server
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
11 .B [:
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
12 .I port
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
13 .B ][/
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
14 .I directory
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
15 .B ]]
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
16 .SH DESCRIPTION
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
17 gFTP is a file transfer client for *NIX based machines. It currently has a text interface and a GTK+ 1.2/2.x graphical interface. It currently supports the FTP, FTPS (control connection only), HTTP, HTTPS, SSH and FSP protocols.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
18 .SH OPTIONS
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
19 You may enter a url on the command line that gFTP will automatically connect to when it starts up.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
20 .IP "\-\-help, \-h"
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
21 Display program usage.
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
22 .IP "\-\-info"
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
23 Display some information about how gFTP was built. Please send the output of this command when submitting a bug report.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
24 .IP "\-\-version, \-v"
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
25 Display the current version of gFTP.
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
26 .IP proto
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
27 This specifies the protocol that should be used. It can currently be one of the following options: ftp, ftps, http, https, ssh, fsp, local and bookmark. If omitted, the protocol specified by the default_protocol option will be used.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
28 .IP user
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
29 The username that will be used to log into the remote server. If omitted, your current username will be used for most protocols. For the FTP protocol, the anonymous username will be used.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
30 .IP pass
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
31 The password that will be used to log into the remote server. If omitted, you will be prompted for the password. If you are using the FTP protocol, and the username is anonymous, then your email address will be used as the password.
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
32 .IP server
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
33 The remote server to connect to.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
34 .IP port
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
35 The remote port on the server to connect to. If omitted, the default port for the protocol will be used. The port will be looked up in the
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
36 .BR services(5)
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
37 file.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
38 .IP directory
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
39 The directory to change to once you are connected to the remote server.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
40 .SH FILES
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
41 .I ~/.gftp/gftprc
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
42 .RS
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
43 Per user configuration file. Most of these options can be edited inside gFTP. This file is also commented very well.
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
44 .I ~/.gftp/bookmarks
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
45 .RS
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
46 Per user bookmarks file.
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
47 .SH BUGS
883
707b3502ae02 2007-3-12 Brian Masney <masneyb@gftp.org>
masneyb
parents: 745
diff changeset
48 If you find any bugs in gFTP, please report them to GNOME's Bugzilla at http://bugzilla.gnome.org/
1
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
49 .SH AUTHOR
8b1883341c6f Initial revision
masneyb
parents:
diff changeset
50 Brian Masney <masneyb@gftp.org> - http://www.gftp.org/