rename: replace "compton" in the codebase
leftovers: 1) config file path. Has to implement compatibility functionalities before we can change it. 2) links in man pages. Has to migrate the repo first. 3) _COMPTON_SHADOW, it has become a defacto standard, so we have to keep supporting it. 4) dbus names, undecided whether we should/could change it. Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
This commit is contained in:
Yuxuan Shui
@ -1,10 +1,10 @@
|
||||
mans = ['compton.1', 'compton-trans.1']
|
||||
mans = ['picom.1', 'picom-trans.1']
|
||||
if get_option('with_docs')
|
||||
a2x = find_program('a2x')
|
||||
foreach m : mans
|
||||
custom_target(m, output: [m], input: [m+'.asciidoc'],
|
||||
command: [a2x, '-a',
|
||||
'compton-version='+version,
|
||||
'picom-version='+version,
|
||||
'--format', 'manpage', '@INPUT@', '-D',
|
||||
meson.current_build_dir()],
|
||||
install: true, install_dir: 'share/man/man1/')
|
||||
|
||||
@ -1,23 +1,23 @@
|
||||
compton-trans(1)
|
||||
picom-trans(1)
|
||||
================
|
||||
:doctype: manpage
|
||||
:man source: compton
|
||||
:man version: {compton-version}
|
||||
:man source: picom
|
||||
:man version: {picom-version}
|
||||
:man manual: User Commands
|
||||
|
||||
NAME
|
||||
----
|
||||
compton-trans - an opacity setter tool
|
||||
picom-trans - an opacity setter tool
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
*compton-trans* [-w 'WINDOW_ID'] [-n 'WINDOW_NAME'] [-c] [-s] 'OPACITY'
|
||||
*picom-trans* [-w 'WINDOW_ID'] [-n 'WINDOW_NAME'] [-c] [-s] 'OPACITY'
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
*compton-trans* is a bash script that sets '_NET_WM_WINDOW_OPACITY' attribute of a window using standard X11 command-line utilities, including *xprop*(1) and *xwininfo*(1). It is similar to *transset*(1) or *transset-df*(1).
|
||||
*picom-trans* is a bash script that sets '_NET_WM_WINDOW_OPACITY' attribute of a window using standard X11 command-line utilities, including *xprop*(1) and *xwininfo*(1). It is similar to *transset*(1) or *transset-df*(1).
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
@ -42,37 +42,37 @@ EXAMPLES
|
||||
* Set the opacity of the window with specific window ID to 75%:
|
||||
+
|
||||
------------
|
||||
compton-trans -w "$WINDOWID" 75
|
||||
picom-trans -w "$WINDOWID" 75
|
||||
------------
|
||||
|
||||
* Set the opacity of the window with the name "urxvt" to 75%:
|
||||
+
|
||||
------------
|
||||
compton-trans -n "urxvt" 75
|
||||
picom-trans -n "urxvt" 75
|
||||
------------
|
||||
|
||||
* Set current window to opacity of 75%:
|
||||
+
|
||||
------------
|
||||
compton-trans -c 75
|
||||
picom-trans -c 75
|
||||
------------
|
||||
|
||||
* Select target window and set opacity to 75%:
|
||||
+
|
||||
------------
|
||||
compton-trans -s 75
|
||||
picom-trans -s 75
|
||||
------------
|
||||
|
||||
* Increment opacity of current active window by 5%:
|
||||
+
|
||||
------------
|
||||
compton-trans -c +5
|
||||
picom-trans -c +5
|
||||
------------
|
||||
|
||||
* Decrement opacity of current active window by 5%:
|
||||
+
|
||||
------------
|
||||
compton-trans -c -- -5
|
||||
picom-trans -c -- -5
|
||||
------------
|
||||
|
||||
BUGS
|
||||
@ -81,4 +81,4 @@ Please submit bug reports to <https://github.com/yshui/compton>.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
link:compton.1.html[*compton*(1)], *xprop*(1), *xwininfo*(1)
|
||||
link:picom.1.html[*picom*(1)], *xprop*(1), *xwininfo*(1)
|
||||
@ -1,21 +1,21 @@
|
||||
compton(1)
|
||||
picom(1)
|
||||
==========
|
||||
:doctype: manpage
|
||||
:man source: compton
|
||||
:man version: {compton-version}
|
||||
:man source: picom
|
||||
:man version: {picom-version}
|
||||
:man manual: User Commands
|
||||
|
||||
NAME
|
||||
----
|
||||
compton - a compositor for X11
|
||||
picom - a compositor for X11
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
*compton* ['OPTIONS']
|
||||
*picom* ['OPTIONS']
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
compton is a compositor based on Dana Jansens' version of xcompmgr (which itself was written by Keith Packard). It includes some improvements over the original xcompmgr, like window frame opacity and inactive window transparency.
|
||||
picom is a compositor based on Dana Jansens' version of xcompmgr (which itself was written by Keith Packard). It includes some improvements over the original xcompmgr, like window frame opacity and inactive window transparency.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
@ -83,7 +83,7 @@ OPTIONS
|
||||
Show all X errors (for debugging).
|
||||
|
||||
*--config* 'PATH'::
|
||||
Look for configuration file at the path. See *CONFIGURATION FILES* section below for where compton looks for a configuration file by default. Use `/dev/null` to avoid loading configuration file.
|
||||
Look for configuration file at the path. See *CONFIGURATION FILES* section below for where picom looks for a configuration file by default. Use `/dev/null` to avoid loading configuration file.
|
||||
|
||||
*--write-pid-path* 'PATH'::
|
||||
Write process ID to a file.
|
||||
@ -128,13 +128,13 @@ OPTIONS
|
||||
Detect '_NET_WM_OPACITY' on client windows, useful for window managers not passing '_NET_WM_OPACITY' of client windows to frame windows.
|
||||
|
||||
*--refresh-rate* 'REFRESH_RATE'::
|
||||
Specify refresh rate of the screen. If not specified or 0, compton will try detecting this with X RandR extension.
|
||||
Specify refresh rate of the screen. If not specified or 0, picom will try detecting this with X RandR extension.
|
||||
|
||||
*--vsync*, *--no-vsync*::
|
||||
Enable/disable VSync.
|
||||
|
||||
*--sw-opti*::
|
||||
Limit compton to repaint at most once every 1 / 'refresh_rate' second to boost performance. This should not be used with *--vsync* drm/opengl/opengl-oml as they essentially does *--sw-opti*'s job already, unless you wish to specify a lower refresh rate than the actual value.
|
||||
Limit picom to repaint at most once every 1 / 'refresh_rate' second to boost performance. This should not be used with *--vsync* drm/opengl/opengl-oml as they essentially does *--sw-opti*'s job already, unless you wish to specify a lower refresh rate than the actual value.
|
||||
|
||||
*--use-ewmh-active-win*::
|
||||
Use EWMH '_NET_ACTIVE_WINDOW' to determine currently focused window, rather than listening to 'FocusIn'/'FocusOut' event. Might have more accuracy, provided that the WM supports it.
|
||||
@ -209,7 +209,7 @@ May also be one of the predefined kernels: `3x3box` (default), `5x5box`, `7x7box
|
||||
Specify a list of conditions of windows that should be painted with inverted color. Resource-hogging, and is not well tested.
|
||||
|
||||
*--opacity-rule* 'OPACITY':'CONDITION'::
|
||||
Specify a list of opacity rules, in the format `PERCENT:PATTERN`, like `50:name *= "Firefox"`. compton-trans is recommended over this. Note we don't make any guarantee about possible conflicts with other programs that set '_NET_WM_WINDOW_OPACITY' on frame or client windows.
|
||||
Specify a list of opacity rules, in the format `PERCENT:PATTERN`, like `50:name *= "Firefox"`. picom-trans is recommended over this. Note we don't make any guarantee about possible conflicts with other programs that set '_NET_WM_WINDOW_OPACITY' on frame or client windows.
|
||||
|
||||
*--shadow-exclude-reg* 'GEOMETRY'::
|
||||
Specify a X geometry that describes the region in which shadow should not be painted in, such as a dock window region. Use `--shadow-exclude-reg x10+0-0`, for example, if the 10 pixels on the bottom of the screen should not have shadows painted on.
|
||||
@ -236,7 +236,7 @@ May also be one of the predefined kernels: `3x3box` (default), `5x5box`, `7x7box
|
||||
Disable the use of damage information. This cause the whole screen to be redrawn everytime, instead of the part of the screen has actually changed. Potentially degrades the performance, but might fix some artifacts.
|
||||
|
||||
*--xrender-sync-fence*::
|
||||
Use X Sync fence to sync clients' draw calls, to make sure all draw calls are finished before compton starts drawing. Needed on nvidia-drivers with GLX backend for some users.
|
||||
Use X Sync fence to sync clients' draw calls, to make sure all draw calls are finished before picom starts drawing. Needed on nvidia-drivers with GLX backend for some users.
|
||||
|
||||
*--glx-fshader-win* 'SHADER'::
|
||||
GLX backend: Use specified GLSL fragment shader for rendering window contents. See `compton-default-fshader-win.glsl` and `compton-fake-transparency-fshader-win.glsl` in the source tree for examples.
|
||||
@ -342,9 +342,9 @@ This is the old condition format we once used. Support of this format might be r
|
||||
|
||||
CONFIGURATION FILES
|
||||
-------------------
|
||||
compton could read from a configuration file if libconfig support is compiled in. If *--config* is not used, compton will seek for a configuration file in `$XDG_CONFIG_HOME/compton.conf` (`~/.config/compton.conf`, usually), then `~/.compton.conf`, then `compton.conf` under `$XDG_CONFIG_DIRS` (often `/etc/xdg/compton.conf`).
|
||||
picom could read from a configuration file if libconfig support is compiled in. If *--config* is not used, picom will seek for a configuration file in `$XDG_CONFIG_HOME/compton.conf` (`~/.config/compton.conf`, usually), then `~/.compton.conf`, then `compton.conf` under `$XDG_CONFIG_DIRS` (often `/etc/xdg/compton.conf`).
|
||||
|
||||
compton uses general libconfig configuration file format. A sample configuration file is available as `compton.sample.conf` in the source tree. Most of commandline switches can be used as options in configuration file as well. For example, *--vsync* option documented above can be set in the configuration file using `vsync = `. Command line options will always overwrite the settings in the configuration file.
|
||||
picom uses general libconfig configuration file format. A sample configuration file is available as `compton.sample.conf` in the source tree. Most of commandline switches can be used as options in configuration file as well. For example, *--vsync* option documented above can be set in the configuration file using `vsync = `. Command line options will always overwrite the settings in the configuration file.
|
||||
|
||||
Window-type-specific settings are exposed only in configuration file and has the following format:
|
||||
|
||||
@ -406,12 +406,12 @@ Available options of the 'blur' section are: ::
|
||||
SIGNALS
|
||||
-------
|
||||
|
||||
* compton reinitializes itself upon receiving `SIGUSR1`.
|
||||
* picom reinitializes itself upon receiving `SIGUSR1`.
|
||||
|
||||
D-BUS API
|
||||
---------
|
||||
|
||||
It's possible to control compton via D-Bus messages, by running compton with *--dbus* and send messages to `com.github.chjj.compton.<DISPLAY>`. `<DISPLAY>` is the display used by compton, with all non-alphanumeric characters transformed to underscores. For `DISPLAY=:0.0` you should use `com.github.chjj.compton._0_0`, for example.
|
||||
It's possible to control picom via D-Bus messages, by running picom with *--dbus* and send messages to `com.github.chjj.compton.<DISPLAY>`. `<DISPLAY>` is the display used by picom, with all non-alphanumeric characters transformed to underscores. For `DISPLAY=:0.0` you should use `com.github.chjj.compton._0_0`, for example.
|
||||
|
||||
The D-Bus methods and signals are not yet stable, thus undocumented right now.
|
||||
|
||||
@ -421,37 +421,37 @@ EXAMPLES
|
||||
* Disable configuration file parsing:
|
||||
+
|
||||
------------
|
||||
$ compton --config /dev/null
|
||||
$ picom --config /dev/null
|
||||
------------
|
||||
|
||||
* Run compton with client-side shadow and fading, disable shadow on dock windows and drag-and-drop windows:
|
||||
* Run picom with client-side shadow and fading, disable shadow on dock windows and drag-and-drop windows:
|
||||
+
|
||||
------------
|
||||
$ compton -cCGf
|
||||
$ picom -cCGf
|
||||
------------
|
||||
|
||||
* Same thing as above, plus making inactive windows 80% transparent, making frame 80% transparent, don't fade on window open/close, enable software optimization, and fork to background:
|
||||
+
|
||||
------------
|
||||
$ compton -bcCGf -i 0.8 -e 0.8 --no-fading-openclose --sw-opti
|
||||
$ picom -bcCGf -i 0.8 -e 0.8 --no-fading-openclose --sw-opti
|
||||
------------
|
||||
|
||||
* Draw white shadows:
|
||||
+
|
||||
------------
|
||||
$ compton -c --shadow-red 1 --shadow-green 1 --shadow-blue 1
|
||||
$ picom -c --shadow-red 1 --shadow-green 1 --shadow-blue 1
|
||||
------------
|
||||
|
||||
* Avoid drawing shadows on wbar window:
|
||||
+
|
||||
------------
|
||||
$ compton -c --shadow-exclude 'class_g = "wbar"'
|
||||
$ picom -c --shadow-exclude 'class_g = "wbar"'
|
||||
------------
|
||||
|
||||
* Enable VSync with GLX backend:
|
||||
+
|
||||
------------
|
||||
$ compton --backend glx --vsync
|
||||
$ picom --backend glx --vsync
|
||||
------------
|
||||
|
||||
BUGS
|
||||
@ -466,4 +466,4 @@ Homepage: <https://github.com/yshui/compton>
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
*xcompmgr*(1), link:compton-trans.html[*compton-trans*(1)]
|
||||
*xcompmgr*(1), link:picom-trans.html[*picom-trans*(1)]
|
||||
Reference in New Issue
Block a user