From dd0ae5bda0176d1da9475659e5f137f0f21a9719 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Mon, 9 Jul 2018 12:40:14 +0200 Subject: [Doc] Add enviroment property to manpage --- doc/rofi-theme-selector.1 | 2 +- doc/rofi-theme.5 | 27 ++++++++++++++++++++++++++- doc/rofi-theme.5.markdown | 14 ++++++++++++++ 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index 6a9630c7..47d0bff7 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "ROFI\-THEME\-SELECTOR" "1" "May 2018" "" "" +.TH "ROFI\-THEME\-SELECTOR" "1" "January 2018" "" "" . .SH "NAME" \fBrofi\-theme\-selector\fR \- Preview and apply themes for \fBrofi\fR diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index d51ede3e..23ba0f54 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "ROFI\-THEME" "5" "June 2018" "" "" +.TH "ROFI\-THEME" "5" "July 2018" "" "" . .SH "NAME" \fBrofi\-theme\fR \- Rofi theme format files @@ -272,6 +272,9 @@ an orientation a list of keywords . .IP "\(bu" 4 +an environment variable +. +.IP "\(bu" 4 Inherit . .IP "" 0 @@ -714,6 +717,28 @@ Format: \fB[ keyword, keyword ]\fR .P A list starts with a \'[\' and ends with a \']\'\. The entries in the list are comma\-separated\. The \fBkeyword\fR in the list refers to an widget name\. . +.SH "Environment variable" +. +.IP "\(bu" 4 +Format: \fB${:alnum:}\fR +. +.IP "" 0 +. +.P +This will parse the environment variable as the property value\. (that then can be any of the above types)\. The environment variable should be an alphanumeric string without white\-space\. +. +.IP "" 4 +. +.nf + +* { + background\-color: ${BG}; +} +. +.fi +. +.IP "" 0 +. .SH "Inherit" . .IP "\(bu" 4 diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index a7bee6d6..e49246fb 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -189,6 +189,7 @@ The current theme format supports different types: * a reference * an orientation * a list of keywords + * an environment variable * Inherit Some of these types are a combination of other types. @@ -443,6 +444,19 @@ Specify the orientation of the widget. A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated. The `keyword` in the list refers to an widget name. +## Environment variable + +* Format: `${:alnum:}` + +This will parse the environment variable as the property value. (that then can be any of the above types). +The environment variable should be an alphanumeric string without white-space. + +``` +* { + background-color: ${BG}; +} +``` + ## Inherit * Format: `inherit` -- cgit v1.2.3