commit: d672c2cbf9176c50591bb5eea9a42b750b1d1617 Author: Nicolas PARLANT <nicolas.parlant <AT> parhuet <DOT> fr> AuthorDate: Tue Nov 4 21:48:24 2025 +0000 Commit: Sam James <sam <AT> gentoo <DOT> org> CommitDate: Wed Nov 5 17:06:25 2025 +0000 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=d672c2cb
x11-wm/awesome: use precompiled manpages asciidoctor is huge for manpages, use precompiled manpages (no translations) if doc is disabled if upstream makes new releases in future with manpages updated, a tarball should be used Signed-off-by: Nicolas PARLANT <nicolas.parlant <AT> parhuet.fr> Part-of: https://github.com/gentoo/gentoo/pull/44490 Closes: https://github.com/gentoo/gentoo/pull/44490 Signed-off-by: Sam James <sam <AT> gentoo.org> x11-wm/awesome/awesome-4.3-r104.ebuild | 19 +- x11-wm/awesome/files/awesome-client.1 | 87 ++++++++ x11-wm/awesome/files/awesome.1 | 353 +++++++++++++++++++++++++++++++++ x11-wm/awesome/files/awesomerc.5 | 103 ++++++++++ 4 files changed, 559 insertions(+), 3 deletions(-) diff --git a/x11-wm/awesome/awesome-4.3-r104.ebuild b/x11-wm/awesome/awesome-4.3-r104.ebuild index c6d010785ffd..cfba96abcf88 100644 --- a/x11-wm/awesome/awesome-4.3-r104.ebuild +++ b/x11-wm/awesome/awesome-4.3-r104.ebuild @@ -59,10 +59,12 @@ DEPEND=" " # graphicsmagick's 'convert -channel' has no Alpha support, bug #352282 BDEPEND=" - dev-ruby/asciidoctor media-gfx/imagemagick[png] virtual/pkgconfig - doc? ( dev-lua/ldoc ) + doc? ( + dev-lua/ldoc + dev-ruby/asciidoctor + ) test? ( app-shells/zsh x11-apps/xeyes @@ -81,6 +83,13 @@ PATCHES=( "${FILESDIR}"/${PN}-4.3-fix_target.patch # bug #962597 ) +src_prepare() { + cmake_src_prepare + if ! use doc; then + cp "${FILESDIR}"/awesome{.1,-client.1,rc.5} "${S}"/manpages/ || die + fi +} + src_configure() { # Compression of manpages is handled by portage local mycmakeargs=( @@ -88,6 +97,7 @@ src_configure() { -DCOMPRESS_MANPAGES=OFF -DWITH_DBUS=$(usex dbus) -DGENERATE_DOC=$(usex doc) + -DGENERATE_MANPAGES=$(usex doc) -DAWESOME_DOC_PATH="${EPREFIX}"/usr/share/doc/${PF} -DLUA_INCLUDE_DIR="$(lua_get_include_dir)" -DLUA_LIBRARY="$(lua_get_shared_lib)" @@ -126,9 +136,12 @@ src_install() { doins "${FILESDIR}"/${PN}-gnome-xsession.desktop fi - # use html subdir + # use html subdir and precompiled manpages w/o doc enabled if use doc; then mv "${ED}"/usr/share/doc/${PF}/{doc,html} || die + else + doman "${S}"/manpages/awesome{.1,rc.5} + use dbus && doman "${S}"/manpages/awesome-client.1 fi } diff --git a/x11-wm/awesome/files/awesome-client.1 b/x11-wm/awesome/files/awesome-client.1 new file mode 100644 index 000000000000..262d19bf13be --- /dev/null +++ b/x11-wm/awesome/files/awesome-client.1 @@ -0,0 +1,87 @@ +'\" t +.\" Title: awesome-client +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.26 +.\" Date: 2019-01-28 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "AWESOME\-CLIENT" "1" "2019-01-28" "\ \&" "\ \&" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +awesome-client \- awesome window manager remote execution +.SH "SYNOPSIS" +.sp +awesome\-client [\-h|\-\-help] [command [command.\|.\|.]] +.SH "DESCRIPTION" +.sp +awesome\-client is a remote command line interface to awesome. +It communicates with awesome via D\-Bus, allowing remote execution of Lua code. +.SH "USAGE" +.sp +awesome\-client reads commands passed on the command line or from standard input +and sends them via D\-Bus to awesome. +If \fIrlwrap\fP is installed, it will be used to provide a readline command line +interface. +.sp +The \fIawful.remote\fP module has to be loaded if you want this command to work. +.SH "EXAMPLES" +.sp +.if n .RS 4 +.nf +.fam C +$ awesome\-client \*(Aqreturn 1+1, "Hello, world"\(rs + double 2 + string "Hello, world" + +# The following does not return anything on the command line, +# but will show a notification. +$ awesome\-client \*(Aq +> naughty = require("naughty") +> naughty.notify({ +> title="CLI Notification", +> text="This is a notification sent from the command line!"}) +> \*(Aq + +# Entering read\-eval\-print\-loop mode +# This mode will send every line to awesome, exactly the same as passing +# multiple commands on the command line. +$ awesome\-client +awesome# return 1+1 + double 2 +awesome# return 1+1, "Hello, world" + double 2 + string "Hello, world" +awesome# +.fam +.fi +.if n .RE +.SH "SEE ALSO" +.sp +awesome(1) awesomerc(5) +.SH "AUTHORS" +.sp +Julien Danjou \c +.MTO "julien\(atdanjou.info" "" "" +.SH "WWW" +.sp +.URL "https://awesomewm.org"; "" "" \ No newline at end of file diff --git a/x11-wm/awesome/files/awesome.1 b/x11-wm/awesome/files/awesome.1 new file mode 100644 index 000000000000..c3552734084d --- /dev/null +++ b/x11-wm/awesome/files/awesome.1 @@ -0,0 +1,353 @@ +'\" t +.\" Title: awesome +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.26 +.\" Date: 2019-01-28 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "AWESOME" "1" "2019-01-28" "\ \&" "\ \&" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +awesome \- awesome window manager +.SH "SYNOPSIS" +.sp +\fBawesome\fP [\fB\-v\fP | \fB\-\-version\fP] [\fB\-h\fP | \fB\-\-help\fP] [\fB\-c\fP | \fB\-\-config\fP \fIFILE\fP] [\fB\-k\fP | \fB\-\-check\fP] [\fB\-\-search\fP \fIDIRECTORY\fP] [\fB\-a\fP | \fB\-\-no\-argb\fP] [\fB\-r\fP | *\-\-replace] +.SH "DESCRIPTION" +.sp +\fBawesome\fP is a window manager for X. It manages windows in different layouts, like +floating or tiled. Any layout can be applied dynamically, optimizing the +environment for the application in use and the task currently being performed. +.sp +In a tiled layout, windows are managed in a master and stacking area. The master +area contains the windows which currently need the most attention, whereas the +stacking area contains all other windows. In a floating layout windows can be +resized and moved freely. Dialog windows are always managed as floating, +regardless of the layout currently applied. The spiral and dwindle layouts are +special cases of the tiled layout where the stacking area is arranged in a +spiral for the former or as a rectangular fractal for the later. +.sp +Windows are grouped by tags in awesome. Each window can be tagged with one or +more tags. Selecting certain tags displays all windows with these tags. +.sp +\fBawesome\fP can contain small wiboxes which can display anything you want: +all available tags, the current layout, the title of the visible windows, text, etc. +.SH "OPTIONS" +.sp +\fB\-v\fP, \fB\-\-version\fP +.RS 4 +Print version information to standard output, then exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Print help information, then exit. +.RE +.sp +\fB\-c\fP, \fB\-\-config\fP \fIFILE\fP +.RS 4 +Use an alternate configuration file instead of \fI$XDG_CONFIG_HOME/awesome/rc.lua\fP. +.RE +.sp +\fB\-k\fP, \fB\-\-check\fP +.RS 4 +Check configuration file syntax. +.RE +.sp +\fB\-\-search\fP +.RS 4 +Add a directory to the library search path. +.RE +.sp +\fB\-a\fP, \fB\-\-no\-argb\fP +.RS 4 +Don\(cqt use ARGB visuals. +.RE +.sp +\fB\-r\fP, \fB\-\-replace\fP +.RS 4 +Replace an existing window manager. +.RE +.SH "DEFAULT MOUSE BINDINGS" +.SS "Navigation" +.sp +\fBButton1\fP on tag name +.RS 4 +View tag. +.RE +.sp +\fBButton4\fP, \fBButton5\fP on tag name +.RS 4 +Switch to previous or next tag. +.RE +.sp +\fBButton4\fP, \fBButton5\fP on root window +.RS 4 +Switch to previous or next tag. +.RE +.sp +\fBButton1\fP, \fBButton3\fP, \fBButton4\fP, \fBButton5\fP on layout symbol +.RS 4 +Switch to previous or next layout. +.RE +.SS "Layout modification" +.sp +\fBMod4 + Button1\fP on tag name +.RS 4 +Tag current client with this tag only. +.RE +.sp +\fBMod4 + Button3\fP on tag name +.RS 4 +Toggle this tag for client. +.RE +.sp +\fBButton3\fP on tag name +.RS 4 +Add this tag to current view. +.RE +.sp +\fBMod4 + Button1\fP on client window +.RS 4 +Move window. +.RE +.sp +\fBMod4 + Button3\fP on client window +.RS 4 +Resize window. +.RE +.SH "DEFAULT KEY BINDINGS" +.SS "Help" +.sp +\fBMod4 + s\fP +.RS 4 +Show currently assigned key bindings. +.RE +.SS "Window manager control" +.sp +\fBMod4 + Control + r\fP +.RS 4 +Restart \fBawesome\fP. +.RE +.sp +\fBMod4 + Shift + q\fP +.RS 4 +Quit \fBawesome\fP. +.RE +.sp +\fBMod4 + r\fP +.RS 4 +Run prompt. +.RE +.sp +\fBMod4 + x\fP +.RS 4 +Run Lua code prompt. +.RE +.sp +\fBMod4 + Return\fP +.RS 4 +Spawn terminal emulator. +.RE +.sp +\fBMod4 + w\fP +.RS 4 +Open main menu. +.RE +.SS "Clients" +.sp +\fBMod4 + m\fP +.RS 4 +Maximize client. +.RE +.sp +\fBMod4 + n\fP +.RS 4 +Minimize client. +.RE +.sp +\fBMod4 + Control + n\fP +.RS 4 +Restore client. +.RE +.sp +\fBMod4 + f\fP +.RS 4 +Set client fullscreen. +.RE +.sp +\fBMod4 + Shift + c\fP +.RS 4 +Kill focused client. +.RE +.sp +\fBMod4 + t\fP +.RS 4 +Set client on\-top. +.RE +.SS "Navigation" +.sp +\fBMod4 + j\fP +.RS 4 +Focus next client. +.RE +.sp +\fBMod4 + k\fP +.RS 4 +Focus previous client. +.RE +.sp +\fBMod4 + u\fP +.RS 4 +Focus first urgent client. +.RE +.sp +\fBMod4 + Left\fP +.RS 4 +View previous tag. +.RE +.sp +\fBMod4 + Right\fP +.RS 4 +View next tag. +.RE +.sp +\fBMod4 + 1\-9\fP +.RS 4 +Switch to tag 1\-9. +.RE +.sp +\fBMod4 + Control + j\fP +.RS 4 +Focus next screen. +.RE +.sp +\fBMod4 + Control + k\fP +.RS 4 +Focus previous screen. +.RE +.sp +\fBMod4 + Escape\fP +.RS 4 +Focus previously selected tag set. +.RE +.SS "Layout modification" +.sp +\fBMod4 + Shift + j\fP +.RS 4 +Switch client with next client. +.RE +.sp +\fBMod4 + Shift + k\fP +.RS 4 +Switch client with previous client. +.RE +.sp +\fBMod4 + o\fP +.RS 4 +Send client to next screen. +.RE +.sp +\fBMod4 + h\fP +.RS 4 +Decrease master width factor by 5%. +.RE +.sp +\fBMod4 + l\fP +.RS 4 +Increase master width factor by 5%. +.RE +.sp +\fBMod4 + Shift + h\fP +.RS 4 +Increase number of master windows by 1. +.RE +.sp +\fBMod4 + Shift + l\fP +.RS 4 +Decrease number of master windows by 1. +.RE +.sp +\fBMod4 + Control + h\fP +.RS 4 +Increase number of columns for non\-master windows by 1. +.RE +.sp +\fBMod4 + Control + l\fP +.RS 4 +Decrease number of columns for non\-master windows by 1. +.RE +.sp +\fBMod4 + space\fP +.RS 4 +Switch to next layout. +.RE +.sp +\fBMod4 + Shift + space\fP +.RS 4 +Switch to previous layout. +.RE +.sp +\fBMod4 + Control + space\fP +.RS 4 +Toggle client floating status. +.RE +.sp +\fBMod4 + Control + Return\fP +.RS 4 +Swap focused client with master. +.RE +.sp +\fBMod4 + Control + 1\-9\fP +.RS 4 +Toggle tag view. +.RE +.sp +\fBMod4 + Shift + 1\-9\fP +.RS 4 +Tag client with tag. +.RE +.sp +\fBMod4 + Shift + Control + 1\-9\fP +.RS 4 +Toggle tag on client. +.RE +.SH "CUSTOMIZATION" +.sp +\fBawesome\fP is customized by creating a custom \fI$XDG_CONFIG_HOME/awesome/rc.lua\fP file. +.SH "SIGNALS" +.sp +\fBawesome\fP can be restarted by sending it a SIGHUP. +.SH "SEE ALSO" +.sp +\fBawesomerc\fP(5) \fBawesome\-client\fP(1) +.SH "BUGS" +.sp +Of course there\(cqs no bug in \fBawesome\fP. But there may be unexpected behaviors. +.SH "AUTHORS" +.sp +Julien Danjou \c +.MTO "julien\(atdanjou.info" "" "" +and others. +.SH "WWW" +.sp +.URL "https://awesomewm.org"; "" "" \ No newline at end of file diff --git a/x11-wm/awesome/files/awesomerc.5 b/x11-wm/awesome/files/awesomerc.5 new file mode 100644 index 000000000000..e50f96a6e216 --- /dev/null +++ b/x11-wm/awesome/files/awesomerc.5 @@ -0,0 +1,103 @@ +'\" t +.\" Title: awesomerc +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.26 +.\" Date: 2019-01-28 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "AWESOMERC" "5" "2019-01-28" "\ \&" "\ \&" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +awesomerc \- Configuration file for the awesome window manager +.SH "SYNOPSIS" +.sp +\fBawesome\fP looks for a configuration file in this order: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +$XDG_CONFIG_HOME/awesome/rc.lua +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +$HOME/.config/awesome/rc.lua +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +$XDG_CONFIG_DIRS/awesome/rc.lua +.RE +.SH "DESCRIPTION" +.sp +The \fBrc.lua\fP file contains configuration information for \fBawesome\fP. It can +be used to configure the behavior and look of awesome in a variety of ways. +It can be assimilated as a Lua program/script run at startup by \fBawesome\fP. +Therefore, it should use the awesome Lua API described in the API section. +This file is read at startup. +.SH "AWESOME LUA API" +.sp +Documentation for the Lua API can be found in the luadoc directory. +.SH "COLORS FORMAT" +.sp +The color format in \fBawesome\fP is either a standard X color name +(blue, darkblue, lightred, etc) or a hexadecimal formatted color (#rrggbb +or #rrggbbaa). +By using the hexadecimal format, you can also specify an alpha channel: +that means that #00ff00 will draw pure green, but #00ff00aa will set the +alpha channel to \(oqaa\(cq and will blend the green with the color under it. +.SH "TEXT FORMAT" +.sp +You can use Pango markup in a text string. +This allows formatting the text rendered inside widgets. +Pango markup documentation can be found in the Pango documentation at +.URL "http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html"; "" "." +.sp +A Pango markup example: <span weight="bold" foreground="#336699">.\|.\|.</span>. +.SH "SEE ALSO" +.sp +awesome(1) awesome\-client(1) +.SH "AUTHORS" +.sp +Written by Julien Danjou \c +.MTO "julien\(atdanjou.info" "" "." +.SH "WWW" +.sp +.URL "https://awesomewm.org"; "" "" \ No newline at end of file
