From 1b633c42af2a3dc72549a1bc1621e65b5ca5734f Mon Sep 17 00:00:00 2001
From: brl <brl>
Date: Thu, 23 Nov 2006 15:14:37 +0000
Subject: document syntax for max lengths in winfmt in texinfo and manpage,
 complete format chars in manpage

---
 doc/ratpoison.1    | 36 +++++++++++++++++++++++++++++-------
 doc/ratpoison.texi |  3 +++
 2 files changed, 32 insertions(+), 7 deletions(-)

(limited to 'doc')

diff --git a/doc/ratpoison.1 b/doc/ratpoison.1
index 30f5aeb..6497bd1 100644
--- a/doc/ratpoison.1
+++ b/doc/ratpoison.1
@@ -1,4 +1,4 @@
-.TH RATPOISON 1 2006-06-07
+.TH RATPOISON 1 2006-11-23
 \# This man page is free software; you can redistribute it and/or modify
 \# it under the terms of the GNU General Public License as published by
 \# the Free Software Foundation; either version 2, or (at your option)
@@ -643,25 +643,47 @@ The messages are shown in columns or rows depending on the \fBset\fPting
 of \fBwinliststyle\fP in the format set by \fBset winfmt\fP.
 The following substitutions happen in format:
 .br
+%a by the application name (resource name),
+.br
+%c by the resource class,
+.br
+%f by the frame number,
+.br
+%g by the gravity of the window,
+.br
+%h by the height of the window,
+.br
+%H by the unit to resize the window vertically (height_inc)
+.br
+%i by the X Window ID,
+.br
+%l by the last access number,
+.br
 %n by the window number,
 .br
 %s by window status (\fB*\fP is active window,
 \fB+\fP would be chosen by \fBother\fP, \fB\-\fP otherwise)
 .br
-%t by the window name (see \fBset winname\fP),
+%S by the screen number
 .br
-%a by the application name,
+%t by the window name (see \fBset winname\fP),
 .br
-%c by the resource class,
+%T by the string \fBTransient\fP, if it is a transient window
 .br
-%i by the X Window ID,
+%w by the width of the window
 .br
-%l by the last access number,
+%W by the unit to resize the window horizontally (width_inc)
 .br
-%f by the frame number and
+.%x by the xine screen number
+and
 .br
 %% by a single %
 
+Additionally there can be a positive decimal integer number between the
+percent sign and the format string to specify the length this value
+should be truncated to if longer.
+(For example: \fB%20t\fP)
+
 In non\-interactive mode, output the list of windows in the current group
 line by line. The format string can be overwritten by the optional parameter
 \fIformat\fP.
diff --git a/doc/ratpoison.texi b/doc/ratpoison.texi
index 94e8e49..75a98ac 100644
--- a/doc/ratpoison.texi
+++ b/doc/ratpoison.texi
@@ -402,6 +402,9 @@ The window's width increment hint
 the window's xinerama screen
 @end table
 
+Additionally there can be a number between the percent sign and the format
+character, denoting a maximum length this value is to truncate to, e.g. @samp{%n%s%20t}.
+
 When called with no arguments, the current setting is
 returned.
 @end deffn
-- 
cgit v1.2.3