https://github.com/mcaimi/tmux-rtfm

Open man pages in tmux
https://github.com/mcaimi/tmux-rtfm

Last synced: 3 months ago
JSON representation

Open man pages in tmux

• Host: GitHub
• URL: https://github.com/mcaimi/tmux-rtfm
• Owner: mcaimi
• License: gpl-3.0
• Created: 2017-04-13T15:20:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-13T15:28:19.000Z (over 9 years ago)
• Last Synced: 2025-03-06T10:22:03.447Z (over 1 year ago)
• Language: Shell
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# **tmux-rtfm** #

Quickly open the man page of a command in a split or in the current window.

The commmand must be put in the paste-buffer by using the mouse to get a selection.

the plugin works by:

 

 1. saving the command name (the paste buffer content) into a temporary swap file then opening the "man" command with the contents of this file as input.   

 2. launching the "man" command with the content of the system clipboard as input (shift+mouse selection, xclip needed)

## Configuration ##

At the moment only three tunables are implemented:

    # swap file name

    set -g @rtfm_temp_file_name '/tmp/tmuxRTFM'

    # open man page in current window or in a split

    set -g @rtfm_open_in_split 'yes'

    # set mode: swap or xclip.

    # 'swap' uses a swapfile in /tmp to keep track of the last command

    # 'xclip' uses the system clipboard to store the command (shift+mouse selection)

    set -g @rtfm_clip_mpde 'xclip'

to install the plugin, use tmux-plugins/tpm:

    set -g @plugins 'mcaimi/tmux-rtfm'