README
1xrectdraw
2=========
3A small program used to draw rectangles on X11. The idea came when I needed
4something to indicate screen recordings for a small script using ffmpeg. I used
5xrectsel for selecting the region for ffmpeg to capture, so I kinda got the
6inspiration from there.
7
8xrectdraw actually draws four windows making up the borders of the rectangle.
9This means no compositor is needed, the root window isn't hogged and the region
10is not overlaied.
11
12Installation
13------------
14Edit config.mk to match your local setup (xrectdraw is installed into the
15/usr/local namespace by default), then simply enter the following command to
16install (if necessary as root):
17
18 make clean install
19
20Customization
21-------------
22xrectdraw can be customized by creating a custom config.h and (re)compiling the
23source code.
24
25Usage
26-----
27Together with the source code is a script called *screenrec.sh* which is a fine
28example of how xrectdraw can be used. The program is used like this:
29
30 xrectdraw 10 20 100 200 \#ff0000 3:2:3:2
31
32The example above draws a rectangle, 100px wide, 200px heigh at the position
33(x:10px, y:20px). The borders are red, the top and bottom are 3px wide and the
34right and left are 2pc wide.
35
36License
37-------
38The project is licensed under the MIT license.
