xaizek / vifm (License: GPLv2+) (since 2018-12-07)
Vifm is a file manager with curses interface, which provides Vi[m]-like environment for managing objects within file systems, extended with some useful ideas from mutt.
Clone URLs: https://code.reversed.top/user/xaizek/vifm ssh://rocketgit@code.reversed.top/user/xaizek/vifm
v0.13 v0.13-beta v0.14 v0.14-beta v0.14.1 v0.14.2 v0.14.3 master
Commit 000d376a01e4624a4f6fb3ff8b827e248893ca18

Update INSTALL file
Retab it.
Remove trailing spaces.
Mention ncurses in Mac OS section.
Author: xaizek
Author date (UTC): 2012-05-26 21:35
Committer name: xaizek
Committer date (UTC): 2012-06-03 11:13
Parent(s): a8f7366235719cfce7d453fd03d3c809de8dbd92
Signing key:
Tree: 5e83ee6208e4daa594b0a247a1b6ec4c11efabc1
File Lines added Lines deleted
INSTALL 38 39
File INSTALL changed (mode: 100644) (index c6079e464..2b94045c2)
... ... Installation
3 3
4 4 On *nix you need: On *nix you need:
5 5
6 A working version of ncursesw and an ascii compliant terminal.
7 Vifm will currently not work with Solaris curses or with PDcurses.
6 A working version of ncursesw and an ascii compliant terminal.
7 Vifm will currently not work with Solaris curses or with PDcurses.
8 8
9 9 *nix Installation: *nix Installation:
10 10
11 ./configure
12 make
13 ("su" if you don't have access to /usr/local/bin)
14 make install
11 ./configure
12 make
13 ("su" if you don't have access to /usr/local/bin)
14 make install
15 15
16 16 ./configure has the following options (the value in square brackets shows ./configure has the following options (the value in square brackets shows
17 17 is the default one): is the default one):
 
... ... On *nix you need:
34 34 --without/[with]-libmagic - use libmagic to determine mimetypes if --without/[with]-libmagic - use libmagic to determine mimetypes if
35 35 available. available.
36 36
37 You can install vifm in your ~/ directory if you prefer.
37 You can install vifm in your ~/ directory if you prefer.
38 38 Copy the vifm, vifmrc-converter and pauseme executables to where you Copy the vifm, vifmrc-converter and pauseme executables to where you
39 39 want to run them. You will also need to copy vifm help files and want to run them. You will also need to copy vifm help files and
40 40 vifmrc file to ~/.vifm/. vifmrc file to ~/.vifm/.
41 41
42 After you start vifm for the first time, you should edit the configuration
43 file. It will be at ~/.vifm/vifmrc.
44 If you edit the vifmrc file with vifm running any changes you make
45 will be overwritten when you close vifm.
42 After you start vifm for the first time, you can edit the configuration
43 file. It will be at ~/.vifm/vifmrc. See help for description of other
44 files in ~/.vifm directory.
46 45
47 46 On Mac OS you need: On Mac OS you need:
48 47
49 Get and install libscursesw.
48 Get and install libscursesw or libncursesw.
50 49 Proceed like in *nix Installation section. Proceed like in *nix Installation section.
51 50 Also you probably want to pass --with-gtk=no argument to ./configure Also you probably want to pass --with-gtk=no argument to ./configure
52 51 script to omit unwanted error message when vifm starts. script to omit unwanted error message when vifm starts.
53 52
54 53 On Windows you need: On Windows you need:
55 54
56 Mingw
57 Pdcurses for Mingw
58 Regex for Mingw
55 Mingw
56 Pdcurses for Mingw
57 Regex for Mingw
59 58 pthreads for Windows pthreads for Windows
60 59
61 60 Windows Installation: Windows Installation:
 
... ... Windows Installation:
83 82
84 83 Vim Specific Options: Vim Specific Options:
85 84
86 If you use vim, copy the vifm.txt file in the data/vim/doc directory to
87 your ~/.vim/doc directory or the system vim/doc directory.
88 Then launch vim ahd give the command
89 :helptags ~/.vim/doc
90 or
91 :helptags path/to/system/vim/doc
92 depending on where you installed the vifm.txt file.
93
94 You will also need to change set 'vimhelp' option
95 in ~/.vifm/vifmrc as the default setting is to use the plain text file.
96
97 If you want to use syntax highlighting and file type plugin for
98 ~/.vifm/vifmrc file, copy the data/vim/syntax/vifmrc.vim and
99 data/vim/ftplugin/vifmrc.vim file to either the system wide vim syntax and
100 ftplugin directories appropriately just copy the
85 If you use vim, copy the vifm.txt file in the data/vim/doc directory to
86 your ~/.vim/doc directory or the system vim/doc directory.
87 Then launch vim ahd give the command
88 :helptags ~/.vim/doc
89 or
90 :helptags path/to/system/vim/doc
91 depending on where you installed the vifm.txt file.
92
93 You will also need to change set 'vimhelp' option
94 in ~/.vifm/vifmrc as the default setting is to use the plain text file.
95
96 If you want to use syntax highlighting and file type plugin for
97 ~/.vifm/vifmrc file, copy the data/vim/syntax/vifmrc.vim and
98 data/vim/ftplugin/vifmrc.vim file to either the system wide vim syntax and
99 ftplugin directories appropriately just copy the
101 100 data/vim/ftdetect/vifm.vim file to appropriate vim configuration data/vim/ftdetect/vifm.vim file to appropriate vim configuration
102 101 directory. Or add to your .vimrc file commands like: directory. Or add to your .vimrc file commands like:
103 autocmd BufNewFile,BufRead vifmrc :set filetype=vifm
104 autocmd BufNewFile,BufRead ~/.vifm/colors/* :set filetype=vifm
105 or if you use mode lines, add as the first or the last line to
102 autocmd BufNewFile,BufRead vifmrc :set filetype=vifm
103 autocmd BufNewFile,BufRead ~/.vifm/colors/* :set filetype=vifm
104 or if you use mode lines, add as the first or the last line to
106 105 configuration file and color schemes: configuration file and color schemes:
107 " vim: set filetype=vifm :
106 " vim: set filetype=vifm :
108 107
109 If you want to use the vifm.vim plugin, copy the vifm.vim plugin script in
110 data/vim/plugin to either the system wide vim/plugin or to ~/.vim/plugin/.
111 The vifm.vim script allows you to use vifm from vim to select files. The
112 vifm.vim script is not installed by default and must be manually copied to
113 the plugin directory. Note: you need Vim 7.3 for plugin.
108 If you want to use the vifm.vim plugin, copy the vifm.vim plugin script in
109 data/vim/plugin to either the system wide vim/plugin or to ~/.vim/plugin/.
110 The vifm.vim script allows you to use vifm from vim to select files. The
111 vifm.vim script is not installed by default and must be manually copied to
112 the plugin directory. Note: you need Vim 7.3 for plugin.
Hints
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/vifm

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/vifm

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master