chiark / gitweb /
@@@ tty cleanup
[mLib] / ui / ttycolour.c
index d2658e70cbadcb29f0e7cffd3142063ac0205671..3deaec86a1f08c570d9fe6105d850d95b820b942 100644 (file)
@@ -44,8 +44,8 @@
  * Returns:    Nonzero if the variable is set to a non-empty value,
  *             otherwise zero.
  *
- * Use:                This is the recommended way to check the `NO_COLOR',
- *             `CLICOLOR' and `CLICOLOR_FORCE' variables.
+ * Use:                This is the recommended way to check the %|NO_COLOR|%,
+ *             `%|CLICOLOR|% and %|CLICOLOR_FORCE|% variables.
  */
 
 static int env_setting_p(const char *var)
@@ -69,19 +69,19 @@ static int env_setting_p(const char *var)
  *             this function is to abide by common conventions and to be
  *             convenient for users, these details may change in future.)
  *
- *               * If the `NO_COLOR' environment variable is non-empty, then
+ *               * If the %|NO_COLOR|% environment variable is non-empty,
  *                 colour is disabled (%%\url{https://no-color.org/}%%).
  *
- *               * If the `TERM' variable is set to `dumb', then colour is
- *                 disabled (Emacs).
+ *               * If the %|TERM|% variable is set to %|dumb|%, then colour
+ *                 is disabled (Emacs).
  *
- *               * If the `FORCE_COLOR' environment variable is non-empty,
+ *               * If the %|FORCE_COLOR|% environment variable is non-empty,
  *                 then colour is enabled, unless the value is 0, in which
  *                 case colour is disabled (apparently from the Node
  *                 community, %%\url{%%https://force-color.org/}%% and
  *                 %%\url{https://nodejs.org/api/tty.html#writestreamgetcolordepthenv}%%).
  *
- *               * If the `CLICOLOR_FORCE' environment variable is
+ *               * If the %|CLICOLOR_FORCE|% environment variable is
  *                 non-empty, then colour is enabled (apparently from
  *                 Mac OS, (%%\url{http://bixense.com/clicolors/}%%).
  *
@@ -89,8 +89,8 @@ static int env_setting_p(const char *var)
  *
  *               * If the @TCEF_DFLT@ flag is set, then colour is enabled.
  *
- *               * If the `CLICOLOR' environment variable is non-empty, then
- *                 colour is enabled (again, apparently from Mac OS,
+ *               * If the %|CLICOLOR|% environment variable is non-empty,
+ *                 then colour is enabled (again, apparently from Mac OS,
  *                 (%%\url{http://bixense.com/clicolors/}%%).
  *
  *               * Otherwise, colour is disabled.