From 7e1a7ee1201c5a88b61c672dd313925db6914d40 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Mon, 22 Oct 2012 08:20:43 -0500 Subject: [PATCH] fix man page and various other documentation. --- README.md | 8 ++++---- man/compton.1 | 29 ++++++++++++++++++----------- src/compton.c | 2 +- 3 files changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 85bac0c..64b76f2 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ $ make install ## Example Usage ``` bash -$ compton -cC -i 0.6 -e 0.6 -fF +$ compton -cC -i 0.6 -e 0.6 -f $ compton --config ~/compton.conf ``` @@ -74,7 +74,7 @@ compton [-d display] [-r radius] [-o opacity] [-l left-offset] [-t top-offset] [-i opacity] [-e opacity] [-cCfFSdG] [--config path] [--shadow-red value] - [--shadow-gren value] [--shadow-blue value] + [--shadow-green value] [--shadow-blue value] [--inactive-opacity-override] [--inactive-dim value] [--mark-wmwin-focused] [--shadow-exclude condition] [--mark-ovredir-focused] [--no-fading-openclose] @@ -116,8 +116,8 @@ compton [-d display] [-r radius] [-o opacity] Opacity of window titlebars and borders. (0.1 - 1.0) * `-G`: Don't draw shadows on DND windows -* `-b` __daemonize__: - Daemonize process. +* `-b`: + Daemonize/background process. * `-S`: Enable synchronous operation (for debugging). * `--config` __path__: diff --git a/man/compton.1 b/man/compton.1 index 0ff4691..cdaa234 100644 --- a/man/compton.1 +++ b/man/compton.1 @@ -1,24 +1,27 @@ .ds q \N'34' .TH compton 1 + .SH NAME compton \- a compositor for X11 + .SH SYNOPSIS -.nf -.B compton [\-d display] [\-r radius] [\-o opacity] [\-l left-offset] - [\-t top-offset] [\-i opacity] [\-e opacity] [\-cCfFSdG] - [\--config path] [\--shadow-red value] - [\--shadow-gren value] [\--shadow-blue value] - [\--inactive-opacity-override] [\--inactive-dim value] - [\--mark-wmwin-focused] [\--shadow-exclude condition] - [\--mark-ovredir-focused] [\--no-fading-openclose] - [\--shadow-ignore-shaped] [\--detect-round-corners] -.fi +.B compton +[\-d display] [\-r radius] [\-o opacity] [\-l left\-offset] +[\-t top\-offset] [\-i opacity] [\-e opacity] [\-cCfFSdG] +[\-\-config path] [\-\-shadow\-red value] +[\-\-shadow\-green value] [\-\-shadow\-blue value] +[\-\-inactive\-opacity\-override] [\-\-inactive\-dim value] +[\-\-mark\-wmwin\-focused] [\-\-shadow\-exclude condition] +[\-\-mark\-ovredir\-focused] [\-\-no\-fading\-openclose] +[\-\-shadow\-ignore\-shaped] [\-\-detect\-round\-corners] + .SH DESCRIPTION .B compton is a compositor based on Dana Jansens' version of xcompmgr (which itself was written by Keith Packard). It includes many improvements over the original xcompmgr, including window frame opacity, inactive window transparency, and shadows on argb windows. + .SH OPTIONS .TP .BI \-d\ display @@ -73,7 +76,7 @@ Opacity of window titlebars and borders. (0.1 - 1.0) .BI \-G Don't draw shadows on DND windows .TP -.BI \-b\ daemonize +.BI \-b Daemonize process. .TP .BI \-S @@ -134,9 +137,13 @@ flag is "i" (ignore case). .SH BUGS Please report any you find to https://github.com/chjj/compton. + .SH AUTHORS xcompmgr, originally written by Keith Packard, with contributions from Matthew Allum, Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell, and Carl Worth. Compton by Christopher Jeffrey, based on Dana Jansens' original work, with numerous contributions from Richard Grenville. + +.SH SEE ALSO +.BR compton-trans (1) diff --git a/src/compton.c b/src/compton.c index bb9d7bb..fe522f4 100644 --- a/src/compton.c +++ b/src/compton.c @@ -2982,7 +2982,7 @@ usage(void) { " Opacity of window titlebars and borders. (0.1 - 1.0)\n" "-G\n" " Don't draw shadows on DND windows\n" - "-b daemonize\n" + "-b\n" " Daemonize process.\n" "-S\n" " Enable synchronous operation (for debugging).\n"