Fix a doc typo.
[platform/upstream/glib.git] / glib / gshell.h
1 /* gshell.h - Shell-related utilities
2  *
3  *  Copyright 2000 Red Hat, Inc.
4  *
5  * GLib is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or (at your option) any later version.
9  *
10  * GLib is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with GLib; see the file COPYING.LIB.  If not, write
17  * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22 #error "Only <glib.h> can be included directly."
23 #endif
24
25 #ifndef __G_SHELL_H__
26 #define __G_SHELL_H__
27
28 #include <glib/gerror.h>
29
30 G_BEGIN_DECLS
31
32 #define G_SHELL_ERROR g_shell_error_quark ()
33
34 typedef enum
35 {
36   /* mismatched or otherwise mangled quoting */
37   G_SHELL_ERROR_BAD_QUOTING,
38   /* string to be parsed was empty */
39   G_SHELL_ERROR_EMPTY_STRING,
40   G_SHELL_ERROR_FAILED
41 } GShellError;
42
43 GQuark g_shell_error_quark (void);
44
45 gchar*   g_shell_quote      (const gchar   *unquoted_string);
46 gchar*   g_shell_unquote    (const gchar   *quoted_string,
47                              GError       **error);
48 gboolean g_shell_parse_argv (const gchar   *command_line,
49                              gint          *argcp,
50                              gchar       ***argvp,
51                              GError       **error);
52
53 G_END_DECLS
54
55 #endif /* __G_SHELL_H__ */