Contributing to This Wiki

From Vifm Wiki
Jump to: navigation, search

A place to map out and plan the topics found in the wiki.

Manual Outline

Ideology

Quickstart Tutorial

Starting vifm

  1. From some kind of menu (e.g. KDEMenu).
  2. From command-line
    • Where it starts (previous directories/current directory/any other directory)
    • Start by specifying name of a file rather than directory name
      • Specify path to fuse mount and path inside of it
  3. From any buffer in Vim
    • Replace file in current buffer
    • Edit in tab
    • Edit in horizontal split
    • Edit in vertical split
    • Diff with file
  4. From mail buffer in Vim to add an attachment

Configuration model

Quiting Vifm

Modes general

  1. What modes and submodes exist.
  2. Transitions between modes and submodes.

Navigation

  1. Navigation within view.
  2. Rearranging views.
  3. Marks.
    • State that marks remember both path to destination directory and a file in it.
  4. Directory stack.

File searching

  1. / and ?
  2. n and N
  3. 'hlsearch', 'incsearch', 'ignorecase', 'smartcase'
  4. Regular expressions

Manual file selection

  1. 'hlsearch' and searching.
  2. t command.
  3. Visual mode.
    • cover all submodes

File auto selection

  1. Motions.
  2. Selectors.

Command-line and alike modes

Command-line commands

  1. General syntax overview.
    •  :[range]command arg1 'arg2' "arg3" /arg4/
    • Comments.
    • Several commands separated by a bar ("|").
  2.  :!! command.
  3. Ranges.
  4. Macros.
  5. User-defined commands.
    • External commands.
    • Local commands (":do something").
    • Background commands.
  6. Commands that accept expressions.
  7. Backgrounding commands.
  8. Cancelling commands.

Controlling view

  1. Permanent file filtering.
  2. Real-time file filtering.

Mappings

  1. With remapping (:map).
  2. Without remapping (:noremap).
  3. Angle-bracket notation.
  4. Displaying existing mappings.

Trash directories

  1. Overview, state incompatibility with Trash specification of FreeDesktop.
  2. Location ('trashdir' option).
  3. Related command-line commands (":lstrash", ":trashes").
  4. Related normal mode commands (p, P, d, D).

Previewing files

  1. Exploring.
  2. Previewing.

Color schemes

Running files

Combining with external scripts

Writing scripts in vifmrc file

Index of Features

list all capabilities including synonyms of features to make things easier to search. These should link to pages talking about the feature in detail. Brainstorming how the index should look:

I think full syntax should be given in the command coloumn, with the command itself linking to a section that described all the fine details of the command in full

keywords will make actual ideas or concept easy to lookup ps. It took me making this table that yank was a feature different than copy......

Feature Description Command(s) Default Mapping(s) see also keywords
copy copy to opposite pane  :[range]co[py][!?][&] cp, yank, move
delete delete file and add to default(") register*  :delete d rm, cut
Page up navigate up one page PageUp, Ctrl-B
view view current file in the opposite pane  :vie[w][!] preview, less
yank add file to the default(") register  :[range]y[ank] [reg] [count] y copy cp

Other Pages

Users coming from mc

Differences from vim

Wiki Style Guidelines

  • Vifm vs vifm
  • filemanager not Filebrowser
  • style for represnting code in a file (might want to snag the template used at arch wiki)
  • commandline/shell/CLI/TUI
  • categories

Table to Compare Modes