t
/
wm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc

This commit is contained in:
a 2023-06-15 11:10:22 -05:00
parent 921917d488
commit b31254837d
3 changed files with 54 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Makefile
View File

@ -7,7 +7,7 @@ VERSION := $(shell $(VERCMD) || cat VERSION)
PREFIX ?= /usr/local PREFIX ?= /usr/local
BINPREFIX ?= $(PREFIX)/bin BINPREFIX ?= $(PREFIX)/bin
MANPREFIX ?= $(PREFIX)/share/man MANPREFIX ?= $(PREFIX)/share/man
DOCPREFIX ?= $(PREFIX)/share/doc/bspwm DOCPREFIX ?= $(PREFIX)/share/doc/tspwm
BASHCPL ?= $(PREFIX)/share/bash-completion/completions BASHCPL ?= $(PREFIX)/share/bash-completion/completions
FISHCPL ?= $(PREFIX)/share/fish/vendor_completions.d FISHCPL ?= $(PREFIX)/share/fish/vendor_completions.d
ZSHCPL ?= $(PREFIX)/share/zsh/site-functions 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 MD_DOCS = README.md doc/CHANGELOG.md doc/CONTRIBUTING.md doc/INSTALL.md doc/MISC.md doc/TODO.md
XSESSIONS ?= $(PREFIX)/share/xsessions XSESSIONS ?= $(PREFIX)/share/xsessions
all: bspwm bspc all: tspwm tspc
VPATH=src VPATH=src
bspwm: cmd/bspwm src/**/* tspwm: cmd/bspwm src/**/*
go build -o tspwm ./cmd/bspwm go build -o tspwm ./cmd/bspwm
bspc: cmd/bspc src/**/* tspc: cmd/bspc src/**/*
go build -o tspc ./cmd/bspc go build -o tspc ./cmd/bspc
xephyr: xephyr:
@ -30,10 +30,10 @@ xephyr:
install: install:
mkdir -p "$(DESTDIR)$(BINPREFIX)" mkdir -p "$(DESTDIR)$(BINPREFIX)"
# cp -pf tspwm "$(DESTDIR)$(BINPREFIX)" cp -pf tspwm "$(DESTDIR)$(BINPREFIX)"
cp -pf tspc "$(DESTDIR)$(BINPREFIX)" cp -pf tspc "$(DESTDIR)$(BINPREFIX)"
mkdir -p "$(DESTDIR)$(MANPREFIX)"/man1 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 cp -Pp doc/tspc.1 "$(DESTDIR)$(MANPREFIX)"/man1
mkdir -p "$(DESTDIR)$(BASHCPL)" mkdir -p "$(DESTDIR)$(BASHCPL)"
cp -p contrib/bash_completion "$(DESTDIR)$(BASHCPL)"/tspc cp -p contrib/bash_completion "$(DESTDIR)$(BASHCPL)"/tspc
@ -41,12 +41,12 @@ install:
cp -p contrib/fish_completion "$(DESTDIR)$(FISHCPL)"/tspc.fish cp -p contrib/fish_completion "$(DESTDIR)$(FISHCPL)"/tspc.fish
mkdir -p "$(DESTDIR)$(ZSHCPL)" mkdir -p "$(DESTDIR)$(ZSHCPL)"
cp -p contrib/zsh_completion "$(DESTDIR)$(ZSHCPL)"/_tspc cp -p contrib/zsh_completion "$(DESTDIR)$(ZSHCPL)"/_tspc
mkdir -p "$(DESTDIR)$(DOCPREFIX)" #mkdir -p "$(DESTDIR)$(DOCPREFIX)"
cp -p $(MD_DOCS) "$(DESTDIR)$(DOCPREFIX)" #cp -p $(MD_DOCS) "$(DESTDIR)$(DOCPREFIX)"
mkdir -p "$(DESTDIR)$(DOCPREFIX)"/examples #mkdir -p "$(DESTDIR)$(DOCPREFIX)"/examples
cp -pr examples/* "$(DESTDIR)$(DOCPREFIX)"/examples #cp -pr examples/* "$(DESTDIR)$(DOCPREFIX)"/examples
mkdir -p "$(DESTDIR)$(XSESSIONS)" #mkdir -p "$(DESTDIR)$(XSESSIONS)"
# cp -p contrib/freedesktop/bspwm.desktop "$(DESTDIR)$(XSESSIONS)" # cp -p contrib/freedesktop/tspwm.desktop "$(DESTDIR)$(XSESSIONS)"
uninstall: uninstall:
rm -f "$(DESTDIR)$(BINPREFIX)"/tspwm rm -f "$(DESTDIR)$(BINPREFIX)"/tspwm

40
doc/tspwm.1
View File

@ -1,13 +1,13 @@
'\" t '\" t
.\" Title: bspwm .\" Title: tspwm
.\" Author: [see the "Author" section] .\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 04/05/2023 .\" Date: 04/05/2023
.\" Manual: Bspwm Manual .\" Manual: Tspwm Manual
.\" Source: Bspwm 0.9.10-49-gc58c67a .\" Source: Tspwm 0.9.10-49-gc58c67a
.\" Language: English .\" 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 .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -28,21 +28,23 @@
.\" * MAIN CONTENT STARTS HERE * .\" * MAIN CONTENT STARTS HERE *
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.SH "NAME" .SH "NAME"
bspwm \- Binary space partitioning window manager tspwm \- Binary space partitioning window manager
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .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 .sp
\fBbspc \-\-print\-socket\-path\fR \fBtspc \-\-print\-socket\-path\fR
.sp .sp
\fBbspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR \fBtspc\fR \fIDOMAIN\fR [\fISELECTOR\fR] \fICOMMANDS\fR
.sp .sp
\fBbspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR] \fBtspc\fR \fICOMMAND\fR [\fIOPTIONS\fR] [\fIARGUMENTS\fR]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .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 .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" .SH "OPTIONS"
.PP .PP
\fB\-h\fR \fB\-h\fR
@ -63,7 +65,7 @@ Use the given configuration file\&.
\fB\-\-print\-socket\-path\fR \fB\-\-print\-socket\-path\fR
.RS 4 .RS 4
Print the Print the
\fBbspwm\fR \fBtspwm\fR
socket path and exit\&. socket path and exit\&.
.RE .RE
.SH "COMMON DEFINITIONS" .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 \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR
.RS 4 .RS 4
Stop the corresponding Stop the corresponding
\fBbspc\fR \fBtspc\fR
process after having received process after having received
\fICOUNT\fR \fICOUNT\fR
events\&. events\&.
@ -1157,7 +1159,7 @@ Quit with an optional exit status\&.
.RE .RE
.SH "EXIT CODES" .SH "EXIT CODES"
.sp .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" .SH "SETTINGS"
.sp .sp
Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&. 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\&. A pointer action occurred\&.
.RE .RE
.sp .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" .SH "REPORT FORMAT"
.sp .sp
Each report event message is composed of items separated by colons\&. 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 .RE
.SH "ENVIRONMENT VARIABLES" .SH "ENVIRONMENT VARIABLES"
.PP .PP
\fIBSPWM_SOCKET\fR \fItspwm_SOCKET\fR
.RS 4 .RS 4
The path of the socket used for the communication between The path of the socket used for the communication between
\fBbspc\fR \fBtspc\fR
and and
\fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used: \fBtspwm\fR\&. If it isn\(cqt defined, then the following path is used:
\fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&. \fI/tmp/tspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
.RE .RE
.SH "CONTRIBUTORS" .SH "CONTRIBUTORS"
.sp .sp

42
doc/tspwm.1.asciidoc
View File

@ -1,32 +1,36 @@
:man source: Bspwm :man source: tspwm
:man version: {revnumber} :man version: {revnumber}
:man manual: Bspwm Manual :man manual: tspwm Manual
bspwm(1) tspwm(1)
======== ========
Name Name
---- ----
bspwm - Binary space partitioning window manager tspwm - Binary space partitioning window manager
Synopsis 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 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 Options
@ -42,7 +46,7 @@ Options
Use the given configuration file. Use the given configuration file.
*--print-socket-path*:: *--print-socket-path*::
Print the *bspwm* socket path and exit. Print the *tspwm* socket path and exit.
Common Definitions Common Definitions
------------------ ------------------
@ -666,7 +670,7 @@ Options
Print a path to a FIFO from which events can be read and return. Print a path to a FIFO from which events can be read and return.
*-c*, *--count* 'COUNT':: *-c*, *--count* 'COUNT'::
Stop the corresponding *bspc* process after having received 'COUNT' events. Stop the corresponding *tspc* process after having received 'COUNT' events.
Quit Quit
~~~~ ~~~~
@ -680,7 +684,7 @@ quit [<status>]::
Exit Codes 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 Settings
-------- --------
@ -923,7 +927,7 @@ Events
'pointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end':: 'pointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end'::
A pointer action occurred. 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 Report Format
------------- -------------
@ -968,18 +972,14 @@ Each item has the form '<type><value>' where '<type>' is the first character of
Environment Variables Environment Variables
--------------------- ---------------------
'BSPWM_SOCKET':: 'tspwm_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<host_name>_<display_number>_<screen_number>-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<host_name>_<display_number>_<screen_number>-socket'.
Contributors Contributors
------------ ------------
* Steven Allen <steven at stebalien.com>
* Thomas Adam <thomas at xteddy.org>
* Ivan Kanakarakis <ivan.kanak at gmail.com>
Author Author
------ ------
Bastien Dejean <nihilhill at gmail.com> a <a at tuxpa.in>