From b5d135df82ad7e6ba7ad42e8945eecac3ca6a9e5 Mon Sep 17 00:00:00 2001 From: Yuxuan Shui Date: Sat, 15 Dec 2018 16:12:46 +0000 Subject: [PATCH] Man page improvements * Removed the AUTHORS section as recommended by man-pages(7), the conventions for writing Linux man pages. * Change the secion name to the more commonly used "User Commands". * Don't say "this man page might be out dated". * Always use the current version number of compton as "man version" in the man pages. Also bumped the project version in meson.build Signed-off-by: Yuxuan Shui --- man/compton-trans.1.asciidoc | 10 +++------- man/compton.1.asciidoc | 14 ++++---------- man/meson.build | 6 ++++-- meson.build | 2 +- 4 files changed, 12 insertions(+), 20 deletions(-) diff --git a/man/compton-trans.1.asciidoc b/man/compton-trans.1.asciidoc index 9a6afec..0582af0 100644 --- a/man/compton-trans.1.asciidoc +++ b/man/compton-trans.1.asciidoc @@ -2,8 +2,8 @@ compton-trans(1) ================ :doctype: manpage :man source: compton -:man version: nightly-20121114 -:man manual: LOCAL USER COMMANDS +:man version: {compton-version} +:man manual: User Commands NAME ---- @@ -77,11 +77,7 @@ compton-trans -c -- -5 BUGS ---- -Please report any bugs you find to . - -AUTHORS -------- -Christopher Jeffrey (). +Please submit bug reports to . SEE ALSO -------- diff --git a/man/compton.1.asciidoc b/man/compton.1.asciidoc index 805a366..acda576 100644 --- a/man/compton.1.asciidoc +++ b/man/compton.1.asciidoc @@ -2,8 +2,8 @@ compton(1) ========== :doctype: manpage :man source: compton -:man version: nightly-20141124 -:man manual: LOCAL USER COMMANDS +:man version: {compton-version} +:man manual: User Commands NAME ---- @@ -13,10 +13,6 @@ SYNOPSIS -------- *compton* ['OPTIONS'] -WARNING -------- -This man page may be less up-to-date than the usage text in compton (`compton -h`). - DESCRIPTION ----------- compton is a compositor based on Dana Jansens' version of xcompmgr (which itself was written by Keith Packard). It includes some improvements over the original xcompmgr, like window frame opacity and inactive window transparency. @@ -445,11 +441,9 @@ $ compton --backend glx --vsync opengl-swc BUGS ---- -Please report any you find to . +Please submit bug reports to . -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 contributions from Richard Grenville. +Out dated information in this man page is considered a bug. RESOURCES --------- diff --git a/man/meson.build b/man/meson.build index 289ddec..be67e63 100644 --- a/man/meson.build +++ b/man/meson.build @@ -3,8 +3,10 @@ if get_option('build_docs') a2x = find_program('a2x') foreach m : mans custom_target(m, output: [m], input: [m+'.asciidoc'], - command: [a2x, '--format', 'manpage', '@INPUT@', - '-D', meson.current_build_dir()], + command: [a2x, '-a', + 'compton-version='+version, + '--format', 'manpage', '@INPUT@', '-D', + meson.current_build_dir()], install: true, install_dir: 'share/man/man1/') endforeach endif diff --git a/meson.build b/meson.build index dcddd73..2db0eb3 100644 --- a/meson.build +++ b/meson.build @@ -1,4 +1,4 @@ -project('compton', 'c', version: '2') +project('compton', 'c', version: '4') cc = meson.get_compiler('c')