LinuxCommandLibrary

vinmap

Display Vim/Neovim's key mappings

TLDR

Perform a basic scan of a subnet

$ vinmap [[-ip|--ip_range]] [192.168.1.0/24]
copy

Scan a domain with version and OS detection, saving results to a specific file
$ vinmap [[-ip|--ip_range]] [example.com] [[-s|--scan_type]] "-sV -O" -o [path/to/scan_results.xml]
copy

Scan an IP range using 10 chunks and 20 concurrent threads, uses half of the system's CPU cores if not specified
$ vinmap [[-ip|--ip_range]] [10.0.0.1-10.0.0.255] [[-n|--num_chunks]] 10 [[-t|--threads]] 20
copy

Output scan results in JSON format
$ vinmap [[-ip|--ip_range]] [192.168.1.1-192.168.1.100] [[-f|--format]] json
copy

Scan multiple IPs with default settings and save merged XML output
$ vinmap [[-ip|--ip_range]] [192.168.1.1,192.168.1.2,...]
copy

SYNOPSIS

vinmap [man page name]

DESCRIPTION

vinmap is a utility that parses man pages and displays Vim-like keybindings to navigate them.
It enhances the standard man page experience by providing familiar keybindings from the Vim text editor for scrolling, searching, and other navigation tasks. This is particularly useful for Vim users who prefer to use the 'man' command for documentation but want a more intuitive navigation experience. vinmap essentially acts as a wrapper around the 'man' command, intercepting the output and re-formatting it to incorporate these keybindings.
It leverages the roff format used by man pages to identify text elements and then present equivalent Vim commands alongside. This avoids the need to learn new hotkeys to use man, because a vim user will use hotkeys that he knows already.

CAVEATS

vinmap relies on correctly formatted man pages and may not work perfectly with all man pages. Some customization or specific keybinding configurations might be required depending on your environment.

HISTORY

vinmap was developed to bridge the gap between the command-line documentation tool 'man' and the popular text editor 'Vim'. Its development was motivated by the desire to improve the user experience for Vim users consulting man pages, as it eliminates the need to switch between different sets of keybindings.
It has become a popular tool for those seeking a more seamless documentation experience within the terminal.

SEE ALSO

man(1), vim(1)

Copied to clipboard