<!-- vim: set filetype=markdown: -->

• Meta command
• Wheel status
• Straight navigation
  • History
• Prompt
• Read and write
  • Load wheel from file
  • Save wheel in file
  • Load session from file
  • Save session in file
• Dedicated buffers
• Batch
• Autogroup
• Dics operation
• Wheel tree in disc

The main command is :

:Wheel {subcommand}

This is a meta command that accepts a serie of sub-commands, described in the following sections. Completion of sub-commands and subsequent is available.

There is a slight difference with the usual completion however : if you want to filter with multi-patterns, separate them with a comma instead of a space, e.g. :

:Wheel pr,t<tab> -> :Wheel prompt
:Wheel c,y<tab> -> :Wheel copy

Hitting tab after a space yields all the candidates.

Some subcommands demand a third word :

:Wheel subcommand {action or file ...}

In the help submenu of the main or meta menu, you have access to the list of available subcommands and actions for :Wheel.

:Wheel info

Print information of the current wheel status in the format :

torus > circle > location : file:line:col

:Wheel jump

Jump to current wheel location

:Wheel follow

Find closest location in wheel matching current file & cursor

:Wheel next-location
	Go to next location

:Wheel previous-location
	Go to previous location

:Wheel next-circle
	Go to next circle

:Wheel previous-circle
	Go to previous circle

:Wheel next-torus
	Go to next torus

:Wheel previous-torus
	Go to previous torus

:Wheel newer
	Go to newer location in history

:Wheel older
	Go to older location in history

:Wheel newer-in-circle
	Go to newer location in same circle

:Wheel older-in-circle
	Go to older location in same circle

:Wheel newer-in-torus
	Go to newer location in same torus

:Wheel older-in-torus
	Go to older location in same torus

:Wheel prompt {action}

Launch prompting function given by action. Examples :

:Wheel prompt location
:Wheel prompt history

:Wheel prompt read-wheel

The plugin will ask you the file name.

• File completion in g:wheel_config.storage.wheel.folder is available.
• Leaving empty choose the [file] under brackets.
• Inserting the special value = choose g:wheel_config.storage.wheel.name.

:Wheel prompt write-wheel

The plugin will ask you the file name.

• File completion in g:wheel_config.storage.wheel.folder is available.
• Leaving empty choose the [file] under brackets.
• Inserting the special value = choose g:wheel_config.storage.wheel.name.

:Wheel prompt read-session

The plugin will ask you the file name.

• File completion in g:wheel_config.storage.wheel.folder is available.
• Leaving empty choose the [file] under brackets.
• Inserting the special value = choose g:wheel_config.storage.session.name.

:Wheel prompt write-session

The plugin will ask you the file name.

• File completion in g:wheel_config.storage.wheel.folder is available.
• Leaving empty choose the [file] under brackets.
• Inserting the special value = choose g:wheel_config.storage.session.name.

:Wheel dedibuf {action}

Launch dedicated buffer function given by action. Examples :

:Wheel dedibuf index-location
:Wheel dedibuf frecency

:Wheel batch {my_command}

Use the argument list to execute {my_command} on each location of the current circle. The command can be a vim :command or an external shell !command. The ouput is displayed in a dedicated buffer. Examples :

:Wheel batch !wc %

Uses :argdo under the hood.

:Wheel autogroup

Autogroup locations of current torus using filename extensions or directories. Creates a new torus where each group will occupy a circle.

:Wheel mkdir {dirname}

Create recursively a directory if non existent

:Wheel rename {source} {dest}

Rename a file

:Wheel copy {source} {dest}

Copy a file

:Wheel delete {filename}

Delete a file

:Wheel tree-script

Write a shell script that generates a tree of links or copies following the wheel hierarchy : torus/circle/location. Unix systems only. The generated script is a lot faster than :WheelSymlinkTree or :WheelCopiedTree.

:Wheel symlink-tree

Generate a tree of symlinks following the wheel hierarchy : torus/circle/link-to-location-file. Unix systems only.

:Wheel copied-tree

Generate a tree of copies following the wheel hierarchy : torus/circle/link-to-location-file. Unix systems only. Useful to make a backup of the wheel files.