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.
Commit 9829e9bbb3c5ab34cf8a74e2d541333d3710c2cf

Update README file format
Author: xaizek
Author date (UTC): 2012-05-26 21:56
Committer name: xaizek
Committer date (UTC): 2012-06-03 11:13
Parent(s): 000d376a01e4624a4f6fb3ff8b827e248893ca18
Signing key:
Tree: b3c47ab14ce41391ab1a9fe038cf7deabed33dd6
File Lines added Lines deleted
README 153 92
deploy 5 0
File README changed (mode: 100644) (index 36fae7f60..5adf0c7e8)
1 See the INSTALL file for building instructions and the TODO file for what
2 still needs to be implemented.
1 Vifm - vi[m] like file manager
2 2001 - 2012
3 3
4 This project on the Web:
5 Website: http://vifm.sourceforge.net/
6 SorceForge: http://sourceforge.net/projects/vifm/
7 GitHub: https://github.com/ksteen/vifm (preferred)
8 GitHub: https://github.com/xaizek/vifm (might be removed in the future)
4 Updated: 02 June, 2012
5 Version: 0.7.2
9 6
10 If you are interested in playing with the source code.
7 Brief Description
11 8
12 src/cfg/config.c - reads scripts and manages configuration
13 src/cfg/info.c - read and write vifminfo
14 src/engine/cmds.c - command line parsing core
15 src/engine/completion.c - provides means to fill and get completion list
16 src/engine/keys.c - analyzes users input
17 src/engine/options.c - :set command
18 src/engine/paring.c - parses expressions
19 src/engine/variables.c - handles :let and :unlet commands
20 src/menus/apropos_menu.c - handles :apropos menu
21 src/menus/bookmarks_menu.c - handles :marks menu
22 src/menus/colorscheme_menu.c - handles :colorscheme menu
23 src/menus/commands_menu.c - handles :command menu
24 src/menus/dirhistory_menu.c - handles :history menu
25 src/menus/dirstask_menu.c - handles :dirs menu
26 src/menus/filetypes_menu.c - handles :file menu
27 src/menus/find_menu.c - handles :file menu
28 src/menus/grep_menu.c - hanldes :grep menu
29 src/menus/history_menu.c - handles :history command menus except directory history
30 src/menus/jobs_menu.c - handles :jobs menu
31 src/menus/locate_menu.c - handles :locale menu
32 src/menus/map_menu.c - handles :map menu
33 src/menus/menus.c - handles all kinds of menus
34 src/menus/registers_menu.c - handles :registers menu
35 src/menus/undolist_menu.c - handles :undolist menu
36 src/menus/users_menu.c - handles menus created by %m or %M macros
37 src/menus/vifm_menu.c - handles :vifm (or :version) menu
38 src/menus/volumes_menu.c - handles :volumes menu on MS Windows systems
39 src/modes/dialogs/attr_dialog_nix.c - file permissions dialog for *nix systems
40 src/modes/dialogs/attr_dialog_win.c - file properties dialog for MS Windows systems
41 src/modes/dialogs/change_dialog.c - change dialog
42 src/modes/dialogs/sort_dialog.c - dialog to choose sort type
43 src/modes/cmdline.c - command line mode
44 src/modes/file_info.c - Control+G
45 src/modes/menu.c - handles commands in menus
46 src/modes/modes.c - general code (e.g. before and after key pressed) for modes
47 src/modes/normal.c - normal mode commands
48 src/modes/view.c - view mode commands
49 src/modes/visual.c - implementation of visual mode commands
50 src/utils/env.c - environment variables related functions
51 src/utils/fs.c - functions to deal with file system objects
52 src/utils/file_streams.c - file stream reading related functions
53 src/utils/log.c - primitive logging
54 src/utils/path.c - various functions to work with paths
55 src/utils/str.c - various string functions
56 src/utils/string_array.c - functions to work with arrays of strings
57 src/utils/tree.c - cache for ga command results
58 src/utils/utf8.c - functions to handle utf8 strings
59 src/utils/utils.c - various utilities
60 src/background.c - runs commands in background
61 src/bookmarks.c - stores information about bookmarked directories
62 src/color_scheme.c - color schemes
63 src/commands.c - handles command line commands
64 src/commands_completion.c - handles command line completion
65 src/desktop.c - code that parses *.desktop files on *nix systems
66 src/dir_stack.c - for :pushd and :popd commands
67 src/file_magic.c - determines programs associated with file using its mime-type
68 src/filelist.c - display/redraw/fill list
69 src/filename_modifiers.c - expands filename modifiers
70 src/fileops.c - delete/copy/put selected file(s)
71 src/filetype.c - stores filetype information from vifmrc
72 src/fuse.c - provides support of FUSE filesystems
73 src/globals.c - provides support of globals
74 src/ipc.c - handles communication across instances of vifm
75 src/macros - code of macros expanding
76 src/main_loop.c - the main loop
77 src/ops.c - most of operations performed on file system
78 src/opt_handlers.c - initialization of options and option change handlers
79 src/quickview.c - implementation of quick view
80 src/registers.c - implementation of registers
81 src/running.c - code of handing file and commands running
82 src/path_env.c - parses and modifies PATH environment variables
83 src/search.c - code for / and ? commands of normal mode
84 src/signals.c - handlers for different signals
85 src/sort.c - sort function
86 src/status.c - definition of global status structure
87 src/tags.c - tags for :h completion
88 src/term_title.c - implementation of support of terminal title changing
89 src/trash.c - code that handles list of files in trash
90 src/ui.c - setup_ncurses_interface() and other ui related functions
91 src/undo.c - stores and handles the undo list
92 src/version.c - git hash and other version information
93 src/vifm.c - contains main() which does basic initialization
94 src/vifmrc-converter.c - converter for vifmrc, vifminfo and colorscheme files
95 src/win_helper.c - needed for temporary rights evaluation on Windows
9 Vifm is a two panel ncurses based vi[m] like file manager. If you use vi,
10 vifm gives you complete keyboard control over your files without having
11 to learn a new set of commands. It goes not just about vi[m] like
12 keybindings, but also about modes, options, registers, commands and other
13 things you might already like in vi[m].
14
15 Just like vi vifm tries to adhere to the Unix philosophy. So instead of
16 working solutions user is provided with a set of means for customization
17 of vifm. Though builtin functionality should be enough for most of use
18 cases.
19
20 Contacts
21
22 Website: http://vifm.sourceforge.net/
23 Read-only news mailing list: vifm-announce@lists.sourceforge.net
24 Email for bugs, suggestions and comments on vifm: xaizek@gmail.com
25
26 Subscribe to the mailing list at:
27 https://lists.sourceforge.net/lists/listinfo/vifm-announce
28
29 Repositories:
30 SorceForge: http://sourceforge.net/projects/vifm/
31 GitHub: https://github.com/ksteen/vifm (preferred)
32 GitHub: https://github.com/xaizek/vifm (might be removed in the future)
33
34 Package content
35
36 .
37 |
38 |-- src/ - the source code of vifm
39 | |
40 | |-- cfg/ - code related to configuration
41 | | |
42 | | |-- config.c - reads scripts and manages configuration
43 | | `-- info.c - read and write vifminfo
44 | |
45 | |-- engine/ - the core of vi[m]-like functionality
46 | | |
47 | | |-- cmds.c - command line parsing core
48 | | |-- completion.c - provides means to fill and get completion list
49 | | |-- keys.c - analyzes users input
50 | | |-- options.c - :set command
51 | | |-- parsing.c - parses expressions
52 | | `-- variables.c - handles :let and :unlet commands
53 | |
54 | |-- menus/ - implementation of all menus
55 | | |
56 | | |-- apropos_menu.c - handles :apropos menu
57 | | |-- bookmarks_menu.c - handles :marks menu
58 | | |-- colorscheme_menu.c - handles :colorscheme menu
59 | | |-- commands_menu.c - handles :command menu
60 | | |-- dirhistory_menu.c - handles :history menu
61 | | |-- dirstask_menu.c - handles :dirs menu
62 | | |-- filetypes_menu.c - handles :file menu
63 | | |-- find_menu.c - handles :file menu
64 | | |-- grep_menu.c - hanldes :grep menu
65 | | |-- history_menu.c - handles :history command menus except directory
66 | | | history
67 | | |-- jobs_menu.c - handles :jobs menu
68 | | |-- locate_menu.c - handles :locale menu
69 | | |-- map_menu.c - handles :map menu
70 | | |-- menus.c - handles all kinds of menus
71 | | |-- registers_menu.c - handles :registers menu
72 | | |-- undolist_menu.c - handles :undolist menu
73 | | |-- users_menu.c - handles menus created by %m or %M macros
74 | | |-- vifm_menu.c - handles :vifm (or :version) menu
75 | | `-- volumes_menu.c - handles :volumes menu on MS Windows systems
76 | |
77 | |-- modes/ - implementation of all modes
78 | | |
79 | | |-- dialogs/ - dialog modes
80 | | | |
81 | | | |-- attr_dialog_nix.c - file permissions dialog for *nix systems
82 | | | |-- attr_dialog_win.c - file properties dialog for MS Windows
83 | | | | systems
84 | | | |-- change_dialog.c - change dialog
85 | | | `-- sort_dialog.c - dialog to choose sort type
86 | | |
87 | | |-- cmdline.c - command line mode
88 | | |-- file_info.c - Control+G
89 | | |-- menu.c - handles commands in menus
90 | | |-- modes.c - general code (e.g. before and after key pressed) for
91 | | | modes
92 | | |-- normal.c - normal mode commands
93 | | |-- view.c - view mode commands
94 | | `-- visual.c - implementation of visual mode commands
95 | |
96 | |-- utils/ - miscellaneous utility functions
97 | | |
98 | | |-- env.c - environment variables related functions
99 | | |-- fs.c - functions to deal with file system objects
100 | | |-- file_streams.c - file stream reading related functions
101 | | |-- log.c - primitive logging
102 | | |-- path.c - various functions to work with paths
103 | | |-- str.c - various string functions
104 | | |-- string_array.c - functions to work with arrays of strings
105 | | |-- tree.c - cache for ga command results
106 | | |-- utf8.c - functions to handle utf8 strings
107 | | `-- utils.c - various utilities
108 | |
109 | |-- background.c - runs commands in background
110 | |-- bookmarks.c - stores information about bookmarked directories
111 | |-- color_scheme.c - color schemes
112 | |-- commands.c - handles command line commands
113 | |-- commands_completion.c - handles command line completion
114 | |-- desktop.c - code that parses *.desktop files on *nix systems
115 | |-- dir_stack.c - for :pushd and :popd commands
116 | |-- file_magic.c - determines programs associated with file using its
117 | | mime-type
118 | |-- filelist.c - display/redraw/fill list
119 | |-- filename_modifiers.c - expands filename modifiers
120 | |-- fileops.c - delete/copy/put selected file(s)
121 | |-- filetype.c - stores filetype information from vifmrc
122 | |-- fuse.c - provides support of FUSE filesystems
123 | |-- globals.c - provides support of globals
124 | |-- ipc.c - handles communication across instances of vifm
125 | |-- macros - code of macros expanding
126 | |-- main_loop.c - the main loop
127 | |-- ops.c - most of operations performed on file system
128 | |-- opt_handlers.c - initialization of options and option change handlers
129 | |-- quickview.c - implementation of quick view
130 | |-- registers.c - implementation of registers
131 | |-- running.c - code of handing file and commands running
132 | |-- path_env.c - parses and modifies PATH environment variables
133 | |-- search.c - code for / and ? commands of normal mode
134 | |-- signals.c - handlers for different signals
135 | |-- sort.c - sort function
136 | |-- status.c - definition of global status structure
137 | |-- tags.c - tags for :h completion
138 | |-- term_title.c - implementation of support of terminal title changing
139 | |-- trash.c - code that handles list of files in trash
140 | |-- ui.c - setup_ncurses_interface() and other ui related functions
141 | |-- undo.c - stores and handles the undo list
142 | |-- version.c - git hash and other version information
143 | |-- vifm.c - contains main() which does basic initialization
144 | |-- vifmrc-converter.c - converter for vifmrc, vifminfo and colorscheme
145 | | files
146 | `-- win_helper.c - needed for temporary rights evaluation on Windows
147 |
148 |-- tests/ - unit tests
149 |
150 |-- AUTHORS - list of code contributors
151 |-- BUGS - some of known issues
152 |-- ChangeLog - list of changes
153 |-- FAQ - some common questions
154 |-- INSTALL - building instructions
155 |-- THANKS - thanks to people that help to improve vifm
156 `-- TODO - what still needs to be implemented
File deploy changed (mode: 100755) (index 3b6c4328c..9c9c8ab0b)
... ... if [ "x$target" == "xall" -o "x$target" == "xupdate" ]; then
51 51 cp "$vimdoc" "${vimdoc}_tmp" cp "$vimdoc" "${vimdoc}_tmp"
52 52 sed "1s/version \\S\\+/version $1/" "${vimdoc}_tmp" > "$vimdoc" sed "1s/version \\S\\+/version $1/" "${vimdoc}_tmp" > "$vimdoc"
53 53 rm "${vimdoc}_tmp" rm "${vimdoc}_tmp"
54
55 # update version in README
56 cp README README_tmp
57 sed "5s/ .*/ $1/" README_tmp > README
58 rm README_tmp
54 59 fi fi
55 60
56 61 if [ "x$target" == "xall" -o "x$target" == "xcommit" ]; then if [ "x$target" == "xall" -o "x$target" == "xcommit" ]; then
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