Difference between revisions of "Contributing to This Wiki"
(→Quiting vifm: Change the last item) |
(→Wiki Style Guidelines: Add categories to the list) |
||
Line 192: | Line 192: | ||
*style for represnting code in a file (might want to snag the template used at [https://wiki.archlinux.org/index.php/Vim#Installation arch wiki]) | *style for represnting code in a file (might want to snag the template used at [https://wiki.archlinux.org/index.php/Vim#Installation arch wiki]) | ||
*commandline/shell/CLI/TUI | *commandline/shell/CLI/TUI | ||
+ | *categories | ||
===Table to Compare Modes=== | ===Table to Compare Modes=== |
Revision as of 20:39, 17 August 2014
A place to map out and plan the topics found in the wiki.
Manual Outline
Ideology
Quickstart Tutorial
This should cover all of the most basic Tasks I'll keep updating this with my biggest bumps in the learning curve as well.
This first part should give just enough information to allow the new user to navigate through the tree to any file/dir, open the file, and pass commands to the shell.
- The Bare Essentials
- Launching Vifm
- run vifm from a Terminal. See Starting Vifm
- quitting
- Navigate
- j,k
- [space]
- h,l --> on a directory. Explain how to quit vim/vi if they hit 'l' on an file.
- Open a File
- If a launcher is already defined by default and installed [Enter] -- i think
- if run an unknown filetype without Defining a Filetype Association, you must use the commandline.
- if the program runs within the terminal as text only, such as ls, type without the quotes, ':!!ls -al %c' and then press [Enter]. Explain that that is a commandline mode command and what each part of it does. link to a list of available command line commands.
- if you would like to continue using Vifm while the program runs, which is most likely the case if it runs in its own window, run the task in the background using '&'. For example, if you wanted to launch the terminal emulator xterm in the current directory use '!xterm &'. If xterm didn't work try gnome-terminal, urxvt, konsol, etc. Did you noticed that you didn't need to specify the current directory? This is because Vifm launches '!' commands in the current directory.
- Press the [Enter] key (carriage return) to edit a file (or open a folder). (Change
set norunexec
toset runexec
in~/.vifm/vifmrc
to run executable files rather then open them for editing.) (Not sure if this this bullet should be included in the very basic tutorial???)
- by now you should be able to do anything from with Vifm, if just might not be much fast then just using the command line.
- Launching Vifm
- Do Common Tasks Faster
- cd
- yank
- paste/put
- delete
- ....I really haven't figured out much more than this...yet!!
Starting vifm
- From some kind of menu (e.g. KDEMenu).
- 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
- From any buffer in Vim
- Replace file in current buffer
- Edit in tab
- Edit in horizontal split
- Edit in vertical split
- Diff with file
- From mail buffer in Vim to add an attachment
Configuration model
Quiting Vifm
- Saving/not saving runtime state.
- Controlling whether current directories are remembered.
- Quitting Vifm started in file picker mode (from Vim plugin).
Modes general
- What modes and submodes exist.
- Transitions between modes and submodes.
- Navigation within view.
- Rearranging views.
- Marks.
- State that marks remember both path to destination directory and a file in it.
- Directory stack.
File searching
- / and ?
- n and N
- 'hlsearch', 'incsearch', 'ignorecase', 'smartcase'
- Regular expressions
Manual file selection
- 'hlsearch' and searching.
- t command.
- Visual mode.
- cover all submodes
File auto selection
- Motions.
- Selectors.
Command-line and alike modes
Command-line commands
- General syntax overview.
- :[range]command arg1 'arg2' "arg3" /arg4/
- Comments.
- Several commands separated by a bar ("|").
- :!! command.
- Ranges.
- Macros.
- User-defined commands.
- External commands.
- Local commands (":do something").
- Background commands.
- Commands that accept expressions.
- Backgrounding commands.
- Cancelling commands.
Controlling view
- Permanent file filtering.
- Real-time file filtering.
Mappings
- With remapping (:map).
- Without remapping (:noremap).
- Angle-bracket notation.
- Displaying existing mappings.
Trash directories
- Overview, state incompatibility with Trash specification of FreeDesktop.
- Location ('trashdir' option).
- Related command-line commands (":lstrash", ":trashes").
- Related normal mode commands (p, P, d, D).
Previewing files
- Exploring.
- 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