aboutsummaryrefslogtreecommitdiffstats
path: root/_urxvt/ext/README.md
diff options
context:
space:
mode:
Diffstat (limited to '_urxvt/ext/README.md')
-rw-r--r--_urxvt/ext/README.md107
1 files changed, 107 insertions, 0 deletions
diff --git a/_urxvt/ext/README.md b/_urxvt/ext/README.md
new file mode 100644
index 0000000..b800ed3
--- /dev/null
+++ b/_urxvt/ext/README.md
@@ -0,0 +1,107 @@
+A small collection of perl extensions for the rxvt-unicode terminal emulator.
+
+Installation
+------------
+Simply place the scripts you want to install in /usr/lib/urxvt/perl/ for
+system-wide availability or in ~/.urxvt/ext/ for user-only availability.
+You can also put them in a folder of your choice, but then you have to add this
+line to your .Xdefaults/.Xresources:
+
+ URxvt.perl-lib: /your/folder/
+
+See the following sections for information on how to enable the scripts or set
+script-specific options and keyboard mappings in your .Xdefaults/.Xresources.
+
+
+keyboard-select
+---------------
+Use keyboard shortcuts to select and copy text.
+
+After installing, put the following lines in your .Xdefaults/.Xresources:
+
+ URxvt.perl-ext-common: ...,keyboard-select
+ URxvt.keysym.M-Escape: perl:keyboard-select:activate
+
+The following line overwrites the default Meta-s binding and allows to activate
+keyboard-select directly in backward search mode:
+
+ URxvt.keysym.M-s: perl:keyboard-select:search
+
+Use Meta-Escape to activate selection mode, then use the following keys:
+
+ h/j/k/l: Move cursor left/down/up/right (also with arrow keys)
+ g/G/0/^/$/H/M/L/f/F/;/,/w/W/b/B/e/E: More vi-like cursor movement keys
+ '/'/?: Start forward/backward search
+ n/N: Repeat last search, N: in reverse direction
+ Ctrl-f/b: Scroll down/up one screen
+ Ctrl-d/u: Scroll down/up half a screen
+ v/V/Ctrl-v: Toggle normal/linewise/blockwise selection
+ y/Return: Copy selection to primary buffer, Return: deactivate afterwards
+ q/Escape: Deactivate keyboard selection mode
+
+
+url-select
+----------
+Use keyboard shortcuts to select URLs.
+
+This should be used as a replacement for the default matcher extension, it also
+makes URLs clickable with the middle mouse button.
+
+After installing, put the following lines in your .Xdefaults/.Xresources:
+
+ URxvt.perl-ext-common: ...,url-select
+ URxvt.keysym.M-u: perl:url-select:select_next
+
+Use Meta-u to activate URL selection mode, then use the following keys:
+
+ j/k: Select next downward/upward URL (also with arrow keys)
+ g/G: Select first/last URL (also with home/end key)
+ o/Return: Open selected URL in browser, Return: deactivate afterwards
+ y: Copy (yank) selected URL and deactivate selection mode
+ q/Escape: Deactivate URL selection mode
+
+Options:
+
+ URxvt.url-select.autocopy: if set to true, selected URLs are automatically
+ copied to the PRIMARY buffer
+ URxvt.url-select.button: mouse button to click-open URLs (default: 2)
+ URxvt.url-select.launcher: browser/command to open selected URL with
+ URxvt.url-select.underline: if set to true, all URLs get underlined
+
+For compatibility reasons, url-select will also use any patterns defined for
+the matcher extension by reading all `URxvt.matcher.pattern.[0-9]` resources.
+
+
+clipboard
+---------
+Use keyboard shortcuts to copy the selection to the clipboard and to paste the
+clipboard contents (optionally escaping all special characters).
+
+After installing, put the following lines in your .Xdefaults/.Xresources:
+
+ URxvt.perl-ext-common: ...,clipboard
+ URxvt.keysym.M-c: perl:clipboard:copy
+ URxvt.keysym.M-v: perl:clipboard:paste
+ URxvt.keysym.M-C-v: perl:clipboard:paste_escaped
+
+Options:
+ URxvt.clipboard.autocopy: if set to true, the clipboard is automatically
+ updated whenever the PRIMARY selection changes
+
+You can also overwrite the system commands to use for copying/pasting.
+The default ones are:
+
+ URxvt.clipboard.copycmd: xsel -ib
+ URxvt.clipboard.pastecmd: xsel -ob
+
+If you prefer xclip, then put these lines in your .Xdefaults/.Xresources:
+
+ URxvt.clipboard.copycmd: xclip -i -selection clipboard
+ URxvt.clipboard.pastecmd: xclip -o -selection clipboard
+
+On Mac OS X, put these lines in your .Xdefaults/.Xresources:
+
+ URxvt.clipboard.copycmd: pbcopy
+ URxvt.clipboard.pastecmd: pbpaste
+
+The use of the functions should be self-explanatory!