aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 33d46a29831aa5c6ec6305023e6096bc812dc37d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Xwinwrap

Fork of xwinwrap.
Xwinwrap allows you to embed any other X11 window into the root X11 window; now on OpenBSD.

### Installing

```
git clone https://github.com/ProsperousPotato/xwinwrap
cd xwinwrap
make
doas make install
make clean
```

### Uninstalling 

```
cd /path/to/xwinwrap
doas make uninstall
cd ..
rm -rf xwinwrap
```

### Usage

```
Usage: 
    xwinwrap [OPTIONS...] -- <video-player> [VIDEO-PLAYER OPTIONS...] <video-file>
 
Options:
             -g {w}x{h}+{x}+{y}    
                     - Specify Geometry (w=width, h=height, x=x-coord,
                       y=y-coord. ex: -g 640x480+100+100)
             -ni     - Ignore Input
             -argb   - RGB
             -fdt    - Force WID window a desktop type window
             -fs     - Full Screen
             -un     - Undecorated
             -s      - Sticky
             -st     - Skip Taskbar
             -sp     - Skip Pager
             -a      - Above
             -b      - Below
             -nf     - No Focus
             -o      - Opacity value between 0 to 1 (ex: -o 0.20)
             -sh     - Shape of window (choose between rectangle, circle or
                       triangle. Default is rectangle)
             -ov     - Set override_redirect flag (For seamless desktop
                       background integration in non-fullscreenmode) (can cause
                       artifacts on some environments)
             -ovr    - Set override_redirect flag on root window (For seamless
                       desktop background integration in fullscreenmode)
             -d      - Daemonize
             -debug  - Enable debug messages
```

### Example

#### Have neofetch as a wallpaper
`xwinwrap -ov -fs -- xterm -hold -geometry 1920x1080 -bg black -fg white +sb -into WID -e neofetch`

`nice xwinwrap -b -s -fs -st -sp -nf -ov -fdt -- mpv -wid WID --really-quiet --framedrop=vo --no-audio --panscan="1.0" /path/to/your/video`

### Changes

* Added ability to make undecorated window
* Changed how desktop window is found
* Refactored window hints
* Add DESKTOP window type flag

* Compiles out-of-the-box on OpenBSD

----
Original source - https://launchpad.net/xwinwrap

----
Forked from - https://github.com/mmhobi7/xwinwrap