Skip to content

Commit

Permalink
docs: add server side decorations and default layout manager to quick
Browse files Browse the repository at this point in the history
start
  • Loading branch information
alex-courtis committed Apr 6, 2024
1 parent a2907bb commit 3e69a71
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 4 deletions.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,35 @@ Tiling window manager for the [river](https://github.com/riverwm/river) wayland

<br/>

<details>
<summary>
Set server side decorations.
</summary>

Required to display borders on all windows.

``` sh
riverctl rule-add ssd
```

</details>

<br/>

<details>
<summary>
Set the layout generator and start it.
</summary>

All defaults shown here, none are required.

Log is strongly recommended.
Log file is strongly recommended.

``` sh
# set layout manager
riverctl default-layout wideriver

# start layout manager
wideriver \
--layout left \
--layout-alt monocle \
Expand Down
19 changes: 18 additions & 1 deletion doc/templ/20.man.readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,30 @@ Tiling window manager for the [river](https://github.com/riverwm/river) wayland

<details>

<summary>Set server side decorations.</summary>

Required to display borders on all windows.

``` sh
riverctl rule-add ssd
```
</details>

<br/>

<details>

<summary>Set the layout generator and start it.</summary>

All defaults shown here, none are required.

Log is strongly recommended.
Log file is strongly recommended.

``` sh
# set layout manager
riverctl default-layout wideriver

# start layout manager
@HELP_DEFAULTS@
```
</details>
Expand Down
18 changes: 16 additions & 2 deletions man/wideriver.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "WIDERIVER" "1" "2024/04/01" "wideriver" "User Manuals"
.TH "WIDERIVER" "1" "2024/04/06" "wideriver" "User Manuals"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -131,14 +131,28 @@ T}
.PP
\f[V]$XDG_CONFIG_HOME/river/init\f[R]
.PP
Set server side decorations.
.PP
Required to display borders on all windows.
.IP
.nf
\f[C]
riverctl rule-add ssd
\f[R]
.fi
.PP
Set the layout generator and start it.
.PP
All defaults shown here, none are required.
.PP
Log is strongly recommended.
Log file is strongly recommended.
.IP
.nf
\f[C]
# set layout manager
riverctl default-layout wideriver

# start layout manager
wideriver \[rs]
--layout left \[rs]
--layout-alt monocle \[rs]
Expand Down

0 comments on commit 3e69a71

Please sign in to comment.