| travis-ci | appveyor | fragile-ci | coveralls | uncov |
|------------|------------|------------|------------|------------|
|[![][TT]][T]|[![][AA]][A]|[![][FF]][F]|[![][CC]][C]|[![][UU]][U]|
### **vifm** - vi[m] like file manager, _v0.11-beta_, _2001 – 2020_
_This file last updated on 10 September, 2020_
## Brief Description ##
**Vifm** is a curses based vi[m] like file manager extended with some useful
ideas from mutt. If you use vi[m], 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[m], vifm tries to adhere to the Unix philosophy. So instead of
working solutions which are set in stone user is provided with a set of
means for customization of vifm to one's likings. Though builtin
functionality should be enough for most of use cases.
## Resources and Contacts ##
| Usage | Link |
| :-------: | :----: |
| Website | https://vifm.info/ |
| Wiki | https://wiki.vifm.info/ |
| Q & A | https://q2a.vifm.info/ |
### Communication ###
| Reason | Source |
| :-------: | :------: |
| Bugs & Feature Requests | [GitHub][bugs-gh], [SourceForge][bugs-sf] or via [email][email] |
| Preferred place for asking usage questions | Posting on the [Q&A][q2a] site |
| Read-only and very low traffic news mailing list | [vifm-announce][list] |
### Other resources ###
| Usage | Where to find |
| :---: | :---: |
| Repositories | [GitHub][repo-gh] and [SourceForge][repo-sf] |
| Plugin | [Repository][vim-plugin] |
| Colorschemes (maintained) | [Repository][colors] and [colorscheme-previews][colorscheme-preview] |
| Devicons/favicons | [[1]][devicons-1], [[2]][devicons-2] |
| vifmimg (image preview) | [Repository][vifmimg] (using [überzug][ueberzug] to display the images), also see [PR][vifmimg-pr] |
## Screenshot ##
## Getting Started ##
A good idea for quick start might be skimming over [cheatsheet][cheatsheet] for
the main mode (that is Normal mode) and reading some sections on basic usage on
[the wiki][wiki-manual].
## License ##
GNU General Public License, version 2 or later.
[q2a]: https://q2a.vifm.info/
[email]: mailto:xaizek@posteo.net
[list]: https://lists.sourceforge.net/lists/listinfo/vifm-announce
[vim-plugin]: https://github.com/vifm/vifm.vim
[colors]: https://github.com/vifm/vifm-colors
[colorscheme-preview]: https://vifm.info/colorschemes.shtml
[devicons-1]: https://github.com/cirala/vifm_devicons
[devicons-2]: https://github.com/yanzhang0219/dotfiles/tree/master/.config/vifm
[vifmimg]: https://github.com/cirala/vifmimg
[vifmimg-pr]: https://github.com/cirala/vifmimg/pull/17
[ueberzug]: https://github.com/seebye/ueberzug
[bugs-gh]: https://github.com/vifm/vifm/issues
[bugs-sf]: https://sourceforge.net/p/vifm/_list/tickets
[repo-gh]: https://github.com/vifm/vifm
[repo-sf]: https://sourceforge.net/projects/vifm/
[cheatsheet]: https://vifm.info/cheatsheets.shtml
[wiki-manual]: https://wiki.vifm.info/index.php?title=Manual
[TT]: https://travis-ci.org/vifm/vifm.svg?branch=master
[T]: https://travis-ci.org/vifm/vifm
[AA]: https://ci.appveyor.com/api/projects/status/ywfhdev1l3so1f5e/branch/master?svg=true
[A]: https://ci.appveyor.com/project/xaizek/vifm/branch/master
[CC]: https://coveralls.io/repos/github/vifm/vifm/badge.svg?branch=master
[C]: https://coveralls.io/github/vifm/vifm?branch=master
[FF]: http://ci.vifm.info/badges/svg/master
[F]: http://ci.vifm.info/
[UU]: http://cov.vifm.info/badges/svg/master
[U]: http://cov.vifm.info/branches/master
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