add awesome-client.1 manpage and modify Makefile for this

This commit is contained in:
Julien Danjou 2007-12-02 15:43:40 +01:00
parent 17753110c8
commit 6f995ad3a5
2 changed files with 65 additions and 20 deletions

View File

@ -5,7 +5,7 @@ include config.mk
SRC = client.c draw.c event.c layout.c awesome.c tag.c util.c xutil.c config.c screen.c statusbar.c uicb.c window.c rules.c mouse.c awesome-client-common.c
OBJ = ${SRC:.c=.o} ${LAYOUTS:.c=.o}
DOCS = awesome.1.txt
DOCS = awesome.1.txt awesome-client.1.txt
SRCCLIENT = awesome-client.c awesome-client-common.c util.c
OBJCLIENT = ${SRCCLIENT:.c=.o}
@ -27,11 +27,11 @@ ${OBJ}: awesome.h config.mk
${OBJCLIENT}: config.mk
awesome.1.xml: $(DOCS)
asciidoc -d manpage -b docbook $< ${.ALLSRC}
awesome.1: ${DOCS:.txt=.xml}
xmlto man $< ${.ALLSRC}
man: ${DOCS}
asciidoc -d manpage -b docbook awesome.1.txt
asciidoc -d manpage -b docbook awesome-client.1.txt
xmlto man awesome.1.xml
xmlto man awesome-client.1.xml
awesome-client: ${OBJCLIENT}
@echo -e "\t(CC) ${OBJCLIENT} -o $@"
@ -43,7 +43,7 @@ awesome: ${OBJ}
clean:
@echo cleaning
@rm -f awesome awesome-client awesome.1 ${DOCS:.txt=.xml} ${OBJCLIENT} ${OBJ} awesome-${VERSION}.tar.gz
@rm -f awesome awesome-client ${DOCS:.txt=} ${DOCS:.txt=.xml} ${OBJCLIENT} ${OBJ} awesome-${VERSION}.tar.gz
@rm -rf doc
dist: clean
@ -51,7 +51,7 @@ dist: clean
@mkdir awesome-${VERSION}
@mkdir awesome-${VERSION}/layouts
@cp -fR STYLE LICENSE AUTHORS Makefile README awesomerc config.mk \
awesome.1 awesome.1.txt ${SRCCLIENT} ${SRCCLIENT:.c=.h} ${SRC} ${SRC:.c=.h} \
awesome-client.1.txt awesome.1.txt ${SRCCLIENT} ${SRCCLIENT:.c=.h} ${SRC} ${SRC:.c=.h} \
common.h awesome-${VERSION} || true
@cp -R ${LAYOUTS} ${LAYOUTS:.c=.h} awesome-${VERSION}/layouts
@tar -cf awesome-${VERSION}.tar awesome-${VERSION}
@ -64,26 +64,22 @@ strip: awesome awesome-client
install: strip install-unstrip
install-unstrip: awesome awesome-client awesome.1
install-unstrip: awesome awesome-client man
@echo installing executable file to ${DESTDIR}${PREFIX}/bin
@mkdir -p ${DESTDIR}${PREFIX}/bin
@cp -f awesome awesome-client ${DESTDIR}${PREFIX}/bin
@chmod 755 ${DESTDIR}${PREFIX}/bin/awesome
@chmod 755 ${DESTDIR}${PREFIX}/bin/awesome-client
@install -d ${DESTDIR}${PREFIX}/bin
@install -m 755 awesome awesome-client ${DESTDIR}${PREFIX}/bin
@echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
@mkdir -p ${DESTDIR}${MANPREFIX}/man1
@sed "s/VERSION/${VERSION}/g" < awesome.1 > ${DESTDIR}${MANPREFIX}/man1/awesome.1
@chmod 644 ${DESTDIR}${MANPREFIX}/man1/awesome.1
@install -d ${DESTDIR}${MANPREFIX}/man1
@install -m 644 ${DOCS:.txt=} ${DESTDIR}${MANPREFIX}/man1
uninstall:
@echo removing executable file from ${DESTDIR}${PREFIX}/bin
@rm -f ${DESTDIR}${PREFIX}/bin/awesome
@rm -f ${DESTDIR}${PREFIX}/bin/awesome-client
@rm ${DESTDIR}${PREFIX}/bin/awesome ${DESTDIR}${PREFIX}/bin/awesome-client
@echo removing manual page from ${DESTDIR}${MANPREFIX}/man1
@rm -f ${DESTDIR}${MANPREFIX}/man1/awesome.1
@rm ${DESTDIR}${MANPREFIX}/man1/awesome.1 ${DESTDIR}${MANPREFIX}/man1/awesome-client.1
doc:
@echo generating documentation
@doxygen awesome.doxygen
.PHONY: all options clean dist install uninstall doc
.PHONY: all options clean dist install uninstall doc man

49
awesome-client.1.txt Normal file
View File

@ -0,0 +1,49 @@
awesome-client(1)
=================
NAME
----
awesome-client - awesome window manager command line interface
SYNOPSIS
--------
awesome-client
DESCRIPTION
-----------
awesome-client is the command line interface to awesome. It communicates with awesome
via a socket located in the users's HOME directory.
USAGE
-----
To determine which socket is to be used, it read the DISPLAY environment variable.
awesome-client read commands from standart input. The command format is:
screen_number command argument
For example, to change statusbar text on screen 0, you can do the following:
echo 0 setstatustext Hello, world | awesome-client
To view tag number 3 on screen 1:
echo 1 tag_view 3 | awesome-client
To zoom focused window on screen 0:
echo 0 client_zoom | awesome-client
SEE ALSO
--------
awesome(1)
AUTHORS
-------
Julien Danjou <julien@danjou.info>
WWW
---
http://awesome.naquadah.org