1WAYFIRE(1)                BSD General Commands Manual               WAYFIRE(1)
2

NAME

4     wayfire — modular and extensible wayland compositor
5

SYNOPSIS

7     wayfire [-c, --config config_file] [-B, --config-backend config_backend]
8             [-d, --debug] [-D, --damage-debug] [-h, --help]
9             [-R, --damage-renderer] [-v, --version]
10

DESCRIPTION

12     wayfire is a wayland compositor focusing on modularity and extensibility
13     by providing a small core compositor implementation with all major func‐
14     tionality being provided by plugins.  The default plugins provide 3D ef‐
15     fects similar to compiz, such as 3D cube, wobbly windows, blur, fish eye,
16     etc.
17
18     The optional flags are described as follows:
19
20     -c, --config config_file
21
22             Start wayfire with an alternative configuration file.  The de‐
23             fault configuration file is searched first in the
24             ${WAYFIRE_CONFIG_FILE} environment variable, or paths
25             ${XDG_CONFIG_HOME}/wayfire.ini, ${HOME}/.config/wayfire.ini.
26
27     -B, --config-backend config_backend
28
29             Specify config backend to use.
30
31     -d, --debug
32
33             Enable debug logging.
34
35     -D, --damage-debug
36
37             Enable additional debug for damaged regions.
38
39     -h, --help
40
41             Print a short help message.
42
43     -R, --damage-renderer
44
45             Rerender damaged regions.
46
47     -v, --version
48
49             Print the version.
50

ENVIRONMENT VARIABLES

52     wayfire respects the following environment variables:
53
54     WAYFIRE_CONFIG_FILE
55             The config file to use.
56
57     WAYFIRE_PLUGIN_XML_PATH
58
59             A string of paths, separated by : , in which to look for plugin
60             configuration files.  By default wayfire looks for configuration
61             files in /usr/share/wayfire/metadata and
62             ${XDG_DATA_HOME}/wayfire/metadata.
63
64     WAYFIRE_PLUGIN_PATH
65
66             A string of paths, separated by : , in which to look for plugins.
67             By default wayfire looks for plugins in /usr/lib64/wayfire and
68             ${XDG_DATA_HOME}/wayfire/plugins.
69
70     _WAYFIRE_SOCKET
71
72             Socket override to use to communicate with a specific wayfire in‐
73             stance using the IPC.  Useful incase of multiple running in‐
74             stances of wayfire.
75
76     In addition, wayfire also sets the following environment variables:
77
78     WAYFIRE_SOCKET
79
80             Socket to use when communicating with wayfire.
81
82     WAYLAND_DISPLAY
83
84             Wayland display currently in effect.
85
86     CONFIG_FILE_ENV
87
88             Which config file is being used.
89
90     _JAVA_AWT_WM_NONREPARENTING
91
92             Needed for java based windows and it is set to 1.
93
94     DISPLAY
95     XCURSOR_SIZE
96     XCURSOR_THEME
97
98             Variables for use with legacy xwayland(1) windows.
99

SEE ALSO

101     xwayland(1)
102
103BSD                              May 21, 2023                              BSD
Impressum