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