update README and manpage

git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@1272 7f574dfc-610e-0410-a909-a81674777703

README

@@ -388,6 +388,18 @@ conky(1)							      conky(1)
 	      Border stippling (dashing) in pixels
 
 
+       1mtemplateN0m
+	      Define a template for later use inside TEXT segments. Substitute
+	      N by a digit between 0 and 9, inclusively.   The	value  of  the
+	      variable is being inserted into the stuff below TEXT at the cor‐
+	      responding position, but before some substitutions are applied:
+
+	      ’\n’ -> newline
+	      ’\\’ -> backslash
+	      ’\ ’ -> space
+	      ’\N’ -> template argument N
+
+
        1mtotal_run_times0m
 	      Total number of times for Conky to update before quitting.  Zero
 	      makes Conky run forever
@@ -1469,6 +1481,35 @@ conky(1)							      conky(1)
 	      can be displayed, or until the text buffer is filled.
 
 
+       1mtemplateN (arg1) (arg2) (arg3 ...)0m
+	      Evaluate the content of  the  templateN  configuration  variable
+	      (where N is a value between 0 and 9, inclusively), applying sub‐
+	      stitutions as described in the documentation of the  correspond‐
+	      ing  configuration variable.  The number of arguments is option‐
+	      al, but must match the highest referred index in	the  template.
+	      You  can	use the same special sequences in each argument as the
+	      ones valid for a template definition, e.g. to allow an  argument
+	      to  contain  a  whitespace.  Also simple nesting of templates is
+	      possible this way.
+
+	      Here are some examples of template definitions:
+
+	      template0 $\1\2
+	      template1 \1: ${fs_used \2} / ${fs_size \2}
+	      template2 \1 \2
+
+	      The following list shows sample usage of the  templates  defined
+	      above, with the equivalent syntax when not using any template at
+	      all:
+
+	      using template				same without template
+	      ─────────────────────────────────────────────────────────────────────────────────
+	      ${template0 node name}			$nodename
+	      ${template1 root /}			root:	${fs_free   /}	 /
+							${fs_size /}
+	      ${template1 ${template2\ disk\ root} /}	disk root: ${fs_free /} / ${fs_size /}
+
+
        1mtime (format)0m
 	      Local  time, see man strftime to get more information about for‐
 	      mat

doc/conky.1

@@ -1,4 +1,4 @@
-'\" -*- coding: us-ascii -*-
+'\" t -*- coding: us-ascii -*-
 .if \n(.g .ds T< \\FC
 .if \n(.g .ds T> \\F[\n[.fam]]
 .de URL
@@ -346,6 +346,20 @@ Shows the time range covered by a graph.
 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
 Border stippling (dashing) in pixels
 
+.TP 
+\fB\*(T<\fBtemplateN\fR\*(T>\fR
+Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
+The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
+but before some substitutions are applied:
+
+\&'\en' -> newline
+.br
+\&'\e\e' -> backslash
+.br
+\&'\e ' -> space
+.br
+\&'\eN' -> template argument N
+
 .TP 
 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
 Total number of times for Conky to update before quitting. Zero makes Conky run forever
@@ -1255,6 +1269,57 @@ Puts a tab of the specified width, starting from column 'start'.
 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
 
+.TP 
+\fB\*(T<\fBtemplateN\fR\*(T>\fR \*(T<\fB(arg1)\fR\*(T> \*(T<\fB(arg2)\fR\*(T> \*(T<\fB(arg3 ...)\fR\*(T> 
+Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
+applying substitutions as described in the documentation of the corresponding configuration variable.
+The number of arguments is optional, but must match the highest referred index in the template. You can use the
+same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
+to contain a whitespace. Also simple nesting of templates is possible this way.
+
+Here are some examples of template definitions:
+
+template0 $\e1\e2
+.br
+template1 \e1: ${fs_used \e2} / ${fs_size \e2}
+.br
+template2 \e1 \e2
+
+The following list shows sample usage of the templates defined above,
+with the equivalent syntax when not using any template at all:
+.TS
+l l.
+T{
+using template
+T}	T{
+same without template
+T}
+.T&
+_ _
+l l
+l l
+l l.
+T{
+${template0 node name}
+T}	T{
+$nodename
+T}
+T{
+${template1 root /}
+T}	T{
+root: ${fs_free /} / ${fs_size /}
+T}
+T{
+.nf
+\*(T<${template1 ${template2\e disk\e root} /}\*(T>
+.fi
+T}	T{
+.nf
+\*(T<disk root: ${fs_free /} / ${fs_size /}\*(T>
+.fi
+T}
+.TE
+
 .TP 
 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
 Local time, see man strftime to get more information about format