README

Vifm - vi[m] like file manager
2001 - 2013

Updated: 10 May, 2013
Version: 0.7.5

Brief Description

    Vifm is a two panel ncurses based vi[m] like file manager. If you use vi,
    vifm gives you complete keyboard control over your files without having
    to learn a new set of commands. It goes not just about vi[m] like
    keybindings, but also about modes, options, registers, commands and other
    things you might already like in vi[m].

    Just like vi vifm tries to adhere to the Unix philosophy. So instead of
    working solutions user is provided with a set of means for customization
    of vifm. Though builtin functionality should be enough for most of use
    cases.

Contacts

    Website: http://vifm.sourceforge.net/
    Read-only news mailing list: vifm-announce@lists.sourceforge.net
    Email for bugs, suggestions and comments on vifm: xaizek@lavabit.com

    Subscribe to the mailing list at:
    https://lists.sourceforge.net/lists/listinfo/vifm-announce

    Repositories:
    SorceForge: http://sourceforge.net/projects/vifm/
    GitHub: https://github.com/ksteen/vifm (preferred)
    GitHub: https://github.com/xaizek/vifm (might be removed in the future)

Package content

    .
    |
    |-- data/ - documentation, sample vifmrc, icons
    |  |
    |  |-- colors/ - sample color schemes
    |  `-- vim/ - plugin for Vim
    |
    |-- pkgs/ - package build-scripts
    |
    |-- src/ - the source code of vifm
    |  |
    |  |-- cfg/ - code related to configuration
    |  |  |
    |  |  |-- config.c - reads scripts and manages configuration
    |  |  `-- info.c - read and write vifminfo
    |  |
    |  |-- engine/ - the core of vi[m]-like functionality
    |  |  |
    |  |  |-- cmds.c - command line parsing core
    |  |  |-- completion.c - provides means to fill and get completion list
    |  |  |-- functions.c - provides support for builtin functions
    |  |  |-- keys.c - analyzes users input
    |  |  |-- options.c - :set command
    |  |  |-- parsing.c - parses expressions
    |  |  |-- var.c - all needed to work with variables
    |  |  `-- variables.c - handles :let and :unlet commands
    |  |
    |  |-- menus/ - implementation of all menus
    |  |  |
    |  |  |-- apropos_menu.c - handles :apropos menu
    |  |  |-- bookmarks_menu.c - handles :marks menu
    |  |  |-- colorscheme_menu.c - handles :colorscheme menu
    |  |  |-- commands_menu.c - handles :command menu
    |  |  |-- dirhistory_menu.c - handles :history menu
    |  |  |-- dirstask_menu.c - handles :dirs menu
    |  |  |-- filetypes_menu.c - handles :file menu
    |  |  |-- find_menu.c - handles :file menu
    |  |  |-- grep_menu.c - hanldes :grep menu
    |  |  |-- history_menu.c - handles :history command menus except directory
    |  |  |                    history
    |  |  |-- jobs_menu.c - handles :jobs menu
    |  |  |-- locate_menu.c - handles :locale menu
    |  |  |-- map_menu.c - handles :map menu
    |  |  |-- menus.c - handles all kinds of menus
    |  |  |-- registers_menu.c - handles :registers menu
    |  |  |-- undolist_menu.c - handles :undolist menu
    |  |  |-- users_menu.c - handles menus created by %m or %M macros
    |  |  |-- vifm_menu.c - handles :vifm (or :version) menu
    |  |  `-- volumes_menu.c - handles :volumes menu on MS Windows systems
    |  |
    |  |-- modes/ - implementation of all modes
    |  |  |
    |  |  |-- dialogs/ - dialog modes
    |  |  |  |
    |  |  |  |-- attr_dialog_nix.c - file permissions dialog for *nix systems
    |  |  |  |-- attr_dialog_win.c - file properties dialog for MS Windows
    |  |  |  |                       systems
    |  |  |  |-- change_dialog.c - change dialog
    |  |  |  `-- sort_dialog.c - dialog to choose sort type
    |  |  |
    |  |  |-- cmdline.c - command line mode
    |  |  |-- file_info.c - Control+G
    |  |  |-- menu.c - handles commands in menus
    |  |  |-- modes.c - general code (e.g. before and after key pressed) for
    |  |  |             modes
    |  |  |-- normal.c - normal mode commands
    |  |  |-- view.c - view mode commands
    |  |  `-- visual.c - implementation of visual mode commands
    |  |
    |  |-- utils/ - miscellaneous utility functions
    |  |  |
    |  |  |-- env.c - environment variables related functions
    |  |  |-- fs.c - functions to deal with file system objects
    |  |  |-- file_streams.c - file stream reading related functions
    |  |  |-- int_stack.c - int stack "object"
    |  |  |-- log.c - primitive logging
    |  |  |-- mntent.c - compatibility file for FreeBSD-like systems
    |  |  |-- path.c - various functions to work with paths
    |  |  |-- str.c - various string functions
    |  |  |-- string_array.c - functions to work with arrays of strings
    |  |  |-- tree.c - cache for ga command results
    |  |  |-- utf8.c - functions to handle utf8 strings
    |  |  `-- utils.c - various utilities
    |  |
    |  |-- background.c - runs commands in background
    |  |-- bookmarks.c - stores information about bookmarked directories
    |  |-- bracket_notation.c - list of bracket notation entries
    |  |-- color_manager.c - manager of curses color pairs
    |  |-- color_scheme.c - color schemes
    |  |-- column_view.c - column formatting unit
    |  |-- commands.c - handles command line commands
    |  |-- commands_completion.c - handles command line completion
    |  |-- desktop.c - code that parses *.desktop files on *nix systems
    |  |-- escape.c - escape sequences related stuff
    |  |-- dir_stack.c - for :pushd and :popd commands
    |  |-- file_magic.c - determines programs associated with file using its
    |  |                  mime-type
    |  |-- filelist.c - display/redraw/fill list
    |  |-- filename_modifiers.c - expands filename modifiers
    |  |-- fileops.c - delete/copy/put selected file(s)
    |  |-- filetype.c - stores filetype information from vifmrc
    |  |-- fuse.c - provides support of FUSE filesystems
    |  |-- globals.c - provides support of globals
    |  |-- ipc.c - handles communication across instances of vifm
    |  |-- macros - code of macros expanding
    |  |-- main_loop.c - the main loop
    |  |-- ops.c - most of operations performed on file system
    |  |-- opt_handlers.c - initialization of options and option change handlers
    |  |-- quickview.c - implementation of quick view
    |  |-- registers.c - implementation of registers
    |  |-- running.c - code of handing file and commands running
    |  |-- path_env.c - parses and modifies PATH environment variables
    |  |-- search.c - code for / and ? commands of normal mode
    |  |-- signals.c - handlers for different signals
    |  |-- sort.c - sort function
    |  |-- status.c - definition of global status structure
    |  |-- tags.c - tags for :h completion
    |  |-- term_title.c - implementation of support of terminal title changing
    |  |-- trash.c - code that handles list of files in trash
    |  |-- types.c - internal file type detection and conversions
    |  |-- ui.c - setup_ncurses_interface() and other ui related functions
    |  |-- undo.c - stores and handles the undo list
    |  |-- version.c - git hash and other version information
    |  |-- viewcolumns_parser.c - contains code for parsing 'viewcolumns' option
    |  |-- vifm.c - contains main() which does basic initialization
    |  |-- vifmrc-converter.c - converter for vifmrc, vifminfo and colorscheme
    |  |                        files
    |  `-- win_helper.c - needed for temporary rights evaluation on Windows
    |
    |-- tests/ - unit tests
    |
    |-- AUTHORS - list of code contributors
    |-- BUGS - some of known issues
    |-- ChangeLog - list of changes
    |-- FAQ - some common questions
    |-- INSTALL - building instructions
    |-- NEWS - like the ChangeLog, but in more human-readable format
    |-- README - this file
    |-- THANKS - thanks to people that help to improve vifm
    `-- TODO - what still needs to be implemented