rename settrans to compton-trans, add manpage.

This commit is contained in:
Christopher Jeffrey 2012-06-23 17:39:49 -05:00
parent f358eb5962
commit 2a566e83a7
3 changed files with 57 additions and 2 deletions

View File

@ -18,13 +18,15 @@ compton: $(OBJS)
install: compton install: compton
@install -Dm755 compton "$(DESTDIR)$(BINDIR)"/compton @install -Dm755 compton "$(DESTDIR)$(BINDIR)"/compton
@install -Dm755 bin/settrans "$(DESTDIR)$(BINDIR)"/settrans @install -Dm755 bin/compton-trans "$(DESTDIR)$(BINDIR)"/compton-trans
@install -Dm644 man/compton.1 "$(DESTDIR)$(MANDIR)"/compton.1 @install -Dm644 man/compton.1 "$(DESTDIR)$(MANDIR)"/compton.1
@install -Dm644 man/compton-trans.1 "$(DESTDIR)$(MANDIR)"/compton-trans.1
uninstall: uninstall:
@rm -f "$(DESTDIR)$(BINDIR)/compton" @rm -f "$(DESTDIR)$(BINDIR)/compton"
@rm -f "$(DESTDIR)$(BINDIR)/settrans" @rm -f "$(DESTDIR)$(BINDIR)/compton-trans"
@rm -f "$(DESTDIR)$(MANDIR)/compton.1" @rm -f "$(DESTDIR)$(MANDIR)/compton.1"
@rm -f "$(DESTDIR)$(MANDIR)/compton-trans.1"
clean: clean:
@rm -f $(OBJS) compton @rm -f $(OBJS) compton

53
man/compton-trans.1 Normal file
View File

@ -0,0 +1,53 @@
.ds q \N'34'
.TH compton\-trans 1
.SH NAME
compton\-trans \- an opacity setter tool
.SH SYNOPSIS
.nf
.B compton-trans [-wncs] [window] -o [opacity]
.fi
.SH DESCRIPTION
.B compton-trans
is a bash script that sets _NET_WM_WINDOW_OPACITY only using standard
command-line utilities for X11, including xprop(1) and xwininfo(1).
It is similar to other utilities like transset(1) or transset-df(1).
.SH OPTIONS
.TP
.BI \-w\ window\-id
Specify the window id to target.
.TP
.BI \-n\ window\-name
Specify and try to match a window name.
.TP
.BI \-c
Specify the current window as a target.
.TP
.BI \-s
Select target window with mouse cursor.
This is the default if no window has been specified.
.TP
.BI \-o\ opacity
Specify the new opacity value for the window. This value
can be anywhere from 1-100. If it is prefixed with a plus
or minus (+/-), this will increment or decrement from the
target window's current opacity instead.
.SH EXAMPLES
.TP
Set window id to opacity of 75%.
compton-trans -w "$WINDOWID" -o 75
.TP
Set window name, "urxvt", to opacity of 75%.
compton-trans -n "urxvt" -o 75
.TP
Set current window to opacity of 75%.
compton-trans -c -o 75
.TP
Select target window and set opacity to 75%.
compton-trans -s -o 75
.TP
Increment current window 5% opacity.
compton-trans -c -o +5
.SH BUGS
Please report any you find to https://github.com/chjj/compton.
.SH AUTHORS
Christopher Jeffrey (https://github.com/chjj)