Skip to content

Commit

Permalink
Add manual page for the gtk3-nocsd wrapper
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-se committed Oct 15, 2015
1 parent 3bfa40f commit c7db1f7
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ LDLIBS = -ldl
prefix ?= /usr/local
libdir ?= $(prefix)/lib
bindir ?= $(prefix)/bin
mandir ?= $(prefix)/share/man

all: libgtk3-nocsd.so.0 gtk3-nocsd

Expand All @@ -22,3 +23,4 @@ gtk3-nocsd: gtk3-nocsd.in
install:
install -D -m 0644 libgtk3-nocsd.so.0 $(DESTDIR)$(libdir)/libgtk3-nocsd.so.0
install -D -m 0755 gtk3-nocsd $(DESTDIR)$(bindir)/gtk3-nocsd
install -D -m 0644 gtk3-nocsd.1 $(DESTDIR)$(mandir)/man1/gtk3-nocsd.1
43 changes: 43 additions & 0 deletions gtk3-nocsd.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.TH gtk3-nocsd 1 "October 2015"
.SH NAME
gtk3-nocsd \- transparently disable Gtk+3 client side decorations (CSD)
.SH SYNOPSIS
.B gtk3-nocsd
\fIcommand\fR [ \fIcommand arguments\fR ... ]
.TP
.B symlinked-command
[ \fIcommand arguments\fR ... ]
.SH DESCRIPTION
\fBgtk3-nocsd\fR runs a command in the environment where Gtk+3 client side
decorations (CSD) are disabled, by using LD_PRELOAD to load the library
\fBlibgtk3-nocsd.so.0\fR that overrides some GLib, GDK and Gtk API calls
with customized variants.
.SH OPTIONS
.TP
.I command
The command to execute. It may be either a full path or the name of the command
in PATH. In case command cannot be found in PATH, \fBgtk3-nocsd\fR will fail.
.TP
.I command arguments
Arbitrary number of arguments to pass to the command being executed.
.SH USAGE VIA SYMLINKS
If a symlink to \fBgtk3-nocsd\fR under a different name is called,
\fBgtk3-nocsd\fR will assume that the name it was called under is the name
of the command that is supposed to be executed. It will look for the command
in the PATH environment variable, excluding itself, and execute it with the
proper environment variables set. This is useful when is not desirable to add
gtk3-nocsd to the system-wide LD_PRELOAD or if it should be applied only to
certain applications.
.SH CAVEATS
.P
When using \fBgtk3-nocsd\fR with \fBsetarch\fR (including alias such as
\fBlinux32\fR), or anyway with chroots with different architectures than the
host's, make sure to install the matching architecture version of
\fBlibgtk3-nocsd.so.0\fR both in the \fBsetarch\fR environment and the host's
environment. Note that the \fBgtk3-nocsd\fR binary must then be installed in
a system path (\fI/usr/bin\fR, \fI/usr/local/bin\fR, ...), so that it will set
LD_PRELOAD to just the library name and let the dynamic linker find it
automatically - allowing the dynamic linker to pick the version for the
correct architecture. If \fBgtk3-nocsd\fR is not installed in a system path,
it will use a full path, allowing only for a single version of the library
to be used.

0 comments on commit c7db1f7

Please sign in to comment.