From 2016aeaa085bc37b4c5d01d6bcf12cdfd2235ca1 Mon Sep 17 00:00:00 2001 From: stkhan Date: Mon, 23 May 2022 21:51:23 +0000 Subject: Added man file --- Makefile | 2 ++ sarc.1 | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 sarc.1 diff --git a/Makefile b/Makefile index beba218..e0cf7c6 100644 --- a/Makefile +++ b/Makefile @@ -45,6 +45,8 @@ install: make install -C wmname install scripts/sarc.sh /usr/local/bin install scripts/fehbg /usr/local/bin + mkdir -p $(PREFIX)/share/doc/sarc + cp sarc.1 $(MANPREFIX)/man1/ @echo clean: make clean -C $(DWM) diff --git a/sarc.1 b/sarc.1 new file mode 100644 index 0000000..e99b4ab --- /dev/null +++ b/sarc.1 @@ -0,0 +1,102 @@ +.TH SARC 1 +.SH NAME +.SH SYNOPSIS +.B dwm, dmenu, st, nsxiv, surf, tabbed, etc +.SH DESCRIPTION +sarc is a collection of tools that form a desktop. It includes dwm, sarc, +dmenu, farbfeld, dwmblocks, nsxiv, scroll, slock, sent, surf, tabbed, and wmname. + +.P +It also features themes, which you can choose on compilation. All of these programs +have been patched to fit my needs. + +.SH KEYBINDS +Each individual program has its own keybinds, however they are not kept to date +in the manuals. + +.TP +.B Alt+F1 +decreases brightness +.TP +.B Alt+F2 +increases brightness +.TP +.B Alt+F3 +launches ranger in st +.TP +.B Alt+F4 +launches galculator +.TP +.B Alt+F5 +launches ncmpcpp-ueberzug +.TP +.B Alt+F6 +plays previous track via mpc +.TP +.B Alt+F7 +plays/pauses music via mpc +.TP +.B Alt+F8 +plays next track via mpc +.TP +.B Alt+F9 +mutes/unmutes audio output +.TP +.B Shift+Alt+F9 +mutes/unmutes audio input +.TP +.B Alt+F10 +decreases volume +.TP +.B Alt+F11 +increases volume +.TP +.B Alt+F12 +launches power menu +.TP +.B Alt+w +shows weather from wttr.in +.TP +.B Alt+e +launches emoji menu +.TP +.B Alt+t +launches vim in ~/.config/todo +.TP +.B Shift+Alt+L +locks the screen with slock +.TP +.B Alt+s +launches dmenu prompt to search DuckDuckGo +.TP +.B Alt+g +launches dmenu prompt to go to website +.TP +.B Shift+Alt+F +launches surf + + +.SH COMPILATION +First gather the entire source code, and enter the directory. It is not recommended +to compile each program individually, as most will require files generated by +the theme selection. +.P +First clean the directory: + +.B make cleanp +.P +Then choose a theme: + +.B make config +.P + +After choosing a theme, you can start compiling: +.P + +.B make +.P + +Finally install it: +.P + +.B make install -- cgit v1.2.3