dotfiles

my shiny new dotfiles
git clone git://git.jakekoroman.com/dotfiles
Log | Files | Refs | README

dwl.1 (3376B)


      1 .Dd January 8, 2021
      2 .Dt DWL 1
      3 .Os
      4 .Sh NAME
      5 .Nm dwl
      6 .Nd dwm for Wayland
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Fl v
     10 .Op Fl d
     11 .Op Fl s Ar startup command
     12 .Sh DESCRIPTION
     13 .Nm
     14 is a Wayland compositor based on wlroots.
     15 It is intended to fill the same space in the Wayland world that
     16 .Nm dwm
     17 does for X11.
     18 .Pp
     19 When given the
     20 .Fl v
     21 option,
     22 .Nm
     23 writes its name and version to standard error and exits unsuccessfully.
     24 .Pp
     25 When given the
     26 .Fl d
     27 option,
     28 .Nm
     29 enables full wlroots logging, including debug information.
     30 .Pp
     31 When given the
     32 .Fl s
     33 option,
     34 .Nm
     35 starts a shell process running
     36 .Ar command
     37 when starting.
     38 When stopping, it sends
     39 .Dv SIGTERM
     40 to the child process and waits for it to exit.
     41 .Pp
     42 Users are encouraged to customize
     43 .Nm
     44 by editing the sources, in particular
     45 .Pa config.h .
     46 The default key bindings are as follows:
     47 .Bl -tag -width 20n -offset indent -compact
     48 .It Mod-[1-9]
     49 Show only all windows with a tag.
     50 .It Mod-Ctrl-[1-9]
     51 Show all windows with a tag.
     52 .It Mod-Shift-[1-9]
     53 Move window to a single tag.
     54 .It Mod-Ctrl-Shift-[1-9]
     55 Toggle tag for window.
     56 .It Mod-p
     57 Spawn
     58 .Nm bemenu-run .
     59 .It Mod-Shift-Return
     60 Spawn
     61 .Nm foot .
     62 .It Mod-[jk]
     63 Move focus down/up the stack.
     64 .It Mod-[id]
     65 Increase/decrease number of windows in master area.
     66 .It Mod-[hl]
     67 Decrease/increase master area.
     68 .It Mod-Return
     69 Move window on top of stack or switch top of stack with second window.
     70 .It Mod-Tab
     71 Show only all windows with previous tag.
     72 .It Mod-Shift-c
     73 Close window.
     74 .It Mod-t
     75 Switch to tabbed layout.
     76 .It Mod-f
     77 Switch to floating layout.
     78 .It Mod-m
     79 Switch to monocle layout.
     80 .It Mod-Space
     81 Switch to previous layout.
     82 .It Mod-Shift-Space
     83 Toggle floating state of window.
     84 .It Mod-e
     85 Toggle fullscreen state of window.
     86 .It Mod-0
     87 Show all windows.
     88 .It Mod-Shift-0
     89 Set all tags for window.
     90 .It Mod-,
     91 Move focus to previous monitor.
     92 .It Mod-.
     93 Move focus to next monitor.
     94 .It Mod-Shift-,
     95 Move window to previous monitor.
     96 .It Mod-Shift-.
     97 Move window to next monitor.
     98 .It Mod-Shift-q
     99 Quit
    100 .Nm .
    101 .El
    102 These might differ depending on your keyboard layout.
    103 .Sh ENVIRONMENT
    104 These environment variables are used by
    105 .Nm :
    106 .Bl -tag -width XDG_RUNTIME_DIR
    107 .It Ev XDG_RUNTIME_DIR
    108 A directory where temporary user files, such as the Wayland socket,
    109 are stored.
    110 .It Ev XDG_CONFIG_DIR
    111 A directory containing configuration of various programs and
    112 libraries, including libxkbcommon.
    113 .It Ev DISPLAY , WAYLAND_DISPLAY , WAYLAND_SOCKET
    114 Tell how to connect to an underlying X11 or Wayland server.
    115 .It Ev WLR_*
    116 Various variables specific to wlroots.
    117 .It Ev XKB_* , XLOCALEDIR , XCOMPOSEFILE
    118 Various variables specific to libxkbcommon.
    119 .It Ev XCURSOR_PATH
    120 List of directories to search for XCursor themes in.
    121 .It Ev HOME
    122 A directory where there are always dear files there for you.
    123 Waiting for you to clean them up.
    124 .El
    125 .Pp
    126 These are set by
    127 .Nm :
    128 .Bl -tag -width WAYLAND_DISPLAY
    129 .It Ev WAYLAND_DISPLAY
    130 Tell how to connect to
    131 .Nm .
    132 .It Ev DISPLAY
    133 If using
    134 .Nm Xwayland ,
    135 tell how to connect to the
    136 .Nm Xwayland
    137 server.
    138 .El
    139 .Sh EXAMPLES
    140 Start
    141 .Nm
    142 with s6 in the background:
    143 .Dl dwl -s 's6-svscan <&-'
    144 .Sh SEE ALSO
    145 .Xr foot 1 ,
    146 .Xr bemenu 1 ,
    147 .Xr dwm 1 ,
    148 .Xr xkeyboard-config 7
    149 .Sh CAVEATS
    150 The child process's standard input is connected with a pipe to
    151 .Nm .
    152 If the child process neither reads from the pipe nor closes its
    153 standard input,
    154 .Nm
    155 will freeze after a while due to it blocking when writing to the full
    156 pipe buffer.
    157 .Sh BUGS
    158 All of them.