README.md
1A small collection of perl extensions for the rxvt-unicode terminal emulator.
2
3Installation
4------------
5Simply place the scripts you want to install in the /usr/lib/urxvt/perl/ folder
6for system-wide availability. You can also put them in a folder of your
7choice, but then you have to add this line to your .Xdefaults/.Xresources:
8
9 URxvt.perl-lib: /your/folder/
10
11See the following sections for information on how to enable the scripts or set
12script-specific options and keyboard mappings in your .Xdefaults/.Xresources.
13
14
15keyboard-select
16---------------
17Use keyboard shortcuts to select and copy text.
18
19After installing, put the following lines in your .Xdefaults/.Xresources:
20
21 URxvt.perl-ext-common: ...,keyboard-select
22 URxvt.keysym.M-Escape: perl:keyboard-select:activate
23
24The following line overwrites the default Meta-s binding and allows to activate
25keyboard-select directly in backward search mode:
26
27 URxvt.keysym.M-s: perl:keyboard-select:search
28
29Use Meta-Escape to activate selection mode, then use the following keys:
30
31 h/j/k/l: Move cursor left/down/up/right (also with arrow keys)
32 g/G/0/^/$/H/M/L/f/F/;/,/w/W/b/B/e/E: More vi-like cursor movement keys
33 '/'/?: Start forward/backward search
34 n/N: Repeat last search, N: in reverse direction
35 Ctrl-f/b: Scroll down/up one screen
36 Ctrl-d/u: Scroll down/up half a screen
37 v/V/Ctrl-v: Toggle normal/linewise/blockwise selection
38 y/Return: Copy selection to primary buffer, Return: deactivate afterwards
39 q/Escape: Deactivate keyboard selection mode
40
41
42url-select
43----------
44Use keyboard shortcuts to select URLs.
45
46This should be used as a replacement for the default matcher extension, it also
47makes URLs clickable with the middle mouse button.
48
49After installing, put the following lines in your .Xdefaults/.Xresources:
50
51 URxvt.perl-ext-common: ...,url-select
52 URxvt.keysym.M-u: perl:url-select:select_next
53
54Use Meta-u to activate URL selection mode, then use the following keys:
55
56 j/k: Select next downward/upward URL (also with arrow keys)
57 g/G: Select first/last URL (also with home/end key)
58 o/Return: Open selected URL in browser, Return: deactivate afterwards
59 y: Copy (yank) selected URL and deactivate selection mode
60 q/Escape: Deactivate URL selection mode
61
62Options:
63
64 URxvt.url-select.autocopy: if set to true, selected URLs are automatically
65 copied to the PRIMARY buffer
66 URvxt.url-select.button: mouse button to click-open URLs (default: 2)
67 URxvt.url-select.launcher: browser/command to open selected URL with
68 URxvt.url-select.underline: if set to true, all URLs get underlined
69
70For compatibility reasons, url-select will also use any patterns defined for
71the matcher extension by reading all `URxvt.matcher.pattern.[0-9]` resources.
72
73
74clipboard
75---------
76Use keyboard shortcuts to copy the selection to the clipboard and to paste the
77clipboard contents (optionally escaping all special characters).
78
79After installing, put the following lines in your .Xdefaults/.Xresources:
80
81 URxvt.perl-ext-common: ...,clipboard
82 URxvt.keysym.M-c: perl:clipboard:copy
83 URxvt.keysym.M-v: perl:clipboard:paste
84 URxvt.keysym.M-C-v: perl:clipboard:paste_escaped
85
86You can also overwrite the system commands to use for copying/pasting.
87The default ones are:
88
89 URxvt.clipboard.copycmd: xsel -ib
90 URxvt.clipboard.pastecmd: xsel -ob
91
92If you prefer xclip, then put these lines in your .Xdefaults/.Xresources:
93
94 URxvt.clipboard.copycmd: xclip -i -selection clipboard
95 URxvt.clipboard.pastecmd: xclip -o -selection clipboard
96
97On Mac OS X, put these lines in your .Xdefaults/.Xresources:
98
99 URxvt.clipboard.copycmd: pbcopy
100 URxvt.clipboard.pastecmd: pbpaste
101
102The use of the functions should be self-explanatory!
103