← Back to branch summary

~ubuntu-branches/ubuntu/karmic/ogmrip/karmic

« back to all changes in this revision

Viewing changes to docs/reference/ogmjob/xml/ogmjob-log.xml

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2009-09-21 19:49:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921194925-by5swrxkmnr07miv
Tags: 0.13.1-0.0ubuntu1
https://launchpad.net/bugs/434203
https://launchpad.net/bugs/434873
https://launchpad.net/bugs/424403
* Sync with Debian-multimedia.org (LP: #434203)
* Ubuntu remaining changes:
 - debian/rules:
  + Disable hal support by passing --disable-hal-support, to avoid crash when
    loading (LP: #434873).
 - debian/control:
  + Depends on mplayer-nogui | mplayer, ogmrip doesn't need the GUI of 
    mplayer (LP: #424403).
  + Recommends all ogmrip plugins and ogmrip-profiles.
  + Remove build-depends on libhal-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ogmjob/xml/ogmjob-log.xml
12
12
<refnamediv>
13
13
<refname>Logs</refname>
14
14
<refpurpose>Support for logging the output of spawns</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="ogmjob-ogmjob-log.synopsis" role="synopsis">
48
47
<para>
49
48
</para>
50
49
<para>
51
 
 
52
50
</para>
53
51
</refsect1>
54
52
 
56
54
<title role="details.title">Details</title>
57
55
<refsect2 id="ogmjob-log-open" role="function">
58
56
<title>ogmjob_log_open ()</title>
59
 
<indexterm zone="ogmjob-log-open"><primary>ogmjob_log_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_open                     (const <link linkend="gchar">gchar</link> *filename,
 
57
<indexterm zone="ogmjob-log-open"><primary sortas="ogmjob_log_open">ogmjob_log_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_open                     (const <link linkend="gchar">gchar</link> *filename,
60
58
                                                         <link linkend="GError">GError</link> **error);</programlisting>
61
59
<para>
62
60
Opens a new log file.</para>
63
61
<para>
64
 
 
65
62
</para><variablelist role="params">
66
 
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 
63
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
67
64
<listitem><simpara> A filename
68
65
</simpara></listitem></varlistentry>
69
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
66
<varlistentry><term><parameter>error</parameter>&#160;:</term>
70
67
<listitem><simpara> Location to store the error occuring, or NULL to ignore errors.
71
68
</simpara></listitem></varlistentry>
72
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, when no error
 
69
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, when no error
73
70
</simpara></listitem></varlistentry>
74
71
</variablelist></refsect2>
75
72
<refsect2 id="ogmjob-log-close" role="function">
76
73
<title>ogmjob_log_close ()</title>
77
 
<indexterm zone="ogmjob-log-close"><primary>ogmjob_log_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_close                    (<link linkend="GError">GError</link> **error);</programlisting>
 
74
<indexterm zone="ogmjob-log-close"><primary sortas="ogmjob_log_close">ogmjob_log_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_close                    (<link linkend="GError">GError</link> **error);</programlisting>
78
75
<para>
79
76
Closes the log file.</para>
80
77
<para>
81
 
 
82
78
</para><variablelist role="params">
83
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
79
<varlistentry><term><parameter>error</parameter>&#160;:</term>
84
80
<listitem><simpara> Location to store the error occuring, or NULL to ignore errors.
85
81
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, when no error
 
82
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, when no error
87
83
</simpara></listitem></varlistentry>
88
84
</variablelist></refsect2>
89
85
<refsect2 id="ogmjob-log-write" role="function">
90
86
<title>ogmjob_log_write ()</title>
91
 
<indexterm zone="ogmjob-log-write"><primary>ogmjob_log_write</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_write                    (const <link linkend="gchar">gchar</link> *str);</programlisting>
 
87
<indexterm zone="ogmjob-log-write"><primary sortas="ogmjob_log_write">ogmjob_log_write</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_write                    (const <link linkend="gchar">gchar</link> *str);</programlisting>
92
88
<para>
93
89
Logs some information on stdout, stderr, and/or a file.</para>
94
90
<para>
95
 
 
96
91
</para><variablelist role="params">
97
 
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
 
92
<varlistentry><term><parameter>str</parameter>&#160;:</term>
98
93
<listitem><simpara> A string to log
99
94
</simpara></listitem></varlistentry>
100
95
</variablelist></refsect2>
101
96
<refsect2 id="ogmjob-log-printf" role="function">
102
97
<title>ogmjob_log_printf ()</title>
103
 
<indexterm zone="ogmjob-log-printf"><primary>ogmjob_log_printf</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_printf                   (const <link linkend="gchar">gchar</link> *format,
 
98
<indexterm zone="ogmjob-log-printf"><primary sortas="ogmjob_log_printf">ogmjob_log_printf</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_printf                   (const <link linkend="gchar">gchar</link> *format,
104
99
                                                         ...);</programlisting>
105
100
<para>
106
101
Logs some formatted information on stdout, stderr, and/or a file.</para>
107
102
<para>
108
 
 
109
103
</para><variablelist role="params">
110
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
104
<varlistentry><term><parameter>format</parameter>&#160;:</term>
111
105
<listitem><simpara> A message format
112
106
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
107
<varlistentry><term><parameter>...</parameter>&#160;:</term>
114
108
<listitem><simpara> The parameters of the format string
115
109
</simpara></listitem></varlistentry>
116
110
</variablelist></refsect2>
117
111
<refsect2 id="ogmjob-log-set-print-stdout" role="function">
118
112
<title>ogmjob_log_set_print_stdout ()</title>
119
 
<indexterm zone="ogmjob-log-set-print-stdout"><primary>ogmjob_log_set_print_stdout</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_set_print_stdout         (<link linkend="gboolean">gboolean</link> log_stdout);</programlisting>
 
113
<indexterm zone="ogmjob-log-set-print-stdout"><primary sortas="ogmjob_log_set_print_stdout">ogmjob_log_set_print_stdout</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_set_print_stdout         (<link linkend="gboolean">gboolean</link> log_stdout);</programlisting>
120
114
<para>
121
115
Sets whether to log information on stdout.</para>
122
116
<para>
123
 
 
124
117
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>log_stdout</parameter>&nbsp;:</term>
126
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to log on stdout
 
118
<varlistentry><term><parameter>log_stdout</parameter>&#160;:</term>
 
119
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to log on stdout
127
120
</simpara></listitem></varlistentry>
128
121
</variablelist></refsect2>
129
122
<refsect2 id="ogmjob-log-get-print-stdout" role="function">
130
123
<title>ogmjob_log_get_print_stdout ()</title>
131
 
<indexterm zone="ogmjob-log-get-print-stdout"><primary>ogmjob_log_get_print_stdout</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_get_print_stdout         (void);</programlisting>
 
124
<indexterm zone="ogmjob-log-get-print-stdout"><primary sortas="ogmjob_log_get_print_stdout">ogmjob_log_get_print_stdout</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_get_print_stdout         (void);</programlisting>
132
125
<para>
133
126
Gets whether to log information on stdout.</para>
134
127
<para>
135
 
 
136
128
</para><variablelist role="params">
137
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if log on stdout
 
129
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if log on stdout
138
130
</simpara></listitem></varlistentry>
139
131
</variablelist></refsect2>
140
132
<refsect2 id="ogmjob-log-set-print-stderr" role="function">
141
133
<title>ogmjob_log_set_print_stderr ()</title>
142
 
<indexterm zone="ogmjob-log-set-print-stderr"><primary>ogmjob_log_set_print_stderr</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_set_print_stderr         (<link linkend="gboolean">gboolean</link> log_stderr);</programlisting>
 
134
<indexterm zone="ogmjob-log-set-print-stderr"><primary sortas="ogmjob_log_set_print_stderr">ogmjob_log_set_print_stderr</primary></indexterm><programlisting><link linkend="void">void</link>                ogmjob_log_set_print_stderr         (<link linkend="gboolean">gboolean</link> log_stderr);</programlisting>
143
135
<para>
144
136
Sets whether to log information on stderr.</para>
145
137
<para>
146
 
 
147
138
</para><variablelist role="params">
148
 
<varlistentry><term><parameter>log_stderr</parameter>&nbsp;:</term>
149
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to log on stderr
 
139
<varlistentry><term><parameter>log_stderr</parameter>&#160;:</term>
 
140
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to log on stderr
150
141
</simpara></listitem></varlistentry>
151
142
</variablelist></refsect2>
152
143
<refsect2 id="ogmjob-log-get-print-stderr" role="function">
153
144
<title>ogmjob_log_get_print_stderr ()</title>
154
 
<indexterm zone="ogmjob-log-get-print-stderr"><primary>ogmjob_log_get_print_stderr</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_get_print_stderr         (void);</programlisting>
 
145
<indexterm zone="ogmjob-log-get-print-stderr"><primary sortas="ogmjob_log_get_print_stderr">ogmjob_log_get_print_stderr</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ogmjob_log_get_print_stderr         (void);</programlisting>
155
146
<para>
156
147
Gets whether to log information on stderr.</para>
157
148
<para>
158
 
 
159
149
</para><variablelist role="params">
160
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if log on stderr
 
150
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if log on stderr
161
151
</simpara></listitem></varlistentry>
162
152
</variablelist></refsect2>
163
153