Fixing README and the build environment.
This commit is contained in:
parent
e43381833b
commit
2b985444ad
3 changed files with 56 additions and 40 deletions
23
Makefile
23
Makefile
|
@ -4,7 +4,6 @@
|
||||||
include config.mk
|
include config.mk
|
||||||
|
|
||||||
SRC = svkbd.c
|
SRC = svkbd.c
|
||||||
LAYOUTS = en de arrows
|
|
||||||
|
|
||||||
all: options svkbd-en
|
all: options svkbd-en
|
||||||
|
|
||||||
|
@ -13,7 +12,6 @@ options:
|
||||||
@echo "CFLAGS = ${CFLAGS}"
|
@echo "CFLAGS = ${CFLAGS}"
|
||||||
@echo "LDFLAGS = ${LDFLAGS}"
|
@echo "LDFLAGS = ${LDFLAGS}"
|
||||||
@echo "CC = ${CC}"
|
@echo "CC = ${CC}"
|
||||||
@echo "LAYOUT = ${LAYOUT}"
|
|
||||||
|
|
||||||
config.h: config.mk
|
config.h: config.mk
|
||||||
@echo creating $@ from config.def.h
|
@echo creating $@ from config.def.h
|
||||||
|
@ -27,9 +25,12 @@ svkbd-%: layout.%.h config.h ${SRC}
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
@echo cleaning
|
@echo cleaning
|
||||||
@for i in ${LAYOUTS}; \
|
@for i in svkbd-*; \
|
||||||
do \
|
do \
|
||||||
rm -f svkbd-$$i 2> /dev/null; \
|
if [ -x $$i ]; \
|
||||||
|
then \
|
||||||
|
rm -f $$i 2> /dev/null; \
|
||||||
|
fi \
|
||||||
done; true
|
done; true
|
||||||
@rm -f ${OBJ} svkbd-${VERSION}.tar.gz 2> /dev/null; true
|
@rm -f ${OBJ} svkbd-${VERSION}.tar.gz 2> /dev/null; true
|
||||||
|
|
||||||
|
@ -38,9 +39,9 @@ dist: clean
|
||||||
@mkdir -p svkbd-${VERSION}
|
@mkdir -p svkbd-${VERSION}
|
||||||
@cp LICENSE Makefile README config.def.h config.mk \
|
@cp LICENSE Makefile README config.def.h config.mk \
|
||||||
${SRC} svkbd-${VERSION}
|
${SRC} svkbd-${VERSION}
|
||||||
@for i in ${LAYOUTS}; \
|
@for i in layout.*.h; \
|
||||||
do \
|
do \
|
||||||
cp layout.$$i.h svkbd-${VERSION}; \
|
cp $$i svkbd-${VERSION}; \
|
||||||
done
|
done
|
||||||
@tar -cf svkbd-${VERSION}.tar svkbd-${VERSION}
|
@tar -cf svkbd-${VERSION}.tar svkbd-${VERSION}
|
||||||
@gzip svkbd-${VERSION}.tar
|
@gzip svkbd-${VERSION}.tar
|
||||||
|
@ -49,13 +50,13 @@ dist: clean
|
||||||
install: all
|
install: all
|
||||||
@echo installing executable files to ${DESTDIR}${PREFIX}/bin
|
@echo installing executable files to ${DESTDIR}${PREFIX}/bin
|
||||||
@mkdir -p ${DESTDIR}${PREFIX}/bin
|
@mkdir -p ${DESTDIR}${PREFIX}/bin
|
||||||
@for i in ${LAYOUTS}; \
|
@for i in svkbd-*; \
|
||||||
do \
|
do \
|
||||||
if [ -e svkbd-$$i ]; \
|
if [ -x $$i ]; \
|
||||||
then \
|
then \
|
||||||
echo CP svkbd-$$i; \
|
echo CP $$i; \
|
||||||
cp svkbd-$$i ${DESTDIR}${PREFIX}/bin; \
|
cp $$i ${DESTDIR}${PREFIX}/bin; \
|
||||||
chmod 755 ${DESTDIR}${PREFIX}/bin/svkbd-$$i; \
|
chmod 755 ${DESTDIR}${PREFIX}/bin/$$i; \
|
||||||
fi \
|
fi \
|
||||||
done
|
done
|
||||||
# @echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
|
# @echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
|
||||||
|
|
29
README
29
README
|
@ -1,29 +0,0 @@
|
||||||
svkbd - simple virtual keyboard
|
|
||||||
===============================
|
|
||||||
svkbd is a small X client application usefull for emulating a keyboard
|
|
||||||
on the screen.
|
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
In order to build svkbd you need the Xlib and XTest header files.
|
|
||||||
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
Edit config.mk to match your local setup (svkbd is installed into
|
|
||||||
the /usr/local namespace by default).
|
|
||||||
|
|
||||||
Afterwards enter make svkbd.<LAYOUT> to compile svkbd, where <LAYOUT> can
|
|
||||||
be one of de, en, arrows. "make" defaults to svkbd.en, which is copied to
|
|
||||||
svkbd
|
|
||||||
|
|
||||||
Configuration
|
|
||||||
-------------
|
|
||||||
The configuration of svkbd is done by creating a custom config.h
|
|
||||||
and (re)compiling the source code.
|
|
||||||
|
|
||||||
You can define your own keyboard layouts by creating layout.<IDENTIFIER>.h.
|
|
||||||
Afterwards, build your customized version by executing
|
|
||||||
|
|
||||||
make svkbd.<IDENTIFIER>
|
|
44
README.md
Normal file
44
README.md
Normal file
|
@ -0,0 +1,44 @@
|
||||||
|
SVKBD
|
||||||
|
=====
|
||||||
|
This is a simple virtual keyboard, intended to be used in environments,
|
||||||
|
where no keyboard is available.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
% make
|
||||||
|
% make install
|
||||||
|
|
||||||
|
This will create by default `svkbd-en`, which is svkbd using an English
|
||||||
|
keyboard layout. You can create svkbd for additional layouts by doing:
|
||||||
|
|
||||||
|
% make svkbd-$layout
|
||||||
|
|
||||||
|
This will take the file `layout.$layout.h` and create `svkbd-$layout`.
|
||||||
|
`make install` will then pick up the new file and install it accordingly.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
% svkbd-en
|
||||||
|
|
||||||
|
This will open svkbd at the bottom of the screen, showing the default
|
||||||
|
English layout.
|
||||||
|
|
||||||
|
% svkbd-en -d
|
||||||
|
|
||||||
|
This tells svkbd-en to announce itself being a dock window, which then
|
||||||
|
is managed differently between different window managers. If using dwm
|
||||||
|
and the dock patch, then this will make svkbd being managed by dwm and
|
||||||
|
some space of the screen being reserved for it.
|
||||||
|
|
||||||
|
% svkbd-en -g 400x200+1+1
|
||||||
|
|
||||||
|
This will start svkbd-en with a size of 400x200 and at the upper left
|
||||||
|
window corner.
|
||||||
|
|
||||||
|
Repository
|
||||||
|
----------
|
||||||
|
|
||||||
|
hg clone http://hg.suckless.org/svkbd
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue