From 3325239f8940c2ff21a8863c7698405e232c882e Mon Sep 17 00:00:00 2001 From: speediegq Date: Mon, 24 Oct 2022 17:49:30 +0200 Subject: [PATCH] fix: html not being generated properly --- README.md | 288 +++++++++++++++++++++++++++++++++++---- docs/example.Xresources | 292 ++++++++++++++++++++-------------------- scripts/speedwm-help | 54 ++++---- scripts/speedwm_run | 2 +- 4 files changed, 440 insertions(+), 196 deletions(-) diff --git a/README.md b/README.md index d722e9c..9cc9848 100644 --- a/README.md +++ b/README.md @@ -67,33 +67,22 @@ Please let me know if any keybinds are missing as these have been manually added These keybinds are for navigating speedwm - - Super+t | Reorganize tags and move windows - Super+f | Full-screen the selected window - Super+b | Show/hide the speedwm bar - Super+s | Show/hide the systray - Super+j/k | Move focus between visible windows - Super+m | Moves focus to the Master window (or back if Master is already focused) - - Super+Control+z/x | Increase/decrease gaps between windows by 5 - - Super+Control+j/k | Move focus between hidden windows (Can then 'Show') - Super+a/d | Increase/decrease size of each window + - Super+w/e | Resize the window keeping the aspect ratio of it. - Super+o | Hide a window - - Super+Control+o | Show a hidden focused window - - Super+Control+Shift+o | Show all hidden windows - - Super+Control+Shift+p | Hide all windows - - Super+Control+a/d | Move to the next/previous tag - - Super+Control+Shift+z/c | Move to the next/previous tag skipping any without windows open - Super+Minus | Show the scratchpad - Super+Equal | Remove the scratchpad - Super+Enter | Switch order of windows - - Super+Shift+q | Close the current window - Super+Colon | Open a list of desktop entries in dmenu + - Super+Tab | Switch between windows on the same tag. (Like Windows Alt+Tab) - Super+0 | Reset mfact - Super+r | Reset number of masters - - Super+t | Disable inactive fade - - Super+Shift+Equal | Toggle scratchpads - - Super+Shift+Minus | Hide the scratchpad - - Super+Shift+Space | Unfloat floating windows - - Super+Shift+Arrow | Resizes a window in floating mode + - Super+y | Make the current selected window sticky - Super+1 | Move to tag 1 - Super+2 | Move to tag 2 - Super+3 | Move to tag 3 @@ -112,8 +101,14 @@ Please let me know if any keybinds are missing as these have been manually added - Super+Shift+7 | Preview tag 7 - Super+Shift+8 | Preview tag 8 - Super+Shift+9 | Preview tag 9 + - Super+Shift+q | Close the current window - Super+Shift+h/j/k/l | Rotates a stack. + - Super+Shift+Arrow | Resizes a window in floating mode - Super+Shift+Escape | Ask the user if they want to shutdown or reboot or nothing + - Super+Shift+Tab | Switch between windows and tags in detail. + - Super+Shift+Equal | Toggle scratchpads + - Super+Shift+Minus | Hide the scratchpad + - Super+Shift+Space | Toggle floating windows - Super+Control+1 | Combine the current tag with tag 1 - Super+Control+2 | Combine the current tag with tag 2 - Super+Control+3 | Combine the current tag with tag 3 @@ -123,14 +118,21 @@ Please let me know if any keybinds are missing as these have been manually added - Super+Control+7 | Combine the current tag with tag 7 - Super+Control+8 | Combine the current tag with tag 8 - Super+Control+9 | Combine the current tag with tag 9 - - Super+Control+Shift+Colon | Open a list of extra software in dmenu - Super+Control+q | Mutes your audio - Super+Control+w | Increases your volume - Super+Control+e | Decreases your volume - Super+Control+0 | Tag all tags at once. + - Super+Control+z/x | Increase/decrease gaps between windows by 5 + - Super+Control+j/k | Move focus between hidden windows (Can then 'Show') - Super+Control+Arrow | Moves a window to any corner of your screen (Arrow key) - Super+Control+Tab | Open a dmenu prompt asking the user what layout to switch to - Super+Control+h | Open a list of all keybinds in your terminal using less + - Super+Control+o | Show a hidden focused window + - Super+Control+a/d | Move to the next/previous tag + - Super+Control+Shift+o | Show all hidden windows + - Super+Control+Shift+p | Hide all windows + - Super+Control+Shift+Colon | Open a list of extra software in dmenu + - Super+Control+Shift+z/c | Move to the next/previous tag skipping any without windows open - Super+Control+Shift+a/d | Move between available layouts - Super+Control+Shift+1 | Move the focused window to tag 1 - Super+Control+Shift+2 | Move the focused window to tag 2 @@ -151,13 +153,27 @@ Please let me know if any keybinds are missing as these have been manually added - Super+Control+Shift+w | Decreases your music volume - Super+Control+Shift+e | Increase your music volume - Super+Control+Shift+r | Restart speedwm - - Super+w/e | Resize the window keeping the aspect ratio of it. - - Super+Tab | Switch between windows on the same tag. (Like Windows Alt+Tab) - - Super+Shift+Tab | Switch between windows and tags in detail. - Super+Control+Shift+j/k | Change window size vertically (cfact) + - Super+Control+Shift+Equal | Increase bar height by 1 + - Super+Control+Shift+Minus | Decrease bar height by 1 ### Chained keybinds + - Super+r & s | Run screenkey if it is installed + - Super+r & d | Kill screenkey + - Super+w & r | Randomize wallpaper + - Super+w & p | Set wallpaper to the previous + - Super+t & r | Reorganize tags and move windows + - Super+t & t | Toggle tag area in the bar + - Super+t & y | Toggle empty tag area in the bar + - Super+t & w | Toggle title area in the bar + - Super+t & u | Toggle unselected title area in the bar + - Super+t & p | Toggle powerline tags in the bar + - Super+t & s | Toggle status area in the bar + - Super+t & l | Toggle layout area in the bar + - Super+t & o | Toggle inactive fade + - Super+t & b | Show all bar modules + - Super+t & s | Make the current selected window sticky - Super+c & w | Get the weather (Using wttr.in) - Super+c & n | Switch to the next track - Super+c & p | Switch to the previous track @@ -166,16 +182,15 @@ Please let me know if any keybinds are missing as these have been manually added - Super+g & i | Increase inner gaps by 1 - Super+g & o | Increase outer gaps by 1 - Super+g & j/k | Increase/decrease gaps between windows by 1 + - Super+p & j/k | Increase/decrease bar padding by 1 + - Super+p & u/d | Increase/decrease bar padding by 5 + - Super+p & r | Reset bar padding to default + - Super+p & t | Toggle bar padding on/off - Super+Shift+g & i | Decrease inner gaps by 1 - Super+Shift+g & o | Decrease outer gaps by 1 - - Super+r & s | Run screenkey if it is installed - - Super+r & d | Kill screenkey - Super+Shift+e & a | Open the virtual keyboard - Super+Shift+e & e | Open a list of all emojis and copy the selection - Super+Shift+k & o | Kill every window except the focused - - Super+t & s | Make the current selected window sticky - - Super+w & r | Randomize wallpaper - - Super+w & p | Set wallpaper to the previous ### Extras @@ -306,6 +321,207 @@ Note that the 'xrdb' dependency is required for both pywal and .Xresources suppo Below is a list of all .Xresources values you can define. The .Xresources file should be placed in ~ or ~/.config by the user. If it is not or you want it somewhere else, you can edit 'autostart.h' and 'make clean install'. + + + - speedwm.bar.height: 8 ! Height of the bar in pixels () + - speedwm.bar.position: 1 ! Position of the bar (0: Bottom, 1: Top) + - speedwm.bar.paddingh: 10 ! Horizontal padding (extra space) around the bar in pixels () + - speedwm.bar.paddingv: 10 ! Vertical padding (extra space) around the bar in pixels () + + + - speedwm.bar.hide: 0 ! Hide the bar by default (0/1) + - speedwm.bar.hide.tags: 0 ! Hide the tags (0/1) + - speedwm.bar.hide.emptytags: 1 ! Hide the tags that have no windows open (0/1) + - speedwm.bar.hide.powerline: 0 ! Hide the powerline drawn over the tags (0/1) + - speedwm.bar.hide.floating: 0 ! Hide the floating window indicator (0/1) + - speedwm.bar.hide.layout: 0 ! Hide the layout indicator (0/1) + - speedwm.bar.hide.sticky: 0 ! Hide the sticky indicator (0/1) + - speedwm.bar.hide.status: 0 ! Hide the status bar (0/1) + - speedwm.bar.hide.systray: 1 ! Hide the systray (0/1) + - speedwm.bar.hide.title: 0 ! Hide the window title (0/1) + - speedwm.bar.hide.unseltitle: 1 ! Hide the unselected window title (0/1) + - speedwm.bar.hide.icon: 0 ! Hide the window icon (0/1) + + + - speedwm.bar.layoutposition: 1 ! Position of the layout indicator (0: Right, 1: Left) + + + - speedwm.border.roundedcorners: 0 ! Enable rounded corners around the border of windows (0/1) + - speedwm.border.cornerradius: 2 ! Corner radius when rounded corners are enabled () + - speedwm.border.size: 1 ! Size of the border around windows in pixels () + + + - speedwm.client.allowurgent: 1 ! Allow windows to have the 'urgent' status (0/1) + - speedwm.client.autoresize: 1 ! Allow windows to resize themselves on demand (0/1) + - speedwm.client.decorhints: 1 ! Respect decoration hints for windows (0/1) + - speedwm.client.fade.inactive: 1 ! Fade inactive windows (windows that are not focused) (0/1) + - speedwm.client.fade.windows: 1 ! Fade windows (0/1) + - speedwm.client.floatscratchpad: 0 ! Float a scratchpad window when it is shown (0/1) + - speedwm.client.savefloat: 1 ! Save the position of floating windows when they are no longer floating (0/1) + - speedwm.client.swallow: 1 ! Allow clients to be swallowed by the terminal emulator (0/1) + - speedwm.client.swallowfloating: 1 ! Also allow floating clients to be swallowed (0/1) + - speedwm.client.wmclass: 1 ! Enable workaround for when a class cannot be grabbed from a client (0/1) + + + - speedwm.fonts.font1: NotoSans-Regular:size=8:antialiasing=true + - speedwm.fonts.font2: fontawesome:size=8:antialiasing=true + - speedwm.fonts.font3: Noto Color Emoji:size=8:antialiasing=true + + + - speedwm.col.background: #222222 + - speedwm.col.layout: #99b3ff + - speedwm.col.layouttext: #000000 + - speedwm.col.status0: #131210 + - speedwm.col.status1: #bf616a + - speedwm.col.status2: #A16F9D + - speedwm.col.status3: #68ABAA + - speedwm.col.status4: #A89F93 + - speedwm.col.status5: #D3A99B + - speedwm.col.status6: #AFC9AC + - speedwm.col.status7: #eae1cb + - speedwm.col.status8: #a39d8e + - speedwm.col.status9: #6D5E8E + - speedwm.col.status10: #a16f9d + - speedwm.col.status11: #d3a99b + - speedwm.col.status12: #afc9ac + - speedwm.col.status13: #eae1cb + - speedwm.col.status14: #6d5e8e + - speedwm.col.status15: #ffffff + - speedwm.col.systray: #222222 + - speedwm.col.tag1: #99b3ff + - speedwm.col.tag1.text: #eeeeee + - speedwm.col.tag2: #99b3ff + - speedwm.col.tag2.text: #eeeeee + - speedwm.col.tag3: #99b3ff + - speedwm.col.tag3.text: #eeeeee + - speedwm.col.tag4: #99b3ff + - speedwm.col.tag4.text: #eeeeee + - speedwm.col.tag5: #99b3ff + - speedwm.col.tag5.text: #eeeeee + - speedwm.col.tag6: #99b3ff + - speedwm.col.tag6.text: #eeeeee + - speedwm.col.tag7: #99b3ff + - speedwm.col.tag7.text: #eeeeee + - speedwm.col.tag8: #99b3ff + - speedwm.col.tag8.text: #eeeeee + - speedwm.col.tag9: #99b3ff + - speedwm.col.tag9.text: #eeeeee + - speedwm.col.tagurgent: #f0e68c + - speedwm.col.textnorm: #bbbbbb + - speedwm.col.textsel: #eeeeee + - speedwm.col.titlenorm: #222222 + - speedwm.col.titlesel: #99b3ff + - speedwm.col.titlehid: #222222 + - speedwm.col.windowbordernorm: #000000 + - speedwm.col.windowbordersel: #eeeeee + - speedwm.col.windowborderurg: #f0e68c + + + - speedwm.color.hiddentitle: 1 ! Color the hidden title (0/1) + - speedwm.color.layout: 0 ! Color the layout indicator (0/1) + - speedwm.color.selectedtitle: 0 ! Color the selected title (0/1) + + + - speedwm.cursor.warp: 1 ! Warp the cursor to the next focused window/monitor (0/1) + + + - speedwm.focus.spawned: 0 ! Focus the newly spawned window or keep focus (0/1) + + + - speedwm.fullscreen.hidebar: 1 ! Hide the bar when a client is fullscreened (0/1) + - speedwm.fullscreen.lockfullscreen: 1 ! Lock the fullscreen (0/1) + - speedwm.fullscreen.movefullscreenmon: 0 ! Allow moving fullscreened windows to another monitor (0/1) + + + - speedwm.gaps.enable: 1 ! Enable gaps around the windows + - speedwm.gaps.sizeih: 10 ! Horizontal inner gap size () + - speedwm.gaps.sizeiv: 10 ! Vertical inner gap size () + - speedwm.gaps.sizeoh: 10 ! Horizontal outer gap size () + - speedwm.gaps.sizeov: 10 ! Vertical outer gap size () + - speedwm.gaps.smartgaps: 0 ! Enable different gap size when only one client is spawned (0/1) + - speedwm.gaps.smartgapsize: 0 ! Size of the gaps when only one client is spawned (0/1) + + + - speedwm.icon.size: 10 ! Size of the window icon in the taskbar () + - speedwm.icon.spacing: 5 ! Spacing between icon and text in the taskbar () + + + + - speedwm.layout.deck.count: 0 ! Enable deck count in the deck layout (0/1) + + - speedwm.layout.deck.format: [0] + + + - speedwm.layout.dgrid.forcevsplit: 1 ! Force vertical splits in the dynamic grid layout (0/1) + + + - speedwm.layout.monocle.clientcount: 0 ! Enable client count in the monocle layout (0/1) + - speedwm.layout.monocle.count: 0 ! Enable focused client and number of total clients in the monocle layout (0/1) + + - speedwm.layout.monocle.format: [0/0] + + + - speedwm.mfact: 0.50 ! Default mfact (0-1) + - speedwm.mfact.lowest: 0.05 ! Lowest possible mfact (0-1) + + + - speedwm.mouse.clicktofocus: 0 ! Require clicking on a window to focus or focus when the cursor touches it (0/1) + - speedwm.mouse.mfact: 1 ! Enable adjusting mfact with your mouse (0/1) + - speedwm.mouse.cfact: 1 ! Enable adjusting cfact with your mouse (0/1) + - speedwm.mouse.mousepreview: 1 ! Enable previewing tags by hovering over them with your cursor (0/1) + + + - speedwm.rule.refresh: 1 ! Allow rules to be refreshed if a title/class changes (0/1) + + + - speedwm.stack.attachdirection: 3 ! Direction to attach windows in (0: Default, 1: Above, 2: Aside, 3: Below, 4: Bottom, 5: Top) + - speedwm.stack.centerfloating: 1 ! Center floating windows (0/1) + - speedwm.stack.i3mcount: 0 ! Enable i3 like nmaster/mastercount (0/1) + - speedwm.stack.mastercount: 1 ! Number of master clients in the master stack to start with (0/1) + - speedwm.stack.snap: 20 ! Snap pixel () + + + - speedwm.status.defaultstatus: + + - speedwm.status.status: status + + - speedwm.status.statusallmons: 1 ! Display status text on all monitors (0/1) + + + - speedwm.switcher.maxheight: 200 ! Max height of the switcher in pixels () + - speedwm.switcher.maxwidth: 600 ! Max width of the switcher in pixels () + - speedwm.switcher.menupositionv: 1 ! Menu position of the switcher vertically (0: Bottom, 1: Center, 2: Top) + - speedwm.switcher.menupositionh: 1 ! Menu position of the switcher horizontally (0: Left, 1: Center, 2: Right) + + + - speedwm.systray.padding: 2 ! Extra padding between status and systray (0/1) + - speedwm.systray.pinning: 0 ! Always show systray on the focused monitor or (0/) + - speedwm.systray.position: 0 ! Position of the systray horizontally (0: Right, 1: Left) + + + - speedwm.tag.pertag: 1 ! Allow tags to have their own values (0/1) + - speedwm.tag.preview: 1 ! Enable tag previews (0/1) + - speedwm.tag.preview.bar: 0 ! Include the bar in the tag preview (0/1) + - speedwm.tag.preview.paddingh: 0 ! Extra horizontal padding between the tag preview and the edge of the screen () + - speedwm.tag.preview.paddingv: 0 ! Extra vertical padding between the tag preview and the bar () + - speedwm.tag.preview.scale: 2 ! Amount to scale down the preview picture by () + - speedwm.tag.resetgaps: 1 ! Reset gaps when the tag has no clients (0/1) + - speedwm.tag.resetlayout: 1 ! Reset layout when the tag has no clients (0/1) + - speedwm.tag.resetmfact: 1 ! Reset mfact when the tag has no clients (0/1) + - speedwm.tag.start: 1 ! Start on a tag on startup (0/1) + - speedwm.tag.underline: 0 ! Draw an underline on the tags (0/1) + - speedwm.tag.underlineall: 0 ! Show underline on all tags or just the selected tags (0/1) + - speedwm.tag.underlinepad: 5 ! Horizontal padding between the underline and tag () + - speedwm.tag.underlinestroke: 2 ! Height of the underline in pixels () + - speedwm.tag.underlinevoffset: 0 ! How far above the bottom of the bar the line should appear () - - speedwm.bar.position: 1 !! Position of the bar (0: Bottom, 1: Top) - - speedwm.bar.paddingh: 10 !! Horizontal padding (extra space) around the bar in pixels () - - speedwm.bar.paddingv: 10 !! Vertical padding (extra space) around the bar in pixels () - +!@ + - speedwm.bar.height: 8 ! Height of the bar in pixels () + - speedwm.bar.position: 1 ! Position of the bar (0: Bottom, 1: Top) + - speedwm.bar.paddingh: 10 ! Horizontal padding (extra space) around the bar in pixels () + - speedwm.bar.paddingv: 10 ! Vertical padding (extra space) around the bar in pixels () +!@ !! Bar module options - - - speedwm.bar.hide: 0 !! Hide the bar by default (0/1) - - speedwm.bar.hide.tags: 0 !! Hide the tags (0/1) - - speedwm.bar.hide.emptytags: 1 !! Hide the tags that have no windows open (0/1) - - speedwm.bar.hide.powerline: 0 !! Hide the powerline drawn over the tags (0/1) - - speedwm.bar.hide.floating: 0 !! Hide the floating window indicator (0/1) - - speedwm.bar.hide.layout: 0 !! Hide the layout indicator (0/1) - - speedwm.bar.hide.sticky: 0 !! Hide the sticky indicator (0/1) - - speedwm.bar.hide.status: 0 !! Hide the status bar (0/1) - - speedwm.bar.hide.systray: 1 !! Hide the systray (0/1) - - speedwm.bar.hide.title: 0 !! Hide the window title (0/1) - - speedwm.bar.hide.unseltitle: 1 !! Hide the unselected window title (0/1) - - speedwm.bar.hide.icon: 0 !! Hide the window icon (0/1) - +!@ + - speedwm.bar.hide: 0 ! Hide the bar by default (0/1) + - speedwm.bar.hide.tags: 0 ! Hide the tags (0/1) + - speedwm.bar.hide.emptytags: 1 ! Hide the tags that have no windows open (0/1) + - speedwm.bar.hide.powerline: 0 ! Hide the powerline drawn over the tags (0/1) + - speedwm.bar.hide.floating: 0 ! Hide the floating window indicator (0/1) + - speedwm.bar.hide.layout: 0 ! Hide the layout indicator (0/1) + - speedwm.bar.hide.sticky: 0 ! Hide the sticky indicator (0/1) + - speedwm.bar.hide.status: 0 ! Hide the status bar (0/1) + - speedwm.bar.hide.systray: 1 ! Hide the systray (0/1) + - speedwm.bar.hide.title: 0 ! Hide the window title (0/1) + - speedwm.bar.hide.unseltitle: 1 ! Hide the unselected window title (0/1) + - speedwm.bar.hide.icon: 0 ! Hide the window icon (0/1) +!@ !! Layout indicator options - - - speedwm.bar.layoutposition: 1 !! Position of the layout indicator (0: Right, 1: Left) - +!@ + - speedwm.bar.layoutposition: 1 ! Position of the layout indicator (0: Right, 1: Left) +!@ !! Border options - - - speedwm.border.roundedcorners: 0 !! Enable rounded corners around the border of windows (0/1) - - speedwm.border.cornerradius: 2 !! Corner radius when rounded corners are enabled () - - speedwm.border.size: 1 !! Size of the border around windows in pixels () - +!@ + - speedwm.border.roundedcorners: 0 ! Enable rounded corners around the border of windows (0/1) + - speedwm.border.cornerradius: 2 ! Corner radius when rounded corners are enabled () + - speedwm.border.size: 1 ! Size of the border around windows in pixels () +!@ !! Client options - - - speedwm.client.allowurgent: 1 !! Allow windows to have the 'urgent' status (0/1) - - speedwm.client.autoresize: 1 !! Allow windows to resize themselves on demand (0/1) - - speedwm.client.decorhints: 1 !! Respect decoration hints for windows (0/1) - - speedwm.client.fade.inactive: 1 !! Fade inactive windows (windows that are not focused) (0/1) - - speedwm.client.fade.windows: 1 !! Fade windows (0/1) - - speedwm.client.floatscratchpad: 0 !! Float a scratchpad window when it is shown (0/1) - - speedwm.client.savefloat: 1 !! Save the position of floating windows when they are no longer floating (0/1) - - speedwm.client.swallow: 1 !! Allow clients to be swallowed by the terminal emulator (0/1) - - speedwm.client.swallowfloating: 1 !! Also allow floating clients to be swallowed (0/1) - - speedwm.client.wmclass: 1 !! Enable workaround for when a class cannot be grabbed from a client (0/1) - +!@ + - speedwm.client.allowurgent: 1 ! Allow windows to have the 'urgent' status (0/1) + - speedwm.client.autoresize: 1 ! Allow windows to resize themselves on demand (0/1) + - speedwm.client.decorhints: 1 ! Respect decoration hints for windows (0/1) + - speedwm.client.fade.inactive: 1 ! Fade inactive windows (windows that are not focused) (0/1) + - speedwm.client.fade.windows: 1 ! Fade windows (0/1) + - speedwm.client.floatscratchpad: 0 ! Float a scratchpad window when it is shown (0/1) + - speedwm.client.savefloat: 1 ! Save the position of floating windows when they are no longer floating (0/1) + - speedwm.client.swallow: 1 ! Allow clients to be swallowed by the terminal emulator (0/1) + - speedwm.client.swallowfloating: 1 ! Also allow floating clients to be swallowed (0/1) + - speedwm.client.wmclass: 1 ! Enable workaround for when a class cannot be grabbed from a client (0/1) +!@ !! Font options - +!@ - speedwm.fonts.font1: NotoSans-Regular:size=8:antialiasing=true - speedwm.fonts.font2: fontawesome:size=8:antialiasing=true - speedwm.fonts.font3: Noto Color Emoji:size=8:antialiasing=true - +!@ !! Color options - +!@ - speedwm.col.background: #222222 - speedwm.col.layout: #99b3ff - speedwm.col.layouttext: #000000 @@ -108,137 +108,137 @@ - speedwm.col.windowbordernorm: #000000 - speedwm.col.windowbordersel: #eeeeee - speedwm.col.windowborderurg: #f0e68c - +!@ !! Color toggles - - - speedwm.color.hiddentitle: 1 !! Color the hidden title (0/1) - - speedwm.color.layout: 0 !! Color the layout indicator (0/1) - - speedwm.color.selectedtitle: 0 !! Color the selected title (0/1) - +!@ + - speedwm.color.hiddentitle: 1 ! Color the hidden title (0/1) + - speedwm.color.layout: 0 ! Color the layout indicator (0/1) + - speedwm.color.selectedtitle: 0 ! Color the selected title (0/1) +!@ !! Cursor options - - - speedwm.cursor.warp: 1 !! Warp the cursor to the next focused window/monitor (0/1) - +!@ + - speedwm.cursor.warp: 1 ! Warp the cursor to the next focused window/monitor (0/1) +!@ !! Focus options - - - speedwm.focus.spawned: 0 !! Focus the newly spawned window or keep focus (0/1) - +!@ + - speedwm.focus.spawned: 0 ! Focus the newly spawned window or keep focus (0/1) +!@ !! Fullscreen options - - - speedwm.fullscreen.hidebar: 1 !! Hide the bar when a client is fullscreened (0/1) - - speedwm.fullscreen.lockfullscreen: 1 !! Lock the fullscreen (0/1) - - speedwm.fullscreen.movefullscreenmon: 0 !! Allow moving fullscreened windows to another monitor (0/1) - +!@ + - speedwm.fullscreen.hidebar: 1 ! Hide the bar when a client is fullscreened (0/1) + - speedwm.fullscreen.lockfullscreen: 1 ! Lock the fullscreen (0/1) + - speedwm.fullscreen.movefullscreenmon: 0 ! Allow moving fullscreened windows to another monitor (0/1) +!@ !! Gap options - - - speedwm.gaps.enable: 1 !! Enable gaps around the windows - - speedwm.gaps.sizeih: 10 !! Horizontal inner gap size () - - speedwm.gaps.sizeiv: 10 !! Vertical inner gap size () - - speedwm.gaps.sizeoh: 10 !! Horizontal outer gap size () - - speedwm.gaps.sizeov: 10 !! Vertical outer gap size () - - speedwm.gaps.smartgaps: 0 !! Enable different gap size when only one client is spawned (0/1) - - speedwm.gaps.smartgapsize: 0 !! Size of the gaps when only one client is spawned (0/1) - +!@ + - speedwm.gaps.enable: 1 ! Enable gaps around the windows + - speedwm.gaps.sizeih: 10 ! Horizontal inner gap size () + - speedwm.gaps.sizeiv: 10 ! Vertical inner gap size () + - speedwm.gaps.sizeoh: 10 ! Horizontal outer gap size () + - speedwm.gaps.sizeov: 10 ! Vertical outer gap size () + - speedwm.gaps.smartgaps: 0 ! Enable different gap size when only one client is spawned (0/1) + - speedwm.gaps.smartgapsize: 0 ! Size of the gaps when only one client is spawned (0/1) +!@ !! Icon options - - - speedwm.icon.size: 10 !! Size of the window icon in the taskbar () - - speedwm.icon.spacing: 5 !! Spacing between icon and text in the taskbar () - +!@ + - speedwm.icon.size: 10 ! Size of the window icon in the taskbar () + - speedwm.icon.spacing: 5 ! Spacing between icon and text in the taskbar () +!@ !! Layout options - +!@ !! Deck layout - - - speedwm.layout.deck.count: 0 !! Enable deck count in the deck layout (0/1) - +!@ + - speedwm.layout.deck.count: 0 ! Enable deck count in the deck layout (0/1) +!@ !! Format of the deck count where %d is the deck count (string) - speedwm.layout.deck.format: [%d] - +!@ !! Dynamic Grid layout - - - speedwm.layout.dgrid.forcevsplit: 1 !! Force vertical splits in the dynamic grid layout (0/1) - +!@ + - speedwm.layout.dgrid.forcevsplit: 1 ! Force vertical splits in the dynamic grid layout (0/1) +!@ !! Monocle layout - - - speedwm.layout.monocle.clientcount: 0 !! Enable client count in the monocle layout (0/1) - - speedwm.layout.monocle.count: 0 !! Enable focused client and number of total clients in the monocle layout (0/1) - +!@ + - speedwm.layout.monocle.clientcount: 0 ! Enable client count in the monocle layout (0/1) + - speedwm.layout.monocle.count: 0 ! Enable focused client and number of total clients in the monocle layout (0/1) +!@ !! Format of the monocle count where %d is the monocle count (string) - speedwm.layout.monocle.format: [%d/%d] - +!@ !! mfact options - - - speedwm.mfact: 0.50 !! Default mfact (0-1) - - speedwm.mfact.lowest: 0.05 !! Lowest possible mfact (0-1) - +!@ + - speedwm.mfact: 0.50 ! Default mfact (0-1) + - speedwm.mfact.lowest: 0.05 ! Lowest possible mfact (0-1) +!@ !! Mouse options - - - speedwm.mouse.clicktofocus: 0 !! Require clicking on a window to focus or focus when the cursor touches it (0/1) - - speedwm.mouse.mfact: 1 !! Enable adjusting mfact with your mouse (0/1) - - speedwm.mouse.cfact: 1 !! Enable adjusting cfact with your mouse (0/1) - - speedwm.mouse.mousepreview: 1 !! Enable previewing tags by hovering over them with your cursor (0/1) - +!@ + - speedwm.mouse.clicktofocus: 0 ! Require clicking on a window to focus or focus when the cursor touches it (0/1) + - speedwm.mouse.mfact: 1 ! Enable adjusting mfact with your mouse (0/1) + - speedwm.mouse.cfact: 1 ! Enable adjusting cfact with your mouse (0/1) + - speedwm.mouse.mousepreview: 1 ! Enable previewing tags by hovering over them with your cursor (0/1) +!@ !! Rule options - - - speedwm.rule.refresh: 1 !! Allow rules to be refreshed if a title/class changes (0/1) - +!@ + - speedwm.rule.refresh: 1 ! Allow rules to be refreshed if a title/class changes (0/1) +!@ !! Stack options - - - speedwm.stack.attachdirection: 3 !! Direction to attach windows in (0: Default, 1: Above, 2: Aside, 3: Below, 4: Bottom, 5: Top) - - speedwm.stack.centerfloating: 1 !! Center floating windows (0/1) - - speedwm.stack.i3mcount: 0 !! Enable i3 like nmaster/mastercount (0/1) - - speedwm.stack.mastercount: 1 !! Number of master clients in the master stack to start with (0/1) - - speedwm.stack.snap: 20 !! Snap pixel () - +!@ + - speedwm.stack.attachdirection: 3 ! Direction to attach windows in (0: Default, 1: Above, 2: Aside, 3: Below, 4: Bottom, 5: Top) + - speedwm.stack.centerfloating: 1 ! Center floating windows (0/1) + - speedwm.stack.i3mcount: 0 ! Enable i3 like nmaster/mastercount (0/1) + - speedwm.stack.mastercount: 1 ! Number of master clients in the master stack to start with (0/1) + - speedwm.stack.snap: 20 ! Snap pixel () +!@ !! Status options - +!@ !! Text to print when no status bar is running. Empty means nothing. - speedwm.status.defaultstatus: - +!@ !! Status bar script to run - speedwm.status.status: status - - - speedwm.status.statusallmons: 1 !! Display status text on all monitors (0/1) - +!@ + - speedwm.status.statusallmons: 1 ! Display status text on all monitors (0/1) +!@ !! Switcher options - - - speedwm.switcher.maxheight: 200 !! Max height of the switcher in pixels () - - speedwm.switcher.maxwidth: 600 !! Max width of the switcher in pixels () - - speedwm.switcher.menupositionv: 1 !! Menu position of the switcher vertically (0: Bottom, 1: Center, 2: Top) - - speedwm.switcher.menupositionh: 1 !! Menu position of the switcher horizontally (0: Left, 1: Center, 2: Right) - +!@ + - speedwm.switcher.maxheight: 200 ! Max height of the switcher in pixels () + - speedwm.switcher.maxwidth: 600 ! Max width of the switcher in pixels () + - speedwm.switcher.menupositionv: 1 ! Menu position of the switcher vertically (0: Bottom, 1: Center, 2: Top) + - speedwm.switcher.menupositionh: 1 ! Menu position of the switcher horizontally (0: Left, 1: Center, 2: Right) +!@ !! Systray options - - - speedwm.systray.padding: 2 !! Extra padding between status and systray (0/1) - - speedwm.systray.pinning: 0 !! Always show systray on the focused monitor or (0/) - - speedwm.systray.position: 0 !! Position of the systray horizontally (0: Right, 1: Left) - +!@ + - speedwm.systray.padding: 2 ! Extra padding between status and systray (0/1) + - speedwm.systray.pinning: 0 ! Always show systray on the focused monitor or (0/) + - speedwm.systray.position: 0 ! Position of the systray horizontally (0: Right, 1: Left) +!@ !! Tag options - - - speedwm.tag.pertag: 1 !! Allow tags to have their own values (0/1) - - speedwm.tag.preview: 1 !! Enable tag previews (0/1) - - speedwm.tag.preview.bar: 0 !! Include the bar in the tag preview (0/1) - - speedwm.tag.preview.paddingh: 0 !! Extra horizontal padding between the tag preview and the edge of the screen () - - speedwm.tag.preview.paddingv: 0 !! Extra vertical padding between the tag preview and the bar () - - speedwm.tag.preview.scale: 2 !! Amount to scale down the preview picture by () - - speedwm.tag.resetgaps: 1 !! Reset gaps when the tag has no clients (0/1) - - speedwm.tag.resetlayout: 1 !! Reset layout when the tag has no clients (0/1) - - speedwm.tag.resetmfact: 1 !! Reset mfact when the tag has no clients (0/1) - - speedwm.tag.start: 1 !! Start on a tag on startup (0/1) - - speedwm.tag.underline: 0 !! Draw an underline on the tags (0/1) - - speedwm.tag.underlineall: 0 !! Show underline on all tags or just the selected tags (0/1) - - speedwm.tag.underlinepad: 5 !! Horizontal padding between the underline and tag () - - speedwm.tag.underlinestroke: 2 !! Height of the underline in pixels () - - speedwm.tag.underlinevoffset: 0 !! How far above the bottom of the bar the line should appear () + - speedwm.tag.preview.paddingv: 0 ! Extra vertical padding between the tag preview and the bar () + - speedwm.tag.preview.scale: 2 ! Amount to scale down the preview picture by () + - speedwm.tag.resetgaps: 1 ! Reset gaps when the tag has no clients (0/1) + - speedwm.tag.resetlayout: 1 ! Reset layout when the tag has no clients (0/1) + - speedwm.tag.resetmfact: 1 ! Reset mfact when the tag has no clients (0/1) + - speedwm.tag.start: 1 ! Start on a tag on startup (0/1) + - speedwm.tag.underline: 0 ! Draw an underline on the tags (0/1) + - speedwm.tag.underlineall: 0 ! Show underline on all tags or just the selected tags (0/1) + - speedwm.tag.underlinepad: 5 ! Horizontal padding between the underline and tag () + - speedwm.tag.underlinestroke: 2 ! Height of the underline in pixels () + - speedwm.tag.underlinevoffset: 0 ! How far above the bottom of the bar the line should appear () - +!@ - speedwm.run.shell: /bin/sh - +!@ !! You have reached the bottom of the speedwm config file. !! It may be used as a reference for writing a config file from scratch, or simply copied somewhere and edited. !! Defaults here should more or less represent the settings in the speedwm source code. diff --git a/scripts/speedwm-help b/scripts/speedwm-help index a4b09e4..cc6599d 100755 --- a/scripts/speedwm-help +++ b/scripts/speedwm-help @@ -10,7 +10,7 @@ if [ "$NOCOLOR" != "true" ]; then fi # Set documentation directory -if [ "$DOCDIR" = "" ]; then +if [ "${DOCDIR}" = "" ]; then DOCDIR=/usr/share/speedwm fi @@ -34,22 +34,24 @@ case "$VIEWER" in "-o") VIEWER="cat" ;; esac -printf "${0}. Run '$0 -h' to see a list of arguments or to jump to a specific section.\n\ -$(cat \ -$DOCDIR/${PREFIX}doc-01 \ -$DOCDIR/${PREFIX}doc-02 \ -$DOCDIR/${PREFIX}doc-03 \ -$DOCDIR/${PREFIX}doc-04 \ -$DOCDIR/${PREFIX}keybinds \ -$DOCDIR/${PREFIX}dependencies \ -$DOCDIR/${PREFIX}doc-05 \ -$DOCDIR/${PREFIX}doc-06 \ -$DOCDIR/${PREFIX}doc-07 \ -$DOCDIR/${PREFIX}example.signal \ -$DOCDIR/${PREFIX}doc-08 \ -$DOCDIR/${PREFIX}doc-09 \ -$DOCDIR/${PREFIX}doc-10 \ -| grep -v "!!")" > /tmp/${PREFIX}doc +if [ -e "${DOCDIR}/${PREFIX}example.Xresources" ]; then + sed 's|\(!*\)!.*|\1|' ${DOCDIR}/${PREFIX}example.Xresources | grep -v "!" | grep speedwm > /tmp/example.Xresources +fi + +cat ${DOCDIR}/${PREFIX}doc-01 \ +${DOCDIR}/${PREFIX}doc-02 \ +${DOCDIR}/${PREFIX}doc-03 \ +${DOCDIR}/${PREFIX}doc-04 \ +${DOCDIR}/${PREFIX}keybinds \ +${DOCDIR}/${PREFIX}dependencies \ +${DOCDIR}/${PREFIX}doc-05 \ +${DOCDIR}/${PREFIX}doc-06 \ +/tmp/example.Xresources \ +${DOCDIR}/${PREFIX}doc-07 \ +${DOCDIR}/${PREFIX}example.signal \ +${DOCDIR}/${PREFIX}doc-08 \ +${DOCDIR}/${PREFIX}doc-09 \ +${DOCDIR}/${PREFIX}doc-10 | grep -v "!!" > /tmp/${PREFIX}doc case "$ARG1" in "-w") tail -n $(expr $(cat /tmp/${PREFIX}doc | wc -l) "-" 1) /tmp/${PREFIX}doc > ../readme ;; @@ -100,14 +102,14 @@ case "$ARG1" in printf "\nYou need to $0 -whtml first." ; exit 1 ;; "") $0 -h && exit 0 ;; "-h") printf "speedwm help\n\nNo arguments to view this list of arguments.\n-h | View this list of arguments.\n-a | View everything.\n-1 | What is speedwm?\n-2 | List of all keybinds\n-3 | List of all dependencies\n-4 | .Xresources/Pywal information.\n-5 | Signals information\n-6 | Switching run launcher\n-7 | Installation\n-8 | Layouts\n-9| Important information.\n-w | Write documentation to ../readme\n-wmd | Write documentation (Markdown)\n-whtml | Write documentation (HTML) using markdown-to-html.\n-whtml-wtemplate | Combine template 1, output of -whtml and template 2 (from docs/) to create a full HTML document.\n\nIf second argument is -o, the requested output will be sent to stdout.\n-o can be replaced with a text editor or reader of your choice (such as less, vim, emacs, etc.)\n"; exit 0 ;; -"-1") cat $DOCDIR/${PREFIX}doc-01 > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-2") cat $DOCDIR/${PREFIX}doc-04 $DOCDIR/${PREFIX}keybinds > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-3") cat $DOCDIR/${PREFIX}dependencies > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-4") cat $DOCDIR/${PREFIX}doc-06 $DOCDIR/${PREFIX}example.Xresources > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-5") cat $DOCDIR/${PREFIX}doc-07 $DOCDIR/${PREFIX}example.signal > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-6") cat $DOCDIR/${PREFIX}doc-08 > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-7") cat $DOCDIR/${PREFIX}doc-02 > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-8") cat $DOCDIR/${PREFIX}doc-03 > /tmp/stdout ; $VIEWER /tmp/stdout ;; -"-9") cat $DOCDIR/${PREFIX}doc-05 > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-1") cat ${DOCDIR}/${PREFIX}doc-01 > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-2") cat ${DOCDIR}/${PREFIX}doc-04 ${DOCDIR}/${PREFIX}keybinds > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-3") cat ${DOCDIR}/${PREFIX}dependencies > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-4") cat ${DOCDIR}/${PREFIX}doc-06 /tmp/example.Xresources > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-5") cat ${DOCDIR}/${PREFIX}doc-07 ${DOCDIR}/${PREFIX}example.signal > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-6") cat ${DOCDIR}/${PREFIX}doc-08 > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-7") cat ${DOCDIR}/${PREFIX}doc-02 > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-8") cat ${DOCDIR}/${PREFIX}doc-03 > /tmp/stdout ; $VIEWER /tmp/stdout ;; +"-9") cat ${DOCDIR}/${PREFIX}doc-05 > /tmp/stdout ; $VIEWER /tmp/stdout ;; "-a") cat /tmp/${PREFIX}doc > /tmp/stdout ; $VIEWER /tmp/stdout ;; esac diff --git a/scripts/speedwm_run b/scripts/speedwm_run index 9d98809..67a12fb 100755 --- a/scripts/speedwm_run +++ b/scripts/speedwm_run @@ -57,7 +57,7 @@ LOADCONFIG() { if [ -e "$HOME/.config/speedwm-de/speedwmrc" ]; then xrdb -merge -quiet $HOME/.config/speedwm-de/speedwmrc else - sed "s| - ||g" /usr/share/speedwm/example.Xresources > $HOME/.config/speedwm-de/speedwmrc && echo "Wrote example configuration file" + sed "s| - ||g; s|!@|g" /usr/share/speedwm/example.Xresources > $HOME/.config/speedwm-de/speedwmrc && echo "Wrote example configuration file" fi fi