Skip to content

Commit

Permalink
update documentation regarding sockets and init
Browse files Browse the repository at this point in the history
The init command was deprecated, but we didn't put that in the command's
documentation. Similarly, we forgot to update the docs regarding the new
socket path.
  • Loading branch information
LGFae committed Apr 13, 2024
1 parent 01540d7 commit bddd89f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions doc/swww-daemon.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ swww-daemon [-q|--quiet] [-f|--format <xrgb|xbgr|rgb|bgr>]
# DESCRIPTION

The *swww-daemon* will run continuously, waiting for commands in
_$XDG_RUNTIME_DIR/swww.socket_ (or _/tmp/swww/swww.socket_, if $XDG_RUNTIME_DIR
is not set). The daemon will take care of both creating and deleting that file
when it is initialized or killed.
_${XDG_RUNTIME_DIR}/swww-${WAYLAND_DISPLAY}.socket_ (or
_/tmp/swww/swww-${WAYLAND_DISPLAY}.socket_, if $XDG_RUNTIME_DIR is not set). The
daemon will take care of both creating and deleting that file when it is
initialized or killed.

# SEE ALSO
*swww-init*(1)
4 changes: 2 additions & 2 deletions doc/swww.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ protocol*. Typically, _wlr-roots_ based compositors.

# FILES
*swww* will create the following files in your system:
- A socket in _$XDG_RUNTIME_DIR/swww.socket_ or _/tmp/swww/swww.socket_, if
$XDG_RUNTIME_DIR does not exist.
- A socket in _${XDG_RUNTIME_DIR}/swww-${WAYLAND_DISPLAY}.socket_, or
_/tmp/swww/swww-${WAYLAND_DISPLAY}.socket_, if $XDG_RUNTIME_DIR is not set.
- Cache files in _$XDG_CACHE_HOME/swww_ or _$HOME/.cache/swww_ if
$XDG_CACHE_HOME does not exist. These are used to set the wallpaper to the
previous image when a monitor is (re)connected or turned on.
Expand Down
2 changes: 1 addition & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ pub enum Swww {
/// Use `-` to read from stdin
Img(Img),

/// Initializes the daemon.
/// [DEPRECATED] Initializes the daemon.
///
/// Exits if there is already a daemon running. We check that by seeing if
/// $XDG_RUNTIME_DIR/swww.socket exists.
Expand Down

0 comments on commit bddd89f

Please sign in to comment.