summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2023-01-14 12:44:55 +0100
committerDave Davenport <qball@blame.services>2023-01-14 12:44:55 +0100
commitf70b0ed3fdfa3116c2ec1c7b84ad1c3b5e58fe7a (patch)
tree9018084409bc062d11f886d87581ce2b462afd78
parent5b892ce86e7201c315b984753b92c6539ce391a9 (diff)
[Doc] Add manpage documentation for pango font string.
-rw-r--r--doc/rofi-theme.553
-rw-r--r--doc/rofi-theme.5.markdown42
2 files changed, 95 insertions, 0 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index 080c0854..62eadb24 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -2164,6 +2164,59 @@ FontAwesome 22
.fi
.RE
+.PP
+From the pango manpage:
+
+.PP
+The string must have the form
+
+.PP
+\fB\fC\\[FAMILY-LIST] \\[STYLE-OPTIONS] \\[SIZE] \\[VARIATIONS]\fR,
+
+.PP
+where FAMILY-LIST is a comma-separated list of families optionally terminated
+by a comma, STYLE_OPTIONS is a whitespace-separated list of words where each
+word describes one of style, variant, weight, stretch, or gravity, and SIZE is
+a decimal number (size in points) or optionally followed by the unit modifier
+“px” for absolute size. VARIATIONS is a comma-separated list of font variation
+specifications of the form “\fB\fCaxis\fR=value” (the = sign is optional).
+
+.PP
+The following words are understood as styles: "Normal”, “Roman”, “Oblique”,
+“Italic”.
+
+.PP
+The following words are understood as variants: “Small-Caps”, “All-Small-Caps”,
+“Petite-Caps”, “All-Petite-Caps”, “Unicase”, “Title-Caps”.
+
+.PP
+The following words are understood as weights: “Thin”, “Ultra-Light”,
+“Extra-Light”, “Light”, “Semi-Light”, “Demi-Light”, “Book”, “Regular”,
+“Medium”, “Semi-Bold”, “Demi-Bold”, “Bold”, “Ultra-Bold”, “Extra-Bold”,
+“Heavy”, “Black”, “Ultra-Black”, “Extra-Black”.
+
+.PP
+The following words are understood as stretch values: “Ultra-Condensed”,
+“Extra-Condensed”, “Condensed”, “Semi-Condensed”, “Semi-Expanded”, “Expanded”,
+“Extra-Expanded”, “Ultra-Expanded”.
+
+.PP
+The following words are understood as gravity values: “Not-Rotated”, “South”,
+“Upside-Down”, “North”, “Rotated-Left”, “East”, “Rotated-Right”, “West”.
+
+.PP
+Any one of the options may be absent. If FAMILY-LIST is absent, then the
+family_name field of the resulting font description will be initialized to
+NULL. If STYLE-OPTIONS is missing, then all style options will be set to the
+default values. If SIZE is missing, the size in the resulting font description
+will be set to 0.
+
+.PP
+A typical example:
+
+.PP
+"Cantarell Italic Light 15 `wght`=200"
+
.SH Icon Handling
.PP
Rofi supports 3 ways of specifying an icon:
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown
index 99e98e5f..c1f71c7c 100644
--- a/doc/rofi-theme.5.markdown
+++ b/doc/rofi-theme.5.markdown
@@ -1378,6 +1378,48 @@ Or
FontAwesome 22
```
+From the pango manpage:
+
+The string must have the form
+
+`\[FAMILY-LIST] \[STYLE-OPTIONS] \[SIZE] \[VARIATIONS]`,
+
+where FAMILY-LIST is a comma-separated list of families optionally terminated
+by a comma, STYLE\_OPTIONS is a whitespace-separated list of words where each
+word describes one of style, variant, weight, stretch, or gravity, and SIZE is
+a decimal number (size in points) or optionally followed by the unit modifier
+“px” for absolute size. VARIATIONS is a comma-separated list of font variation
+specifications of the form “`axis`=value” (the = sign is optional).
+
+The following words are understood as styles: "Normal”, “Roman”, “Oblique”,
+“Italic”.
+
+The following words are understood as variants: “Small-Caps”, “All-Small-Caps”,
+“Petite-Caps”, “All-Petite-Caps”, “Unicase”, “Title-Caps”.
+
+The following words are understood as weights: “Thin”, “Ultra-Light”,
+“Extra-Light”, “Light”, “Semi-Light”, “Demi-Light”, “Book”, “Regular”,
+“Medium”, “Semi-Bold”, “Demi-Bold”, “Bold”, “Ultra-Bold”, “Extra-Bold”,
+“Heavy”, “Black”, “Ultra-Black”, “Extra-Black”.
+
+The following words are understood as stretch values: “Ultra-Condensed”,
+“Extra-Condensed”, “Condensed”, “Semi-Condensed”, “Semi-Expanded”, “Expanded”,
+“Extra-Expanded”, “Ultra-Expanded”.
+
+The following words are understood as gravity values: “Not-Rotated”, “South”,
+“Upside-Down”, “North”, “Rotated-Left”, “East”, “Rotated-Right”, “West”.
+
+Any one of the options may be absent. If FAMILY-LIST is absent, then the
+family\_name field of the resulting font description will be initialized to
+NULL. If STYLE-OPTIONS is missing, then all style options will be set to the
+default values. If SIZE is missing, the size in the resulting font description
+will be set to 0.
+
+A typical example:
+
+"Cantarell Italic Light 15 \`wght`=200"
+
+
## Icon Handling
Rofi supports 3 ways of specifying an icon: