From b31254837d79a08936cdbfb6859d87149d86b001 Mon Sep 17 00:00:00 2001 From: a Date: Thu, 15 Jun 2023 11:10:22 -0500 Subject: [PATCH] update doc --- Makefile | 24 ++++++++++++------------ doc/tspwm.1 | 40 +++++++++++++++++++++------------------- doc/tspwm.1.asciidoc | 42 +++++++++++++++++++++--------------------- 3 files changed, 54 insertions(+), 52 deletions(-) diff --git a/Makefile b/Makefile index 1bda221..5e113bc 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,7 @@ VERSION := $(shell $(VERCMD) || cat VERSION) PREFIX ?= /usr/local BINPREFIX ?= $(PREFIX)/bin MANPREFIX ?= $(PREFIX)/share/man -DOCPREFIX ?= $(PREFIX)/share/doc/bspwm +DOCPREFIX ?= $(PREFIX)/share/doc/tspwm BASHCPL ?= $(PREFIX)/share/bash-completion/completions FISHCPL ?= $(PREFIX)/share/fish/vendor_completions.d ZSHCPL ?= $(PREFIX)/share/zsh/site-functions @@ -15,14 +15,14 @@ ZSHCPL ?= $(PREFIX)/share/zsh/site-functions MD_DOCS = README.md doc/CHANGELOG.md doc/CONTRIBUTING.md doc/INSTALL.md doc/MISC.md doc/TODO.md XSESSIONS ?= $(PREFIX)/share/xsessions -all: bspwm bspc +all: tspwm tspc VPATH=src -bspwm: cmd/bspwm src/**/* +tspwm: cmd/bspwm src/**/* go build -o tspwm ./cmd/bspwm -bspc: cmd/bspc src/**/* +tspc: cmd/bspc src/**/* go build -o tspc ./cmd/bspc xephyr: @@ -30,10 +30,10 @@ xephyr: install: mkdir -p "$(DESTDIR)$(BINPREFIX)" -# cp -pf tspwm "$(DESTDIR)$(BINPREFIX)" + cp -pf tspwm "$(DESTDIR)$(BINPREFIX)" cp -pf tspc "$(DESTDIR)$(BINPREFIX)" mkdir -p "$(DESTDIR)$(MANPREFIX)"/man1 -# cp -p doc/tspwm.1 "$(DESTDIR)$(MANPREFIX)"/man1 + cp -p doc/tspwm.1 "$(DESTDIR)$(MANPREFIX)"/man1 cp -Pp doc/tspc.1 "$(DESTDIR)$(MANPREFIX)"/man1 mkdir -p "$(DESTDIR)$(BASHCPL)" cp -p contrib/bash_completion "$(DESTDIR)$(BASHCPL)"/tspc @@ -41,12 +41,12 @@ install: cp -p contrib/fish_completion "$(DESTDIR)$(FISHCPL)"/tspc.fish mkdir -p "$(DESTDIR)$(ZSHCPL)" cp -p contrib/zsh_completion "$(DESTDIR)$(ZSHCPL)"/_tspc - mkdir -p "$(DESTDIR)$(DOCPREFIX)" - cp -p $(MD_DOCS) "$(DESTDIR)$(DOCPREFIX)" - mkdir -p "$(DESTDIR)$(DOCPREFIX)"/examples - cp -pr examples/* "$(DESTDIR)$(DOCPREFIX)"/examples - mkdir -p "$(DESTDIR)$(XSESSIONS)" -# cp -p contrib/freedesktop/bspwm.desktop "$(DESTDIR)$(XSESSIONS)" + #mkdir -p "$(DESTDIR)$(DOCPREFIX)" + #cp -p $(MD_DOCS) "$(DESTDIR)$(DOCPREFIX)" + #mkdir -p "$(DESTDIR)$(DOCPREFIX)"/examples + #cp -pr examples/* "$(DESTDIR)$(DOCPREFIX)"/examples + #mkdir -p "$(DESTDIR)$(XSESSIONS)" +# cp -p contrib/freedesktop/tspwm.desktop "$(DESTDIR)$(XSESSIONS)" uninstall: rm -f "$(DESTDIR)$(BINPREFIX)"/tspwm diff --git a/doc/tspwm.1 b/doc/tspwm.1 index f034e8c..ea23799 100644 --- a/doc/tspwm.1 +++ b/doc/tspwm.1 @@ -1,13 +1,13 @@ '\" t -.\" Title: bspwm +.\" Title: tspwm .\" Author: [see the "Author" section] .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 04/05/2023 -.\" Manual: Bspwm Manual -.\" Source: Bspwm 0.9.10-49-gc58c67a +.\" Manual: Tspwm Manual +.\" Source: Tspwm 0.9.10-49-gc58c67a .\" Language: English .\" -.TH "BSPWM" "1" "04/05/2023" "Bspwm 0\&.9\&.10\-49\-gc58c67a" "Bspwm Manual" +.TH "TSPWM" "1" "04/05/2023" "Tspwm 0\&.9\&.10\-49\-gc58c67a" "Tspwm Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,21 +28,23 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -bspwm \- Binary space partitioning window manager +tspwm \- Binary space partitioning window manager .SH "SYNOPSIS" .sp -\fBbspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR] +\fBtspwm\fR [\fB\-h\fR|\fB\-v\fR|\fB\-c\fR \fICONFIG_PATH\fR] .sp -\fBbspc \-\-print\-socket\-path\fR +\fBtspc \-\-print\-socket\-path\fR .sp -\fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR +\fBtspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR .sp -\fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] +\fBtspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] .SH "DESCRIPTION" .sp -\fBbspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&. +\fBtspwm\fR is a tiling window manager that represents windows as the leaves of a full binary tree\&. .sp -It is controlled and configured via \fBbspc\fR\&. +It is controlled and configured via \fBtspc\fR\&. +.sp +It is a rewrite of github.com/baskerville/bspwm, but in go. .SH "OPTIONS" .PP \fB\-h\fR @@ -63,7 +65,7 @@ Use the given configuration file\&. \fB\-\-print\-socket\-path\fR .RS 4 Print the -\fBbspwm\fR +\fBtspwm\fR socket path and exit\&. .RE .SH "COMMON DEFINITIONS" @@ -1134,7 +1136,7 @@ Print a path to a FIFO from which events can be read and return\&. \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR .RS 4 Stop the corresponding -\fBbspc\fR +\fBtspc\fR process after having received \fICOUNT\fR events\&. @@ -1157,7 +1159,7 @@ Quit with an optional exit status\&. .RE .SH "EXIT CODES" .sp -If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&. +If the server can\(cqt handle a message, \fBtspc\fR will return with a non\-zero exit code\&. .SH "SETTINGS" .sp Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. @@ -1579,7 +1581,7 @@ The layer of a window changed\&. A pointer action occurred\&. .RE .sp -Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&. +Please note that \fBtspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&. .SH "REPORT FORMAT" .sp Each report event message is composed of items separated by colons\&. @@ -1642,13 +1644,13 @@ Active flags of the focused node of a focused desktop\&. .RE .SH "ENVIRONMENT VARIABLES" .PP -\fIBSPWM_SOCKET\fR +\fItspwm_SOCKET\fR .RS 4 The path of the socket used for the communication between -\fBbspc\fR +\fBtspc\fR and -\fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used: -\fI/tmp/bspwm__\-socket\fR\&. +\fBtspwm\fR\&. If it isn\(cqt defined, then the following path is used: +\fI/tmp/tspwm__\-socket\fR\&. .RE .SH "CONTRIBUTORS" .sp diff --git a/doc/tspwm.1.asciidoc b/doc/tspwm.1.asciidoc index 2834978..2dfd350 100644 --- a/doc/tspwm.1.asciidoc +++ b/doc/tspwm.1.asciidoc @@ -1,32 +1,36 @@ -:man source: Bspwm +:man source: tspwm :man version: {revnumber} -:man manual: Bspwm Manual +:man manual: tspwm Manual -bspwm(1) +tspwm(1) ======== Name ---- -bspwm - Binary space partitioning window manager +tspwm - Binary space partitioning window manager Synopsis -------- -*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH'] +*tspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH'] -*bspc --print-socket-path* +*tspc --print-socket-path* -*bspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS' +*tspc* 'DOMAIN' ['SELECTOR'] 'COMMANDS' -*bspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS'] +*tspc* 'COMMAND' ['OPTIONS'] ['ARGUMENTS'] Description ----------- -*bspwm* is a tiling window manager that represents windows as the leaves of a full binary tree. +*tspwm* is a tiling window manager that represents windows as the leaves of a full binary tree. -It is controlled and configured via *bspc*. +It is controlled and configured via *tspc*. + +it is a rewrite of *bspwm* in pure go. + +bspwm can be found at *git@github.com:baskerville/bspwm.git*. Options @@ -42,7 +46,7 @@ Options Use the given configuration file. *--print-socket-path*:: - Print the *bspwm* socket path and exit. + Print the *tspwm* socket path and exit. Common Definitions ------------------ @@ -666,7 +670,7 @@ Options Print a path to a FIFO from which events can be read and return. *-c*, *--count* 'COUNT':: - Stop the corresponding *bspc* process after having received 'COUNT' events. + Stop the corresponding *tspc* process after having received 'COUNT' events. Quit ~~~~ @@ -680,7 +684,7 @@ quit []:: Exit Codes ---------- -If the server can't handle a message, *bspc* will return with a non-zero exit code. +If the server can't handle a message, *tspc* will return with a non-zero exit code. Settings -------- @@ -923,7 +927,7 @@ Events 'pointer_action move|resize_corner|resize_side begin|end':: A pointer action occurred. -Please note that *bspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received. +Please note that *tspwm* initializes monitors before it reads messages on its socket, therefore the initial monitor events can't be received. Report Format ------------- @@ -968,18 +972,14 @@ Each item has the form '' where '' is the first character of Environment Variables --------------------- -'BSPWM_SOCKET':: - The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm__-socket'. +'tspwm_SOCKET':: + The path of the socket used for the communication between *tspc* and *tspwm*. If it isn't defined, then the following path is used: '/tmp/tspwm__-socket'. Contributors ------------ -* Steven Allen -* Thomas Adam -* Ivan Kanakarakis - Author ------ -Bastien Dejean +a