Skip to content

Commit 515ef56

Browse files
committed
getting-started: improve configuration section
...to make it clearer where to obtain example configuration files for $HOME/.config/labwc/
1 parent 933266c commit 515ef56

File tree

1 file changed

+47
-11
lines changed

1 file changed

+47
-11
lines changed

src/getting-started.md

+47-11
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,52 @@ Alt-F3 to launch applications.
3535

3636
# Configuration
3737

38-
labwc user configuration files are located at `~/.config/labwc/`. The following
39-
four files are used:
38+
User config files are located at `${XDG_CONFIG_HOME:-$HOME/.config/labwc/}`
39+
(usually `~/.config/labwc/`) with the following five files being used:
40+
[rc.xml], [menu.xml], [autostart], [environment] and [themerc-override].
4041

41-
- rc.xml
42-
- autostart
43-
- environment
44-
- menu.xml
42+
The example [rc.xml] has been kept simple. For all options and default values,
43+
see [rc.xml.all]
4544

46-
The purpose of each of these files should become clear if you take the steps
47-
below.
45+
For full details on configuration options, see the man pages:
46+
[labwc(1)], [labwc-config(5)], [labwc-theme(5)], [labwc-actions(5)] and
47+
[labwc-menu(5)].
48+
49+
Run `labwc --reconfigure` to reload configuration and theme files.
50+
51+
Your OS/Distribution of choice may include these example configuration files in
52+
`/usr/share/doc/labwc/` or similar. If not, you could download them with:
53+
54+
```bash
55+
mkdir -p ~/.config/labwc
56+
wget https://raw.githubusercontent.com/labwc/labwc/master/docs/environment -O ~/.config/labwc/environment
57+
wget https://raw.githubusercontent.com/labwc/labwc/master/docs/autostart -O ~/.config/labwc/autostart
58+
wget https://raw.githubusercontent.com/labwc/labwc/master/docs/menu.xml -O ~/.config/labwc/menu.xml
59+
wget https://raw.githubusercontent.com/labwc/labwc/master/docs/rc.xml -O ~/.config/labwc/rc.xml
60+
```
61+
62+
> **_NOTE:_** Before using these configuration files, please read them through
63+
> and modify the content to suit your specific needs.
64+
65+
For more information about each configuration file and to help create a setup
66+
that work for you, please read through the sections below.
67+
68+
If you get stuck, do reach out on the [IRC Channel] or [Github Discussions].
69+
70+
[rc.xml]: https://github.com/labwc/labwc/blob/master/docs/rc.xml
71+
[rc.xml.all]: https://github.com/labwc/labwc/blob/master/docs/rc.xml.all
72+
[menu.xml]: https://github.com/labwc/labwc/blob/master/docs/menu.xml
73+
[autostart]: https://github.com/labwc/labwc/blob/master/docs/autostart
74+
[environment]: https://github.com/labwc/labwc/blob/master/docs/environment
75+
[themerc-override]: https://github.com/labwc/labwc/blob/master/docs/themerc
76+
[labwc(1)]: https://labwc.github.io/labwc.1.html
77+
[labwc-config(5)]: https://labwc.github.io/labwc-config.5.html
78+
[labwc-menu(5)]: https://labwc.github.io/labwc-menu.5.html
79+
[labwc-environment(5)]: https://labwc.github.io/labwc-environment.5.html
80+
[labwc-theme(5)]: https://labwc.github.io/labwc-theme.5.html
81+
[labwc-actions(5)]: https://labwc.github.io/labwc-actions.5.html
82+
[IRC Channel]: https://web.libera.chat/gamja/?channels=#labwc
83+
[Github Discussions]: https://github.com/labwc/labwc/discussions
4884

4985
## Step 1 - Set your keyboard layout
5086

@@ -65,7 +101,9 @@ XKB_DEFAULT_LAYOUT=se
65101
If you are unsure what your country code is, refer to the 'layout' section of
66102
`/usr/share/X11/xkb/rules/evdev.lst`
67103

68-
See further examples in [docs/environment]
104+
See further details, see [docs/environment] and [xkeyboard-config(7)].
105+
106+
[xkeyboard-config(7)]: https://manpages.debian.org/testing/xkb-data/xkeyboard-config.7.en.html
69107

70108
## Step 2 - Add some items to the root-menu
71109

@@ -85,8 +123,6 @@ for inspiration, or use the simple example below
85123
</openbox_menu>
86124
```
87125

88-
Run `killall -s SIGHUP labwc` to reload the config files.
89-
90126
See [integration#menu-generators] for ideas on how to automatically create
91127
menu.xml files.
92128

0 commit comments

Comments
 (0)