summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 41d9722815ffd26d0bc9ef9b967d09a98476e049 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
| travis-ci  |  appveyor  | fragile-ci | coveralls  |   uncov    |
|------------|------------|------------|------------|------------|
|[![][TT]][T]|[![][AA]][A]|[![][FF]][F]|[![][CC]][C]|[![][UU]][U]|

### **vifm** - vi[m] like file manager, _v0.10.1-beta_, _2001 – 2019_

_This file last updated on 15 July, 2019_

## 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 ##

**Website:** https://vifm.info/

**Wiki:**    https://wiki.vifm.info/

**Q&A:**     https://q2a.vifm.info/

### Communication ###

Bugs and feature requests can be reported via [GitHub][bugs-github] or
[SourceForge][bugs-sourceforge].

The preferred way of posting usage questions is [Q&A][q2a] site.

Bugs, suggestions and comments can also be communicated via [email][email].

Read-only and very low traffic news mailing list vifm-announce has
subscription form [here][list].

### Other resources ###

Repositories are on [GitHub][repo-github] and [SourceForge][repo-sourceforge].

Plugins are available for [Vim][vim-plugin] and [NeoVim][neovim-plugin].

Collection of color schemes is maintained [here][colors].

## Screenshot ##

![Screenshot](data/graphics/screenshot.png)

## 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
[neovim-plugin]: https://github.com/vifm/neovim-vifm
[colors]: https://github.com/vifm/vifm-colors
[bugs-github]: https://github.com/vifm/vifm/issues
[bugs-sourceforge]: https://sourceforge.net/p/vifm/_list/tickets
[repo-github]: https://github.com/vifm/vifm
[repo-sourceforge]: 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