1 8fe7904a 2014-11-07 marcelgmr Introduction
2 8fe7904a 2014-11-07 marcelgmr ============
4 c9f42136 2021-11-25 op > fm is a file browser for the terminal.
6 c9f42136 2021-11-25 op The main goal is to provide a faster way to explore a file system from
7 c9f42136 2021-11-25 op the terminal, compared to what's possible by using `cd`, `ls`, etc. fm
8 c9f42136 2021-11-25 op has vi-like key bindings for navigation and can open files in $PAGER and
9 c9f42136 2021-11-25 op $EDITOR. Basic file system operations are also implemented (see fm(1)
10 c9f42136 2021-11-25 op for details). fm is designed to be simple, fast and portable.
12 c9f42136 2021-11-25 op fm was forked from [Rover](https://github.com/lecram/rover).
14 8fe7904a 2014-11-07 marcelgmr Quick Start
15 8fe7904a 2014-11-07 marcelgmr ===========
17 d781a4b9 2015-04-17 marcelgmr Building and Installing:
20 8faaef35 2014-11-09 marcelgmr $ sudo make install
23 8fe7904a 2014-11-07 marcelgmr Running:
25 c9f42136 2021-11-25 op $ fm [DIR1 [DIR2 [DIR3 [...]]]]
28 179ab105 2017-02-15 marcelgmr Basic Usage:
31 c9f42136 2021-11-25 op ? - show fm manual
32 8986353b 2014-11-11 marcelgmr j/k - move cursor down/up
33 8986353b 2014-11-11 marcelgmr J/K - move cursor down/up 10 lines
34 b90df0a4 2015-06-05 marcelgmr g/G - move cursor to top/bottom of listing
35 8fe7904a 2014-11-07 marcelgmr l - enter selected directory
36 8fe7904a 2014-11-07 marcelgmr h - go to parent directory
37 8fe7904a 2014-11-07 marcelgmr H - go to $HOME directory
38 179ab105 2017-02-15 marcelgmr 0-9 - change tab
39 8fe7904a 2014-11-07 marcelgmr RETURN - open $SHELL on the current directory
40 2f7057e8 2014-11-09 marcelgmr SPACE - open $PAGER with the selected file
41 e6fea658 2017-09-29 marcelgmr e - open $VISUAL or $EDITOR with the selected file
42 8fe7904a 2014-11-07 marcelgmr / - start incremental search (RETURN to finish)
43 7b9cb44d 2014-11-14 marcelgmr n/N - create new file/directory
44 2a2e3586 2015-07-27 marcelgmr R - rename selected file or directory
45 5544fe58 2015-07-22 marcelgmr D - delete selected file or (empty) directory
48 c9f42136 2021-11-25 op Please read fm(1) for more information.
51 335bf069 2015-06-21 marcelgmr Requirements
52 0aeec769 2014-11-07 marcelgmr ============
54 335bf069 2015-06-21 marcelgmr * Unix-like system;
55 335bf069 2015-06-21 marcelgmr * curses library.
58 8fe7904a 2014-11-07 marcelgmr Configuration
59 8fe7904a 2014-11-07 marcelgmr =============
61 c9f42136 2021-11-25 op fm configuration (mostly key bindings and colors) can only be changed by
62 335bf069 2015-06-21 marcelgmr editing the file `config.h` and rebuilding the binary.
64 c9f42136 2021-11-25 op Note that the external programs executed by some fm commands may be
65 c9f42136 2021-11-25 op changed via the appropriate environment variables. For example, to
66 c9f42136 2021-11-25 op specify an editor:
69 c9f42136 2021-11-25 op $ VISUAL=vi fm
72 c9f42136 2021-11-25 op fm will first check for variables prefixed with ROVER_. This can be used
73 c9f42136 2021-11-25 op to change fm behavior without interfering with the global environment:
76 c9f42136 2021-11-25 op $ ROVER_VISUAL=vi rover
79 c9f42136 2021-11-25 op Please read fm(1) for more information.
82 d1f7bb95 2015-06-02 marcelgmr Copying
83 d1f7bb95 2015-06-02 marcelgmr =======
85 c9f42136 2021-11-25 op All of the source code and documentation for fm is released into the
86 c9f42136 2021-11-25 op public domain and provided without warranty of any kind.
