merge LICENSE.md and README into sowm.1 and upd makefile

This commit is contained in:
randomuser 2020-12-12 22:10:35 -06:00
parent 20a278ad4f
commit b47ca1fbbe
4 changed files with 126 additions and 59 deletions

View File

@ -1,33 +0,0 @@
MIT/X Consortium License
- © 2019- Dylan Araps <dylan.araps@gmail.com>
- © 2006-2011 Anselm R Garbe <anselm@garbe.us>
- © 2007-2011 Peter Hartlich <sgkkr at hartlich dot com>
- © 2010-2011 Connor Lane Smith <cls@lubutu.com>
- © 2006-2009 Jukka Salmi <jukka at salmi dot ch>
- © 2007-2009 Premysl Hruby <dfenze at gmail dot com>
- © 2007-2009 Szabolcs Nagy <nszabolcs at gmail dot com>
- © 2007-2009 Christof Musik <christof at sendfax dot de>
- © 2009 Mate Nagy <mnagy at port70 dot net>
- © 2007-2008 Enno Gottox Boland <gottox at s01 dot de>
- © 2008 Martin Hurton <martin dot hurton at gmail dot com>
- © 2008 Neale Pickett <neale dot woozle dot org>
- © 2006-2007 Sander van Dijk <a dot h dot vandijk at gmail dot com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

View File

@ -14,11 +14,16 @@ sowm: sowm.c sowm.h config.h Makefile
install: all
install -Dm755 sowm $(DESTDIR)$(BINDIR)/sowm
mkdir -p $(DESTDIR)$(MANPREFIX)/man1
cp sowm.1 $(DESTDIR)$(MANPREFIX)/man1
chmod 644 $(DESTDIR)$(MANPREFIX)/man1/sowm.1
uninstall:
rm -f $(DESTDIR)$(BINDIR)/sowm
clean:
rm -f sowm *.o
nuke: clean
rm -f config.h
.PHONY: all install uninstall clean

26
README
View File

@ -1,26 +0,0 @@
sowm
====
a simple floating window manager
+----+
|KEYS|
+----+
Mod+[Enter] -> terminal
Mod+[d] -> dmenu
Alt+Tab -> cycle windows
Mod+[h,j,k,l] -> move current window
Mod+Shift+[h,j,k,l] -> resize current window
Mod+Alt+[h,j,k,l] -> halve current window
+--------+
|CONFIG.H|
+--------+
BORDER_COLOR -> color of the border
BORDER_WIDTH -> width of a border (in px)
+----+
|TODO|
+----+
change border color depending on focus

121
sowm.1 Normal file
View File

@ -0,0 +1,121 @@
.TH SOWM 1 sowm
.SH NAME
sowm -\ simple opinionated window manager
.SH DESCRIPTION
.B sowm
is a simple floating window manager using Xlib. It is usually
executed in conjunction with a
.B startx(1)
like utility.
.SH CONFIGURATION
.B sowm
is configured via editing source, usually in the form of a
config.def.h file or a config.h file.
Below is a list of configuration values and descriptions.
.TP
.B menu
program used to launch programs.
.TP
.B term
terminal emulator.
.TP
.B BORDER-COLOR
color used for drawing borders.
.TP
.B BORDER-WIDTH
width used for drawing borders.
.SH KEYBINDINGS
Below are the keybindings for this specific build of sowm. If
you are changing the defaults, please edit this section to
reflect your changes.
.TP
.B Mod-d
Execute program launcher. Usually dmenu by default. Launcher
configured via `menu` in config(.def).h.
.TP
.B Mod-Return
Execute terminal emulator. Usually st by default. Launcher
configured via `term` in config(.def).h.
.TP
.B Mod-q
Force-quit current selected window.
.TP
.B Mod-c
Center current selected window.
.TP
.B Mod-f
Fullscreen current selected window.
.TP
.B Mod-{h, j, k, l}
Move a window to the left, down, up, or right, respectively.
.TP
.B Mod-Shift-{h, j, k, l}
Resize a window to the left, down, up, or right, respectively.
.TP
.B Mod-Alt-{h, j, k, l}
Split a window to the left, down, up, or right, respectively.
.TP
.B Alt-Tab
Cycle through windows in current desktop.
.TP
.B Mod-{1, 2, 3, 4, 5, 6}
Change current desktop.
.TP
.B Mod-Shift-{1, 2, 3, 4, 5, 6}
Move current window to selected desktop.
.SH LEAGALESE
MIT/X Consortium License
- (c) 2019- Dylan Araps <dylan.araps@gmail.com>
- (c) 2006-2011 Anselm R Garbe <anselm@garbe.us>
- (c) 2007-2011 Peter Hartlich <sgkkr at hartlich dot com>
- (c) 2010-2011 Connor Lane Smith <cls@lubutu.com>
- (c) 2006-2009 Jukka Salmi <jukka at salmi dot ch>
- (c) 2007-2009 Premysl Hruby <dfenze at gmail dot com>
- (c) 2007-2009 Szabolcs Nagy <nszabolcs at gmail dot com>
- (c) 2007-2009 Christof Musik <christof at sendfax dot de>
- (c) 2009 Mate Nagy <mnagy at port70 dot net>
- (c) 2007-2008 Enno Gottox Boland <gottox at s01 dot de>
- (c) 2008 Martin Hurton <martin dot hurton at gmail dot com>
- (c) 2008 Neale Pickett <neale dot woozle dot org>
- (c) 2006-2007 Sander van Dijk <a dot h dot vandijk at gmail
dot com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following c
onditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.SH SEE ALSO
.BR startx (1)
.SH MAINTAINER
randomuser <randomuser at tilde dot club