* SECTION:shell
* @title: Shell-related Utilities
* @short_description: shell-like commandline handling
- **/
+ *
+ * GLib provides the functions g_shell_quote() and g_shell_unquote()
+ * to handle shell-like quoting in strings. The function g_shell_parse_argv()
+ * parses a string similar to the way a POSIX shell (/bin/sh) would.
+ *
+ * Note that string handling in shells has many obscure and historical
+ * corner-cases which these functions do not necessarily reproduce. They
+ * are good enough in practice, though.
+ */
/**
* G_SHELL_ERROR:
* quoting style used is undefined (single or double quotes may be
* used).
*
- * Return value: quoted string
+ * Returns: quoted string
**/
gchar*
g_shell_quote (const gchar *unquoted_string)
* be escaped with backslash. Otherwise double quotes preserve things
* literally.
*
- * Return value: an unquoted string
+ * Returns: an unquoted string
**/
gchar*
g_shell_unquote (const gchar *quoted_string,
/**
* g_shell_parse_argv:
* @command_line: command line to parse
- * @argcp: (out): return location for number of args
- * @argvp: (out) (array length=argcp zero-terminated=1): return location for array of args
- * @error: return location for error
+ * @argcp: (out) (optional): return location for number of args, or %NULL
+ * @argvp: (out) (optional) (array length=argcp zero-terminated=1): return
+ * location for array of args, or %NULL
+ * @error: (optional): return location for error, or %NULL
*
* Parses a command line into an argument vector, in much the same way
* the shell would, but without many of the expansions the shell would
* literally. Possible errors are those from the #G_SHELL_ERROR
* domain. Free the returned vector with g_strfreev().
*
- * Return value: %TRUE on success, %FALSE if error set
+ * Returns: %TRUE on success, %FALSE if error set
**/
gboolean
g_shell_parse_argv (const gchar *command_line,