Commit 11180303 authored by Matthias Clasen's avatar Matthias Clasen

Don't use <envar> in docs

Switch to simpler markdown, `foo`.
parent 2fda00af
...@@ -538,17 +538,16 @@ g_app_info_get_icon (GAppInfo *appinfo) ...@@ -538,17 +538,16 @@ g_app_info_get_icon (GAppInfo *appinfo)
* g_app_info_launch_uris() instead. * g_app_info_launch_uris() instead.
* *
* The launched application inherits the environment of the launching * The launched application inherits the environment of the launching
* process, but it can be modified with g_app_launch_context_setenv() and * process, but it can be modified with g_app_launch_context_setenv()
* g_app_launch_context_unsetenv(). * and g_app_launch_context_unsetenv().
* *
* On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar> * On UNIX, this function sets the `GIO_LAUNCHED_DESKTOP_FILE`
* environment variable with the path of the launched desktop file and * environment variable with the path of the launched desktop file and
* <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process * `GIO_LAUNCHED_DESKTOP_FILE_PID` to the process id of the launched
* id of the launched process. This can be used to ignore * process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`,
* <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>, should it be inherited * should it be inherited by further processes. The `DISPLAY` and
* by further processes. The <envar>DISPLAY</envar> and * `DESKTOP_STARTUP_ID` environment variables are also set, based
* <envar>DESKTOP_STARTUP_ID</envar> environment variables are also * on information provided in @launch_context.
* set, based on information provided in @launch_context.
* *
* Returns: %TRUE on successful launch, %FALSE otherwise. * Returns: %TRUE on successful launch, %FALSE otherwise.
**/ **/
...@@ -951,7 +950,7 @@ g_app_launch_context_get_environment (GAppLaunchContext *context) ...@@ -951,7 +950,7 @@ g_app_launch_context_get_environment (GAppLaunchContext *context)
* *
* Gets the display string for the @context. This is used to ensure new * Gets the display string for the @context. This is used to ensure new
* applications are started on the same display as the launching * applications are started on the same display as the launching
* application, by setting the <envar>DISPLAY</envar> environment variable. * application, by setting the `DISPLAY` environment variable.
* *
* Returns: a display string for the display. * Returns: a display string for the display.
*/ */
...@@ -980,8 +979,7 @@ g_app_launch_context_get_display (GAppLaunchContext *context, ...@@ -980,8 +979,7 @@ g_app_launch_context_get_display (GAppLaunchContext *context,
* @files: (element-type GFile): a #GList of of #GFile objects * @files: (element-type GFile): a #GList of of #GFile objects
* *
* Initiates startup notification for the application and returns the * Initiates startup notification for the application and returns the
* <envar>DESKTOP_STARTUP_ID</envar> for the launched operation, * `DESKTOP_STARTUP_ID` for the launched operation, if supported.
* if supported.
* *
* Startup notification IDs are defined in the <ulink * Startup notification IDs are defined in the <ulink
* url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"> * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
......
...@@ -67,9 +67,9 @@ ...@@ -67,9 +67,9 @@
* *
* The main use for #GApplicationCommandLine (and the * The main use for #GApplicationCommandLine (and the
* #GApplication::command-line signal) is 'Emacs server' like use cases: * #GApplication::command-line signal) is 'Emacs server' like use cases:
* You can set the <envar>EDITOR</envar> environment variable to have * You can set the `EDITOR` environment variable to have e.g. git use
* e.g. git use your favourite editor to edit commit messages, and if you * your favourite editor to edit commit messages, and if you already
* already have an instance of the editor running, the editing will happen * have an instance of the editor running, the editing will happen
* in the running instance, instead of opening a new one. An important * in the running instance, instead of opening a new one. An important
* aspect of this use case is that the process that gets started by git * aspect of this use case is that the process that gets started by git
* does not return until the editing is done. * does not return until the editing is done.
......
...@@ -1306,12 +1306,12 @@ g_desktop_app_info_new_from_filename (const char *filename) ...@@ -1306,12 +1306,12 @@ g_desktop_app_info_new_from_filename (const char *filename)
* *
* A desktop file id is the basename of the desktop file, including the * A desktop file id is the basename of the desktop file, including the
* .desktop extension. GIO is looking for a desktop file with this name * .desktop extension. GIO is looking for a desktop file with this name
* in the <filename>applications</filename> subdirectories of the XDG data * in the <filename>applications</filename> subdirectories of the XDG
* directories (i.e. the directories specified in the * data directories (i.e. the directories specified in the `XDG_DATA_HOME`
* <envar>XDG_DATA_HOME</envar> and <envar>XDG_DATA_DIRS</envar> environment * and `XDG_DATA_DIRS` environment variables). GIO also supports the
* variables). GIO also supports the prefix-to-subdirectory mapping that is * prefix-to-subdirectory mapping that is described in the
* described in the <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu Spec</ulink> * <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu
* (i.e. a desktop id of kde-foo.desktop will match * Spec</ulink> (i.e. a desktop id of kde-foo.desktop will match
* <filename>/usr/share/applications/kde/foo.desktop</filename>). * <filename>/usr/share/applications/kde/foo.desktop</filename>).
* *
* Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id * Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
......
...@@ -106,10 +106,10 @@ ...@@ -106,10 +106,10 @@
* You are expected to run this command after installing a * You are expected to run this command after installing a
* GIO module. * GIO module.
* *
* The <envar>GIO_EXTRA_MODULES</envar> environment variable can be * The `GIO_EXTRA_MODULES` environment variable can be used to
* used to specify additional directories to automatically load modules * specify additional directories to automatically load modules
* from. This environment variable has the same syntax as the * from. This environment variable has the same syntax as the
* <envar>PATH</envar>. If two modules have the same base name in different * `PATH`. If two modules have the same base name in different
* directories, then the latter one will be ignored. If additional * directories, then the latter one will be ignored. If additional
* directories are specified GIO will load modules from the built-in * directories are specified GIO will load modules from the built-in
* directory last. * directory last.
......
...@@ -66,15 +66,16 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref) ...@@ -66,15 +66,16 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* <literal>preprocess</literal> attribute to a comma-separated list of preprocessing options. * <literal>preprocess</literal> attribute to a comma-separated list of preprocessing options.
* The only options currently supported are: * The only options currently supported are:
* *
* <literal>xml-stripblanks</literal> which will use the xmllint command to strip * <literal>xml-stripblanks</literal> which will use the xmllint command
* ignorable whitespace from the xml file. For this to work, the <envar>XMLLINT</envar> * to strip ignorable whitespace from the xml file. For this to work,
* environment variable must be set to the full path to the xmllint executable, or xmllint * the `XMLLINT` environment variable must be set to the full path to
* must be in the PATH; otherwise the preprocessing step is skipped. * the xmllint executable, or xmllint must be in the `PATH`; otherwise
* the preprocessing step is skipped.
* *
* <literal>to-pixdata</literal> which will use the gdk-pixbuf-pixdata command to convert * <literal>to-pixdata</literal> which will use the gdk-pixbuf-pixdata command to convert
* images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside * images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
* the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata * the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata
* program must be in the PATH, or the <envar>GDK_PIXBUF_PIXDATA</envar> environment variable must be * program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be
* set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will * set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will
* abort. * abort.
* *
......
...@@ -1007,8 +1007,8 @@ g_settings_backend_verify (gpointer impl) ...@@ -1007,8 +1007,8 @@ g_settings_backend_verify (gpointer impl)
* g_settings_backend_get_default: * g_settings_backend_get_default:
* *
* Returns the default #GSettingsBackend. It is possible to override * Returns the default #GSettingsBackend. It is possible to override
* the default by setting the <envar>GSETTINGS_BACKEND</envar> * the default by setting the `GSETTINGS_BACKEND` environment variable
* environment variable to the name of a settings backend. * to the name of a settings backend.
* *
* The user gets a reference to the backend. * The user gets a reference to the backend.
* *
......
...@@ -363,9 +363,8 @@ initialise_schema_sources (void) ...@@ -363,9 +363,8 @@ initialise_schema_sources (void)
* *
* The returned source may actually consist of multiple schema sources * The returned source may actually consist of multiple schema sources
* from different directories, depending on which directories were given * from different directories, depending on which directories were given
* in <envar>XDG_DATA_DIRS</envar> and * in `XDG_DATA_DIRS` and `GSETTINGS_SCHEMA_DIR`. For this reason, all
* <envar>GSETTINGS_SCHEMA_DIR</envar>. For this reason, all lookups * lookups performed against the default source should probably be done
* performed against the default source should probably be done
* recursively. * recursively.
* *
* Returns: (transfer none): the default schema source * Returns: (transfer none): the default schema source
......
...@@ -371,12 +371,14 @@ _g_test_watcher_remove_pid (GPid pid) ...@@ -371,12 +371,14 @@ _g_test_watcher_remove_pid (GPid pid)
* and schema files are not yet installed, or worse; there is an older version of the * and schema files are not yet installed, or worse; there is an older version of the
* schema file sitting in the install location). * schema file sitting in the install location).
* *
* Most of the time we can work around these obstacles using the environment. Since the * Most of the time we can work around these obstacles using the
* environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn * environment. Since the environment is inherited by the D-Bus daemon
* inherited by any services the D-Bus daemon activates, using the setup routine for your * created by #GTestDBus and then in turn inherited by any services the
* fixture is a practical place to help sandbox your runtime environment. For the rather * D-Bus daemon activates, using the setup routine for your fixture is
* typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the * a practical place to help sandbox your runtime environment. For the
* in tree directory holding your schemas in the above fixture_setup() routine. * rather typical GSettings case we can work around this by setting
* `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
* in the above fixture_setup() routine.
* *
* The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
* by compiling the schemas locally as a step before running test cases, an autotools setup might * by compiling the schemas locally as a step before running test cases, an autotools setup might
......
...@@ -539,9 +539,9 @@ language_names_cache_free (gpointer data) ...@@ -539,9 +539,9 @@ language_names_cache_free (gpointer data)
* For example, if LANGUAGE=de:en_US, then the returned list is * For example, if LANGUAGE=de:en_US, then the returned list is
* "de", "en_US", "en", "C". * "de", "en_US", "en", "C".
* *
* This function consults the environment variables <envar>LANGUAGE</envar>, * This function consults the environment variables `LANGUAGE`, `LC_ALL`,
* <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar> * `LC_MESSAGES` and `LANG` to find the list of locales specified by the
* to find the list of locales specified by the user. * user.
* *
* Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib
* that must not be modified or freed. * that must not be modified or freed.
......
...@@ -108,7 +108,7 @@ ...@@ -108,7 +108,7 @@
* want to instruct Glib to use that particular encoding for file * want to instruct Glib to use that particular encoding for file
* names rather than UTF-8. You can do this by specifying the * names rather than UTF-8. You can do this by specifying the
* encoding for file names in the <link * encoding for file names in the <link
* linkend="G_FILENAME_ENCODING"><envar>G_FILENAME_ENCODING</envar></link> * linkend="G_FILENAME_ENCODING">`G_FILENAME_ENCODING`</link>
* environment variable. For example, if your installation uses * environment variable. For example, if your installation uses
* ISO-8859-1 for file names, you can put this in your * ISO-8859-1 for file names, you can put this in your
* <filename>~/.profile</filename>: * <filename>~/.profile</filename>:
...@@ -118,7 +118,7 @@ ...@@ -118,7 +118,7 @@
* Glib provides the functions g_filename_to_utf8() and * Glib provides the functions g_filename_to_utf8() and
* g_filename_from_utf8() to perform the necessary conversions. * g_filename_from_utf8() to perform the necessary conversions.
* These functions convert file names from the encoding specified * These functions convert file names from the encoding specified
* in <envar>G_FILENAME_ENCODING</envar> to UTF-8 and vice-versa. * in `G_FILENAME_ENCODING` to UTF-8 and vice-versa.
* <xref linkend="file-name-encodings-diagram"/> illustrates how * <xref linkend="file-name-encodings-diagram"/> illustrates how
* these functions are used to convert between UTF-8 and the * these functions are used to convert between UTF-8 and the
* encoding for file names in the file system. * encoding for file names in the file system.
...@@ -149,17 +149,17 @@ ...@@ -149,17 +149,17 @@
* *
* For example, the document window of a word processor could display * For example, the document window of a word processor could display
* "Unknown file name" in its title bar but still let the user save * "Unknown file name" in its title bar but still let the user save
* the file, as it would keep the raw file name internally. This can * the file, as it would keep the raw file name internally. This
* happen if the user has not set the <envar>G_FILENAME_ENCODING</envar> * can happen if the user has not set the `G_FILENAME_ENCODING`
* environment variable even though he has files whose names are not * environment variable even though he has files whose names are
* encoded in UTF-8. * not encoded in UTF-8.
* *
* 3. If your user interface lets the user type a file name for saving * 3. If your user interface lets the user type a file name for saving
* or renaming, convert it to the encoding used for file names in * or renaming, convert it to the encoding used for file names in
* the file system by using g_filename_from_utf8(). Pass the converted * the file system by using g_filename_from_utf8(). Pass the converted
* file name to functions like fopen(). If conversion fails, ask the * file name to functions like fopen(). If conversion fails, ask the
* user to enter a different file name. This can happen if the user * user to enter a different file name. This can happen if the user
* types Japanese characters when <envar>G_FILENAME_ENCODING</envar> * types Japanese characters when `G_FILENAME_ENCODING`
* is set to <literal>ISO-8859-1</literal>, for example. * is set to <literal>ISO-8859-1</literal>, for example.
*/ */
...@@ -982,24 +982,23 @@ filename_charset_cache_free (gpointer data) ...@@ -982,24 +982,23 @@ filename_charset_cache_free (gpointer data)
* representation of a filename, see g_filename_display_name(). * representation of a filename, see g_filename_display_name().
* *
* On Unix, the character sets are determined by consulting the * On Unix, the character sets are determined by consulting the
* environment variables <envar>G_FILENAME_ENCODING</envar> and * environment variables `G_FILENAME_ENCODING` and `G_BROKEN_FILENAMES`.
* <envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set * On Windows, the character set used in the GLib API is always UTF-8
* used in the GLib API is always UTF-8 and said environment variables * and said environment variables have no effect.
* have no effect.
* *
* <envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list * `G_FILENAME_ENCODING` may be set to a comma-separated list of
* of character set names. The special token "&commat;locale" is taken to * character set names. The special token "&commat;locale" is taken
* mean the character set for the <link linkend="setlocale">current * to mean the character set for the <link linkend="setlocale">current
* locale</link>. If <envar>G_FILENAME_ENCODING</envar> is not set, but * locale</link>. If `G_FILENAME_ENCODING` is not set, but
* <envar>G_BROKEN_FILENAMES</envar> is, the character set of the current * `G_BROKEN_FILENAMES` is, the character set of the current locale
* locale is taken as the filename encoding. If neither environment variable * is taken as the filename encoding. If neither environment variable
* is set, UTF-8 is taken as the filename encoding, but the character * is set, UTF-8 is taken as the filename encoding, but the character
* set of the current locale is also put in the list of encodings. * set of the current locale is also put in the list of encodings.
* *
* The returned @charsets belong to GLib and must not be freed. * The returned @charsets belong to GLib and must not be freed.
* *
* Note that on Unix, regardless of the locale character set or * Note that on Unix, regardless of the locale character set or
* <envar>G_FILENAME_ENCODING</envar> value, the actual file names present * `G_FILENAME_ENCODING` value, the actual file names present
* on a system might be in any random encoding or just gibberish. * on a system might be in any random encoding or just gibberish.
* *
* Return value: %TRUE if the filename encoding is UTF-8. * Return value: %TRUE if the filename encoding is UTF-8.
......
...@@ -72,8 +72,8 @@ ...@@ -72,8 +72,8 @@
* *
* The pathname argument should be in the GLib file name encoding. * The pathname argument should be in the GLib file name encoding.
* On POSIX this is the actual on-disk encoding which might correspond * On POSIX this is the actual on-disk encoding which might correspond
* to the locale settings of the process (or the * to the locale settings of the process (or the `G_FILENAME_ENCODING`
* <envar>G_FILENAME_ENCODING</envar> environment variable), or not. * environment variable), or not.
* *
* On Windows the GLib file name encoding is UTF-8. Note that the * On Windows the GLib file name encoding is UTF-8. Note that the
* Microsoft C library does not use UTF-8, but has separate APIs for * Microsoft C library does not use UTF-8, but has separate APIs for
...@@ -309,7 +309,7 @@ g_mkdir_with_parents (const gchar *pathname, ...@@ -309,7 +309,7 @@ g_mkdir_with_parents (const gchar *pathname,
* %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for * %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
* %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and * %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
* its name indicates that it is executable, checking for well-known * its name indicates that it is executable, checking for well-known
* extensions and those listed in the <envar>PATHEXT</envar> environment variable. * extensions and those listed in the `PATHEXT` environment variable.
* *
* Return value: whether a test was %TRUE * Return value: whether a test was %TRUE
**/ **/
......
...@@ -410,7 +410,7 @@ g_dgettext (const gchar *domain, ...@@ -410,7 +410,7 @@ g_dgettext (const gchar *domain,
* @category: a locale category * @category: a locale category
* *
* This is a variant of g_dgettext() that allows specifying a locale * This is a variant of g_dgettext() that allows specifying a locale
* category instead of always using <envar>LC_MESSAGES</envar>. See g_dgettext() for * category instead of always using `LC_MESSAGES`. See g_dgettext() for
* more information about how this functions differs from calling * more information about how this functions differs from calling
* dcgettext() directly. * dcgettext() directly.
* *
......
...@@ -118,8 +118,9 @@ ...@@ -118,8 +118,9 @@
* Key-value pairs generally have the form <literal>key=value</literal>, * Key-value pairs generally have the form <literal>key=value</literal>,
* with the exception of localized strings, which have the form * with the exception of localized strings, which have the form
* <literal>key[locale]=value</literal>, with a locale identifier of the * <literal>key[locale]=value</literal>, with a locale identifier of the
* form <literal>lang_COUNTRY@MODIFIER</literal> where * form <literal>lang_COUNTRY\@MODIFIER</literal>
* <literal>COUNTRY</literal> and <literal>MODIFIER</literal> are optional. * where <literal>COUNTRY</literal> and <literal>MODIFIER</literal>
* are optional.
* Space before and after the '=' character are ignored. Newline, tab, * Space before and after the '=' character are ignored. Newline, tab,
* carriage return and backslash characters in value are escaped as \n, * carriage return and backslash characters in value are escaped as \n,
* \t, \r, and \\, respectively. To preserve leading spaces in values, * \t, \r, and \\, respectively. To preserve leading spaces in values,
......
...@@ -45,7 +45,7 @@ G_STATIC_ASSERT (_g_alignof (GFunc) == _g_alignof (GCompareDataFunc)); ...@@ -45,7 +45,7 @@ G_STATIC_ASSERT (_g_alignof (GFunc) == _g_alignof (GCompareDataFunc));
/** /**
* g_mem_gc_friendly: * g_mem_gc_friendly:
* *
* This variable is %TRUE if the <envar>G_DEBUG</envar> environment variable * This variable is %TRUE if the `G_DEBUG` environment variable
* includes the key <literal>gc-friendly</literal>. * includes the key <literal>gc-friendly</literal>.
*/ */
#ifdef ENABLE_GC_FRIENDLY_DEFAULT #ifdef ENABLE_GC_FRIENDLY_DEFAULT
......
...@@ -173,13 +173,13 @@ ...@@ -173,13 +173,13 @@
* *
* A convenience function/macro to log a warning message. * A convenience function/macro to log a warning message.
* *
* You can make warnings fatal at runtime by setting the * You can make warnings fatal at runtime by setting the `G_DEBUG`
* <envar>G_DEBUG</envar> environment variable (see * environment variable (see <ulink url="glib-running.html">Running
* <ulink url="glib-running.html">Running GLib Applications</ulink>). * GLib Applications</ulink>).
* *
* If g_log_default_handler() is used as the log handler function, a new-line * If g_log_default_handler() is used as the log handler function,
* character will automatically be appended to @..., and need not be entered * a newline character will automatically be appended to @..., and
* manually. * need not be entered manually.
*/ */
/** /**
...@@ -195,7 +195,7 @@ ...@@ -195,7 +195,7 @@
* example. * example.
* *
* You can also make critical warnings fatal at runtime by * You can also make critical warnings fatal at runtime by
* setting the <envar>G_DEBUG</envar> environment variable (see * setting the `G_DEBUG` environment variable (see
* <ulink url="glib-running.html">Running GLib Applications</ulink>). * <ulink url="glib-running.html">Running GLib Applications</ulink>).
* *
* If g_log_default_handler() is used as the log handler function, a new-line * If g_log_default_handler() is used as the log handler function, a new-line
...@@ -449,7 +449,7 @@ g_log_domain_get_handler_L (GLogDomain *domain, ...@@ -449,7 +449,7 @@ g_log_domain_get_handler_L (GLogDomain *domain,
* %G_LOG_LEVEL_ERROR is always fatal. * %G_LOG_LEVEL_ERROR is always fatal.
* *
* You can also make some message levels fatal at runtime by setting * You can also make some message levels fatal at runtime by setting
* the <envar>G_DEBUG</envar> environment variable (see * the `G_DEBUG` environment variable (see
* <ulink url="glib-running.html">Running GLib Applications</ulink>). * <ulink url="glib-running.html">Running GLib Applications</ulink>).
* *
* Returns: the old fatal mask * Returns: the old fatal mask
...@@ -1345,13 +1345,13 @@ escape_string (GString *string) ...@@ -1345,13 +1345,13 @@ escape_string (GString *string)
* The behavior of this log handler can be influenced by a number of * The behavior of this log handler can be influenced by a number of
* environment variables: * environment variables:
* *
* - <envar>G_MESSAGES_PREFIXED</envar>: A :-separated list of log levels * - `G_MESSAGES_PREFIXED`: A :-separated list of log levels for which
* for which messages should be prefixed by the program name and PID of * messages should be prefixed by the program name and PID of the
* the aplication. * aplication.
* *
* - <envar>G_MESSAGES_DEBUG</envar>: A space-separated list of log domains * - `G_MESSAGES_DEBUG`: A space-separated list of log domains for
* for which debug and informational messages are printed. By default these * which debug and informational messages are printed. By default
* messages are not printed. * these messages are not printed.
* *
* stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL, * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL,
* %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for
......
...@@ -106,10 +106,9 @@ ...@@ -106,10 +106,9 @@
* *
* The original seeding and generation algorithms, as found in * The original seeding and generation algorithms, as found in
* GLib 2.0.x, can be used instead of the new ones by setting the * GLib 2.0.x, can be used instead of the new ones by setting the
* environment variable <envar>G_RANDOM_VERSION</envar> to the value * environment variable `G_RANDOM_VERSION` to the value of '2.0'.
* of '2.0'. Use the GLib-2.0 algorithms only if you have sequences * Use the GLib-2.0 algorithms only if you have sequences of numbers
* of numbers generated with Glib-2.0 that you need to reproduce * generated with Glib-2.0 that you need to reproduce exactly.
* exactly.
*/ */
/** /**
......
...@@ -470,18 +470,18 @@ g_spawn_sync (const gchar *working_directory, ...@@ -470,18 +470,18 @@ g_spawn_sync (const gchar *working_directory,
* *
* Executes a child program asynchronously (your program will not * Executes a child program asynchronously (your program will not
* block waiting for the child to exit). The child program is * block waiting for the child to exit). The child program is
* specified by the only argument that must be provided, @argv. @argv * specified by the only argument that must be provided, @argv.
* should be a %NULL-terminated array of strings, to be passed as the * @argv should be a %NULL-terminated array of strings, to be passed
* argument vector for the child. The first string in @argv is of * as the argument vector for the child. The first string in @argv
* course the name of the program to execute. By default, the name of * is of course the name of the program to execute. By default, the
* the program must be a full path. If @flags contains the * name of the program must be a full path. If @flags contains the
* %G_SPAWN_SEARCH_PATH flag, the <envar>PATH</envar> environment variable * %G_SPAWN_SEARCH_PATH flag, the `PATH` environment variable is
* is used to search for the executable. If @flags contains the * used to search for the executable. If @flags contains the
* %G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the <envar>PATH</envar> variable from * %G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the `PATH` variable from
* @envp is used to search for the executable. * @envp is used to search for the executable. If both the
* If both the %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP * %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP flags
* flags are set, the <envar>PATH</envar> variable from @envp takes precedence * are set, the `PATH` variable from @envp takes precedence over
* over the environment variable. * the environment variable.
* *
* If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not * If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not
* used, then the program will be run from the current directory (or * used, then the program will be run from the current directory (or
...@@ -543,15 +543,15 @@ g_spawn_sync (const gchar *working_directory, ...@@ -543,15 +543,15 @@ g_spawn_sync (const gchar *working_directory,
* *
* %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file * %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
* descriptors will be inherited by the child; otherwise all descriptors * descriptors will be inherited by the child; otherwise all descriptors
* except stdin/stdout/stderr will be closed before calling exec() in the * except stdin/stdout/stderr will be closed before calling exec() in
* child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an absolute * the child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an
* path, it will be looked for in the <envar>PATH</envar> environment * absolute path, it will be looked for in the `PATH` environment
* variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an absolute * variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an
* path, it will be looked for in the <envar>PATH</envar> variable from * absolute path, it will be looked for in the `PATH` variable from
* @envp. If both %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP * @envp. If both %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP
* are used, the value from @envp takes precedence over the environment. * are used, the value from @envp takes precedence over the environment.
* %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will * %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output
* be discarded, instead of going to the same location as the parent's * will be discarded, instead of going to the same location as the parent's
* standard output. If you use this flag, @standard_output must be %NULL. * standard output. If you use this flag, @standard_output must be %NULL.
* %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error * %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
* will be discarded, instead of going to the same location as the parent's * will be discarded, instead of going to the same location as the parent's
......
...@@ -320,7 +320,7 @@ ...@@ -320,7 +320,7 @@
* an error message is logged and the application is terminated. * an error message is logged and the application is terminated.
* *
* The macro can be turned off in final releases of code by defining * The macro can be turned off in final releases of code by defining
* <envar>G_DISABLE_ASSERT</envar> when compiling the application. * `G_DISABLE_ASSERT` when compiling the application.
*/ */
/** /**
...@@ -331,7 +331,7 @@ ...@@ -331,7 +331,7 @@
* application is terminated. * application is terminated.
* *
* The macro can be turned off in final releases of code by defining * The macro can be turned off in final releases of code by defining
* <envar>G_DISABLE_ASSERT</envar> when compiling the application. * `G_DISABLE_ASSERT` when compiling the application.
*/ */
/** /**
......
...@@ -1304,8 +1304,8 @@ rules_from_identifier (const gchar *identifier, ...@@ -1304,8 +1304,8 @@ rules_from_identifier (const gchar *identifier,
* Creates a #GTimeZone corresponding to @identifier. * Creates a #GTimeZone corresponding to @identifier.
* *
* @identifier can either be an RFC3339/ISO 8601 time offset or * @identifier can either be an RFC3339/ISO 8601 time offset or
* something that would pass as a valid value for the * something that would pass as a valid value for the `TZ` environment
* <envar>TZ</envar> environment variable (including %NULL). * variable (including %NULL).
* *
* In Windows, @identifier can also be the unlocalized name of a time * In Windows, @identifier can also be the unlocalized name of a time
* zone for standard time, for example "Pacific Standard Time". * zone for standard time, for example "Pacific Standard Time".
...@@ -1316,13 +1316,13 @@ rules_from_identifier (const gchar *identifier, ...@@ -1316,13 +1316,13 @@ rules_from_identifier (const gchar *identifier,
* time values to be added to Coordinated Universal Time (UTC) to get * time values to be added to Coordinated Universal Time (UTC) to get
* the local time. * the local time.
* *
* In Unix, the <envar>TZ</envar> environment variable typically * In Unix, the `TZ` environment variable typically corresponds
* corresponds to the name of a file in the zoneinfo database, or * to the name of a file in the zoneinfo database, or string in
* string in "std offset [dst [offset],start[/time],end[/time]]" * "std offset [dst [offset],start[/time],end[/time]]" (POSIX) format.
* (POSIX) format. There are no spaces in the specification. The * There are no spaces in the specification. The name of standard
* name of standard and daylight savings time zone must be three or more * and daylight savings time zone must be three or more alphabetic
* alphabetic characters. Offsets are time values to be added to local * characters. Offsets are time values to be added to local time to
* time to get Coordinated Universal Time (UTC) and should be * get Coordinated Universal Time (UTC) and should be
* <literal>"[±]hh[[:]mm[:ss]]"</literal>. Dates are either * <literal>"[±]hh[[:]mm[:ss]]"</literal>. Dates are either
* <literal>"Jn"</literal> (Julian day with n between 1 and 365, leap * <literal>"Jn"</literal> (Julian day with n between 1 and 365, leap
* years not counted), <literal>"n"</literal> (zero-based Julian day * years not counted), <literal>"n"</literal> (zero-based Julian day
...@@ -1339,17 +1339,17 @@ rules_from_identifier (const gchar *identifier, ...@@ -1339,17 +1339,17 @@ rules_from_identifier (const gchar *identifier,
* Coordinated Universal Time (UTC). * Coordinated Universal Time (UTC).
* *
* g_time_zone_new_local() calls this function with the value of the * g_time_zone_new_local() calls this function with the value of the
* <envar>TZ</envar> environment variable. This function itself is * `TZ` environment variable. This function itself is independent of
* independent of the value of <envar>TZ</envar>, but if @identifier * the value of `TZ`, but if @identifier is %NULL then
* is %NULL then <filename>/etc/localtime</filename> will be consulted * <filename>/etc/localtime</filename> will be consulted
* to discover the correct time zone on Unix and the registry will be * to discover the correct time zone on Unix and the registry will be
* consulted or GetTimeZoneInformation() will be used to get the local * consulted or GetTimeZoneInformation() will be used to get the local
* time zone on Windows. * time zone on Windows.
* *
* If intervals are not available, only time zone rules from * If intervals are not available, only time zone rules from `TZ`
* <envar>TZ</envar> environment variable or other means, then they * environment variable or other means, then they will be computed
* will be computed from year 1900 to 2037. If the maximum year for the * from year 1900 to 2037. If the maximum year for the rules is
* rules is available and it is greater than 2037, then it will followed * available and it is greater than 2037, then it will followed
* instead. * instead.
* *
* See <ulink * See <ulink
...@@ -1359,7 +1359,7 @@ rules_from_identifier (const gchar *identifier, ...@@ -1359,7 +1359,7 @@ rules_from_identifier (const gchar *identifier,
* full list of valid time offsets. See <ulink * full list of valid time offsets. See <ulink
* url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The * url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The
* GNU C Library manual</ulink> for an explanation of the possible * GNU C Library manual</ulink> for an explanation of the possible
* values of the <envar>TZ</envar> environment variable. See <ulink * values of the `TZ` environment variable. See <ulink
* url='http://msdn.microsoft.com/en-us/library/ms912391%28v=winembedded.11%29.aspx'> * url='http://msdn.microsoft.com/en-us/library/ms912391%28v=winembedded.11%29.aspx'>
* Microsoft Time Zone Index Values</ulink> for the list of time zones * Microsoft Time Zone Index Values</ulink> for the list of time zones
* on Windows. * on Windows.
...@@ -1492,9 +1492,8 @@ g_time_zone_new_utc (void) ...@@ -1492,9 +1492,8 @@ g_time_zone_new_utc (void)
* zone may change between invocations to this function; for example, * zone may change between invocations to this function; for example,
* if the system administrator changes it. * if the system administrator changes it.
* *
* This is equivalent to calling g_time_zone_new() with the value of the * This is equivalent to calling g_time_zone_new() with the value of
* <envar>TZ</envar> environment variable (including the possibility * the `TZ` environment variable (including the possibility of %NULL).
* of %NULL).
* *
* You should release the return value by calling g_time_zone_unref() * You should release the return value by calling g_time_zone_unref()
* when you are done with it. * when you are done with it.
......
...@@ -313,15 +313,15 @@ g_find_program_in_path (const gchar *program) ...@@ -313,15 +313,15 @@ g_find_program_in_path (const gchar *program)
* *
* On Windows, if @program does not have a file type suffix, tries * On Windows, if @program does not have a file type suffix, tries
* with the suffixes .exe, .cmd, .bat and .com, and the suffixes in * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
* the <envar>PATHEXT</envar> environment variable. * the `PATHEXT` environment variable.
* *
* On Windows, it looks for the file in the same way as CreateProcess() * On Windows, it looks for the file in the same way as CreateProcess()
* would. This means first in the directory where the executing * would. This means first in the directory where the executing
* program was loaded from, then in the current directory, then in the * program was loaded from, then in the current directory, then in the
* Windows 32-bit system directory, then in the Windows directory, and * Windows 32-bit system directory, then in the Windows directory, and
* finally in the directories in the <envar>PATH</envar> environment * finally in the directories in the `PATH` environment variable. If
* variable. If the program is found, the return value contains the * the program is found, the return value contains the full name
* full name including the type suffix. * including the type suffix.
* *
* Return value: a newly-allocated string with the absolute path, or %NULL * Return value: a newly-allocated string with the absolute path, or %NULL
**/ **/
...@@ -788,26 +788,25 @@ g_get_real_name (void) ...@@ -788,26 +788,25 @@ g_get_real_name (void)
* Gets the current user's home directory. * Gets the current user's home directory.
* *
* As with most UNIX tools, this function will return the value of the * As with most UNIX tools, this function will return the value of the
* <envar>HOME</envar> environment variable if it is set to an existing * `HOME` environment variable if it is set to an existing absolute path
* absolute path name, falling back to the <filename>passwd</filename> * name, falling back to the <filename>passwd</filename>
* file in the case that it is unset. * file in the case that it is unset.
* *
* If the path given in <envar>HOME</envar> is non-absolute, does not * If the path given in `HOME` is non-absolute, does not exist, or is
* exist, or is not a directory, the result is undefined. * not a directory, the result is undefined.
* *
* Before version 2.36 this function would ignore the * Before version 2.36 this function would ignore the `HOME` environment
* <envar>HOME</envar> environment variable, taking the value from the * variable, taking the value from the <filename>passwd</filename>
* <filename>passwd</filename> database instead. This was changed to * database instead. This was changed to increase the compatibility
* increase the compatibility of GLib with other programs (and the XDG * of GLib with other programs (and the XDG basedir specification)
* basedir specification) and to increase testability of programs * and to increase testability of programs based on GLib (by making
* based on GLib (by making it easier to run them from test * it easier to run them from test frameworks).
* frameworks).
* *
* If your program has a strong requirement for either the new or the * If your program has a strong requirement for either the new or the
* old behaviour (and if you don't wish to increase your GLib * old behaviour (and if you don't wish to increase your GLib
* dependency to ensure that the new behaviour is in effect) then you * dependency to ensure that the new behaviour is in effect) then you
* should either directly check the <envar>HOME</envar> environment * should either directly check the `HOME` environment variable yourself
* variable yourself or unset it before calling any functions in GLib. * or unset it before calling any functions in GLib.
* *
* Returns: the current user's home directory * Returns: the current user's home directory
*/ */
...@@ -892,17 +891,18 @@ g_get_home_dir (void) ...@@ -892,17 +891,18 @@ g_get_home_dir (void)
* *
* Gets the directory to use for temporary files. * Gets the directory to use for temporary files.
* *
* On UNIX, this is taken from the <envar>TMPDIR</envar> environment * On UNIX, this is taken from the `TMPDIR` environment variable.
* variable. If the variable is not set, <literal>P_tmpdir</literal> is * If the variable is not set, <literal>P_tmpdir</literal> is