rename project to visftp
[oftp] / README.md
1 visftp - visual ftp client with dual-pane text-mode UI
2 ======================================================
3
4 visftp is a text-mode graphical ftp client, with a dual-pane UI , also known as
5 the "orthodox" file management UI paradigm. The dual-pane UI design is a
6 perfect fit for an FTP client, where the user is required to navigate two
7 filesystems simultaneously; one pane is dedicated to the remote filesystem
8 served over ftp, while the other is for navigating the local filesystem.
9
10 visftp was written to address the lack of graphical FTP clients for DOS
11 (MS-DOS, FreeDOS, etc), but will also run on UNIX systems using curses for its
12 UI.
13
14 **Release status**: *Prototype*. visftp mostly works, but it's very rough, and you
15 will find lots of bugs. Feel free to open bug reports, but keep in mind that the
16 most obvious issues will be solved as a matter of course as this project
17 progresses.
18
19
20 License
21 -------
22 Copyright (C) John Tsiombikas <nuclear@mutantstargoat.com>
23
24 This program is free software. Feel free to use, modify, and/or redistribute it
25 under the terms of the GNU General Public License version 3, or any later
26 version published by the Free Software Foundation. See COPYING for details.
27
28 Hotkeys
29 -------
30   - TAB: switch active pane
31   - F5: copy selected (upload/download)
32   - F7: create new directory
33   - F8: delete selected
34   - F10: quit
35   - `~`: force UI redraw