← Back to branch summary

~ubuntu-branches/ubuntu/feisty/libgnome/feisty

« back to all changes in this revision

Viewing changes to doc/reference/xml/gnome-config.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-09-07 18:03:53 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050907180353-hf71fcfx1nb0omez
Tags: 2.12.0.1-0ubuntu1
* New upstream realease:
  - Bug fixes
    - Fix schemas install problem with vi translation (Rodney)
  - Updated translations
    - Vietnamese
* debian/patches/fix-vi.po.patch:
  - dropped, done upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/gnome-config.xml
255
255
<title>Details</title>
256
256
<refsect2>
257
257
<title><anchor id="gnome-config-get-string"/>gnome_config_get_string()</title>
258
 
<indexterm><primary>gnome_config_get_string</primary></indexterm><programlisting>#define     gnome_config_get_string(path)</programlisting>
 
258
<indexterm role="deprecated"><primary>gnome_config_get_string</primary></indexterm><programlisting>#define     gnome_config_get_string(path)</programlisting>
259
259
<warning><para><literal>gnome_config_get_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
260
260
<para>
261
261
Retrieves the value of a configuration item as a string. This value should
266
266
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
267
267
<listitem><simpara> A gnome configuration path to an item.
268
268
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item as a string.
 
269
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item as a string.
270
270
</simpara></listitem></varlistentry>
271
271
</variablelist></refsect2>
272
272
<refsect2>
273
273
<title><anchor id="gnome-config-get-string-with-default"/>gnome_config_get_string_with_default()</title>
274
 
<indexterm><primary>gnome_config_get_string_with_default</primary></indexterm><programlisting>#define     gnome_config_get_string_with_default(path,def)</programlisting>
 
274
<indexterm role="deprecated"><primary>gnome_config_get_string_with_default</primary></indexterm><programlisting>#define     gnome_config_get_string_with_default(path,def)</programlisting>
275
275
<warning><para><literal>gnome_config_get_string_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
276
276
<para>
277
277
Retrieves the value of a configuration item as a string. This value should
286
286
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
287
287
is returned.
288
288
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item as a string, or <parameter>def</parameter> if the
 
289
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item as a string, or <parameter>def</parameter> if the
290
290
configuration key does not exist.
291
291
</simpara></listitem></varlistentry>
292
292
</variablelist></refsect2>
293
293
<refsect2>
294
294
<title><anchor id="gnome-config-get-translated-string"/>gnome_config_get_translated_string()</title>
295
 
<indexterm><primary>gnome_config_get_translated_string</primary></indexterm><programlisting>#define     gnome_config_get_translated_string(path)</programlisting>
 
295
<indexterm role="deprecated"><primary>gnome_config_get_translated_string</primary></indexterm><programlisting>#define     gnome_config_get_translated_string(path)</programlisting>
296
296
<warning><para><literal>gnome_config_get_translated_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
297
297
<para>
298
298
Retrieves the value of a configuration item as a string appropriate for the
304
304
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
305
305
<listitem><simpara> A gnome configuration path to an item.
306
306
</simpara></listitem></varlistentry>
307
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item.
 
307
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item.
308
308
</simpara></listitem></varlistentry>
309
309
</variablelist></refsect2>
310
310
<refsect2>
311
311
<title><anchor id="gnome-config-get-translated-string-with-default"/>gnome_config_get_translated_string_with_default()</title>
312
 
<indexterm><primary>gnome_config_get_translated_string_with_default</primary></indexterm><programlisting>#define     gnome_config_get_translated_string_with_default(path,def)</programlisting>
 
312
<indexterm role="deprecated"><primary>gnome_config_get_translated_string_with_default</primary></indexterm><programlisting>#define     gnome_config_get_translated_string_with_default(path,def)</programlisting>
313
313
<warning><para><literal>gnome_config_get_translated_string_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
314
314
<para>
315
315
Retrieves the value of a configuration item as a string appropriate for the
325
325
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
326
326
is returned.
327
327
</simpara></listitem></varlistentry>
328
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item or <parameter>def</parameter> if the configuration
 
328
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item or <parameter>def</parameter> if the configuration
329
329
item does not exist.
330
330
</simpara></listitem></varlistentry>
331
331
</variablelist></refsect2>
332
332
<refsect2>
333
333
<title><anchor id="gnome-config-private-get-string"/>gnome_config_private_get_string()</title>
334
 
<indexterm><primary>gnome_config_private_get_string</primary></indexterm><programlisting>#define     gnome_config_private_get_string(path)</programlisting>
 
334
<indexterm role="deprecated"><primary>gnome_config_private_get_string</primary></indexterm><programlisting>#define     gnome_config_private_get_string(path)</programlisting>
335
335
<warning><para><literal>gnome_config_private_get_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
336
336
<para>
337
337
Retrieves the value of a configuration item from the user's private
343
343
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
344
344
<listitem><simpara> A gnome configuration path to an item in the user-private namespace.
345
345
</simpara></listitem></varlistentry>
346
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item as a string.
 
346
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item as a string.
347
347
</simpara></listitem></varlistentry>
348
348
</variablelist></refsect2>
349
349
<refsect2>
350
350
<title><anchor id="gnome-config-private-get-string-with-default"/>gnome_config_private_get_string_with_default()</title>
351
 
<indexterm><primary>gnome_config_private_get_string_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_string_with_default(path,def)</programlisting>
 
351
<indexterm role="deprecated"><primary>gnome_config_private_get_string_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_string_with_default(path,def)</programlisting>
352
352
<warning><para><literal>gnome_config_private_get_string_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
353
353
<para>
354
354
Retrieves the value of a configuration item from the user's private
364
364
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
365
365
is returned.
366
366
</simpara></listitem></varlistentry>
367
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item as a string, or <parameter>def</parameter> if the
 
367
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item as a string, or <parameter>def</parameter> if the
368
368
configuration key does not exist.
369
369
</simpara></listitem></varlistentry>
370
370
</variablelist></refsect2>
371
371
<refsect2>
372
372
<title><anchor id="gnome-config-private-get-translated-string"/>gnome_config_private_get_translated_string()</title>
373
 
<indexterm><primary>gnome_config_private_get_translated_string</primary></indexterm><programlisting>#define     gnome_config_private_get_translated_string(path)</programlisting>
 
373
<indexterm role="deprecated"><primary>gnome_config_private_get_translated_string</primary></indexterm><programlisting>#define     gnome_config_private_get_translated_string(path)</programlisting>
374
374
<warning><para><literal>gnome_config_private_get_translated_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
375
375
<para>
376
376
Retrieves the value of a configuration item as a string appropriate for the
383
383
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
384
384
<listitem><simpara> A gnome configuration path to an item in the user-private namespace.
385
385
</simpara></listitem></varlistentry>
386
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item.
 
386
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item.
387
387
</simpara></listitem></varlistentry>
388
388
</variablelist></refsect2>
389
389
<refsect2>
390
390
<title><anchor id="gnome-config-private-get-translated-string-with-default"/>gnome_config_private_get_translated_string_with_default()</title>
391
 
<indexterm><primary>gnome_config_private_get_translated_string_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_translated_string_with_default(path,def)</programlisting>
 
391
<indexterm role="deprecated"><primary>gnome_config_private_get_translated_string_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_translated_string_with_default(path,def)</programlisting>
392
392
<warning><para><literal>gnome_config_private_get_translated_string_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
393
393
<para>
394
394
Retrieves the value of a configuration item as a string appropriate for the
405
405
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
406
406
is returned.
407
407
</simpara></listitem></varlistentry>
408
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the configuration item or <parameter>def</parameter> if the configuration
 
408
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of the configuration item or <parameter>def</parameter> if the configuration
409
409
item does not exist.
410
410
</simpara></listitem></varlistentry>
411
411
</variablelist></refsect2>
412
412
<refsect2>
413
413
<title><anchor id="gnome-config-set-string"/>gnome_config_set_string()</title>
414
 
<indexterm><primary>gnome_config_set_string</primary></indexterm><programlisting>#define     gnome_config_set_string(path,new_value)</programlisting>
 
414
<indexterm role="deprecated"><primary>gnome_config_set_string</primary></indexterm><programlisting>#define     gnome_config_set_string(path,new_value)</programlisting>
415
415
<warning><para><literal>gnome_config_set_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
416
416
<para>
417
417
Stores the string value <parameter>new_value</parameter> in the file/section/key
428
428
</variablelist></refsect2>
429
429
<refsect2>
430
430
<title><anchor id="gnome-config-set-translated-string"/>gnome_config_set_translated_string()</title>
431
 
<indexterm><primary>gnome_config_set_translated_string</primary></indexterm><programlisting>#define     gnome_config_set_translated_string(path,value)</programlisting>
 
431
<indexterm role="deprecated"><primary>gnome_config_set_translated_string</primary></indexterm><programlisting>#define     gnome_config_set_translated_string(path,value)</programlisting>
432
432
<warning><para><literal>gnome_config_set_translated_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
433
433
<para>
434
434
Stores the string value <parameter>value</parameter> in the file/section/key defined
446
446
</variablelist></refsect2>
447
447
<refsect2>
448
448
<title><anchor id="gnome-config-private-set-string"/>gnome_config_private_set_string()</title>
449
 
<indexterm><primary>gnome_config_private_set_string</primary></indexterm><programlisting>#define     gnome_config_private_set_string(path,new_value)</programlisting>
 
449
<indexterm role="deprecated"><primary>gnome_config_private_set_string</primary></indexterm><programlisting>#define     gnome_config_private_set_string(path,new_value)</programlisting>
450
450
<warning><para><literal>gnome_config_private_set_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
451
451
<para>
452
452
Stores the string value <parameter>new_value</parameter> in the file/section/key
464
464
</variablelist></refsect2>
465
465
<refsect2>
466
466
<title><anchor id="gnome-config-private-set-translated-string"/>gnome_config_private_set_translated_string()</title>
467
 
<indexterm><primary>gnome_config_private_set_translated_string</primary></indexterm><programlisting>#define     gnome_config_private_set_translated_string(path,new_value)</programlisting>
 
467
<indexterm role="deprecated"><primary>gnome_config_private_set_translated_string</primary></indexterm><programlisting>#define     gnome_config_private_set_translated_string(path,new_value)</programlisting>
468
468
<warning><para><literal>gnome_config_private_set_translated_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
469
469
<para>
470
470
Stores the string value <parameter>new_value</parameter> in the file/section/key defined by the
482
482
</variablelist></refsect2>
483
483
<refsect2>
484
484
<title><anchor id="gnome-config-get-int"/>gnome_config_get_int()</title>
485
 
<indexterm><primary>gnome_config_get_int</primary></indexterm><programlisting>#define     gnome_config_get_int(path)</programlisting>
 
485
<indexterm role="deprecated"><primary>gnome_config_get_int</primary></indexterm><programlisting>#define     gnome_config_get_int(path)</programlisting>
486
486
<warning><para><literal>gnome_config_get_int</literal> is deprecated and should not be used in newly-written code.</para></warning>
487
487
<para>
488
488
Retrieves an integer value configuration item.</para>
492
492
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
493
493
<listitem><simpara> A gnome configuration path to an item.
494
494
</simpara></listitem></varlistentry>
495
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item.
 
495
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item.
496
496
</simpara></listitem></varlistentry>
497
497
</variablelist></refsect2>
498
498
<refsect2>
499
499
<title><anchor id="gnome-config-get-int-with-default"/>gnome_config_get_int_with_default()</title>
500
 
<indexterm><primary>gnome_config_get_int_with_default</primary></indexterm><programlisting>#define     gnome_config_get_int_with_default(path,def)</programlisting>
 
500
<indexterm role="deprecated"><primary>gnome_config_get_int_with_default</primary></indexterm><programlisting>#define     gnome_config_get_int_with_default(path,def)</programlisting>
501
501
<warning><para><literal>gnome_config_get_int_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
502
502
<para>
503
503
Retrieves an integer value configuration item.</para>
511
511
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
512
512
is returned.
513
513
</simpara></listitem></varlistentry>
514
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as an integer or <parameter>def</parameter> if the
 
514
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as an integer or <parameter>def</parameter> if the
515
515
configuration item does not exist.
516
516
</simpara></listitem></varlistentry>
517
517
</variablelist></refsect2>
518
518
<refsect2>
519
519
<title><anchor id="gnome-config-private-get-int"/>gnome_config_private_get_int()</title>
520
 
<indexterm><primary>gnome_config_private_get_int</primary></indexterm><programlisting>#define     gnome_config_private_get_int(path)</programlisting>
 
520
<indexterm role="deprecated"><primary>gnome_config_private_get_int</primary></indexterm><programlisting>#define     gnome_config_private_get_int(path)</programlisting>
521
521
<warning><para><literal>gnome_config_private_get_int</literal> is deprecated and should not be used in newly-written code.</para></warning>
522
522
<para>
523
523
Retrieves a configuration item as an int from the user's private
528
528
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
529
529
<listitem><simpara> A gnome configuration path to an item in the user-private namespace.
530
530
</simpara></listitem></varlistentry>
531
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as an integer.
 
531
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as an integer.
532
532
</simpara></listitem></varlistentry>
533
533
</variablelist></refsect2>
534
534
<refsect2>
535
535
<title><anchor id="gnome-config-private-get-int-with-default"/>gnome_config_private_get_int_with_default()</title>
536
 
<indexterm><primary>gnome_config_private_get_int_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_int_with_default(path,def)</programlisting>
 
536
<indexterm role="deprecated"><primary>gnome_config_private_get_int_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_int_with_default(path,def)</programlisting>
537
537
<warning><para><literal>gnome_config_private_get_int_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
538
538
<para>
539
539
Retrieves a configuration item as an int from the user's private
548
548
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
549
549
is returned.
550
550
</simpara></listitem></varlistentry>
551
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as an integer or <parameter>def</parameter> if the
 
551
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as an integer or <parameter>def</parameter> if the
552
552
configuration item does not exist.
553
553
</simpara></listitem></varlistentry>
554
554
</variablelist></refsect2>
555
555
<refsect2>
556
556
<title><anchor id="gnome-config-set-int"/>gnome_config_set_int()</title>
557
 
<indexterm><primary>gnome_config_set_int</primary></indexterm><programlisting>#define     gnome_config_set_int(path,new_value)</programlisting>
 
557
<indexterm role="deprecated"><primary>gnome_config_set_int</primary></indexterm><programlisting>#define     gnome_config_set_int(path,new_value)</programlisting>
558
558
<warning><para><literal>gnome_config_set_int</literal> is deprecated and should not be used in newly-written code.</para></warning>
559
559
<para>
560
560
Stores the integer value <parameter>new_value</parameter> in the file/section/key
571
571
</variablelist></refsect2>
572
572
<refsect2>
573
573
<title><anchor id="gnome-config-private-set-int"/>gnome_config_private_set_int()</title>
574
 
<indexterm><primary>gnome_config_private_set_int</primary></indexterm><programlisting>#define     gnome_config_private_set_int(path,new_value)</programlisting>
 
574
<indexterm role="deprecated"><primary>gnome_config_private_set_int</primary></indexterm><programlisting>#define     gnome_config_private_set_int(path,new_value)</programlisting>
575
575
<warning><para><literal>gnome_config_private_set_int</literal> is deprecated and should not be used in newly-written code.</para></warning>
576
576
<para>
577
577
Stores the integer value <parameter>new_value</parameter> in the file/section/key
589
589
</variablelist></refsect2>
590
590
<refsect2>
591
591
<title><anchor id="gnome-config-get-float"/>gnome_config_get_float()</title>
592
 
<indexterm><primary>gnome_config_get_float</primary></indexterm><programlisting>#define     gnome_config_get_float(path)</programlisting>
 
592
<indexterm role="deprecated"><primary>gnome_config_get_float</primary></indexterm><programlisting>#define     gnome_config_get_float(path)</programlisting>
593
593
<warning><para><literal>gnome_config_get_float</literal> is deprecated and should not be used in newly-written code.</para></warning>
594
594
<para>
595
595
Retrieves a floating-point valued configuration item.</para>
599
599
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
600
600
<listitem><simpara> A gnome configuration path to an item.
601
601
</simpara></listitem></varlistentry>
602
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item.
 
602
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item.
603
603
</simpara></listitem></varlistentry>
604
604
</variablelist></refsect2>
605
605
<refsect2>
606
606
<title><anchor id="gnome-config-get-float-with-default"/>gnome_config_get_float_with_default()</title>
607
 
<indexterm><primary>gnome_config_get_float_with_default</primary></indexterm><programlisting>#define     gnome_config_get_float_with_default(path,def)</programlisting>
 
607
<indexterm role="deprecated"><primary>gnome_config_get_float_with_default</primary></indexterm><programlisting>#define     gnome_config_get_float_with_default(path,def)</programlisting>
608
608
<warning><para><literal>gnome_config_get_float_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
609
609
<para>
610
610
Retrieves a floating-point valued configuration item.</para>
618
618
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
619
619
is returned.
620
620
</simpara></listitem></varlistentry>
621
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as a floating-point
 
621
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as a floating-point
622
622
number or <parameter>def</parameter> if the configuration item does not exist.
623
623
</simpara></listitem></varlistentry>
624
624
</variablelist></refsect2>
625
625
<refsect2>
626
626
<title><anchor id="gnome-config-private-get-float"/>gnome_config_private_get_float()</title>
627
 
<indexterm><primary>gnome_config_private_get_float</primary></indexterm><programlisting>#define     gnome_config_private_get_float(path)</programlisting>
 
627
<indexterm role="deprecated"><primary>gnome_config_private_get_float</primary></indexterm><programlisting>#define     gnome_config_private_get_float(path)</programlisting>
628
628
<warning><para><literal>gnome_config_private_get_float</literal> is deprecated and should not be used in newly-written code.</para></warning>
629
629
<para>
630
630
Retrieves a configuration item from the user's private configuration storage
635
635
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
636
636
<listitem><simpara> A gnome configuration path to an item in the user-private namespace.
637
637
</simpara></listitem></varlistentry>
638
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as a floating-point
 
638
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as a floating-point
639
639
number.
640
640
</simpara></listitem></varlistentry>
641
641
</variablelist></refsect2>
642
642
<refsect2>
643
643
<title><anchor id="gnome-config-private-get-float-with-default"/>gnome_config_private_get_float_with_default()</title>
644
 
<indexterm><primary>gnome_config_private_get_float_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_float_with_default(path,def)</programlisting>
 
644
<indexterm role="deprecated"><primary>gnome_config_private_get_float_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_float_with_default(path,def)</programlisting>
645
645
<warning><para><literal>gnome_config_private_get_float_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
646
646
<para>
647
647
Retrieves a configuration item from the user's private configuration storage
656
656
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
657
657
is returned.
658
658
</simpara></listitem></varlistentry>
659
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as a floating-point
 
659
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as a floating-point
660
660
number or <parameter>def</parameter> if the configuration item does not exist.
661
661
</simpara></listitem></varlistentry>
662
662
</variablelist></refsect2>
663
663
<refsect2>
664
664
<title><anchor id="gnome-config-set-float"/>gnome_config_set_float()</title>
665
 
<indexterm><primary>gnome_config_set_float</primary></indexterm><programlisting>#define     gnome_config_set_float(path,new_value)</programlisting>
 
665
<indexterm role="deprecated"><primary>gnome_config_set_float</primary></indexterm><programlisting>#define     gnome_config_set_float(path,new_value)</programlisting>
666
666
<warning><para><literal>gnome_config_set_float</literal> is deprecated and should not be used in newly-written code.</para></warning>
667
667
<para>
668
668
Stores the double value <parameter>new_value</parameter> in the file/section/key
679
679
</variablelist></refsect2>
680
680
<refsect2>
681
681
<title><anchor id="gnome-config-private-set-float"/>gnome_config_private_set_float()</title>
682
 
<indexterm><primary>gnome_config_private_set_float</primary></indexterm><programlisting>#define     gnome_config_private_set_float(path,new_value)</programlisting>
 
682
<indexterm role="deprecated"><primary>gnome_config_private_set_float</primary></indexterm><programlisting>#define     gnome_config_private_set_float(path,new_value)</programlisting>
683
683
<warning><para><literal>gnome_config_private_set_float</literal> is deprecated and should not be used in newly-written code.</para></warning>
684
684
<para>
685
685
Stores the double value <parameter>new_value</parameter> in the file/section/key
697
697
</variablelist></refsect2>
698
698
<refsect2>
699
699
<title><anchor id="gnome-config-get-bool"/>gnome_config_get_bool()</title>
700
 
<indexterm><primary>gnome_config_get_bool</primary></indexterm><programlisting>#define     gnome_config_get_bool(path)</programlisting>
 
700
<indexterm role="deprecated"><primary>gnome_config_get_bool</primary></indexterm><programlisting>#define     gnome_config_get_bool(path)</programlisting>
701
701
<warning><para><literal>gnome_config_get_bool</literal> is deprecated and should not be used in newly-written code.</para></warning>
702
702
<para>
703
703
Retrieves a boolean configuration value.</para>
707
707
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
708
708
<listitem><simpara> A gnome configuration path to an item.
709
709
</simpara></listitem></varlistentry>
710
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item.
 
710
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item.
711
711
</simpara></listitem></varlistentry>
712
712
</variablelist></refsect2>
713
713
<refsect2>
714
714
<title><anchor id="gnome-config-get-bool-with-default"/>gnome_config_get_bool_with_default()</title>
715
 
<indexterm><primary>gnome_config_get_bool_with_default</primary></indexterm><programlisting>#define     gnome_config_get_bool_with_default(path,def)</programlisting>
 
715
<indexterm role="deprecated"><primary>gnome_config_get_bool_with_default</primary></indexterm><programlisting>#define     gnome_config_get_bool_with_default(path,def)</programlisting>
716
716
<warning><para><literal>gnome_config_get_bool_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
717
717
<para>
718
718
Retrieves a boolean configuration value.</para>
726
726
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
727
727
is returned.
728
728
</simpara></listitem></varlistentry>
729
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item, or <parameter>def</parameter> if the
 
729
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item, or <parameter>def</parameter> if the
730
730
configuration item does not exist.
731
731
</simpara></listitem></varlistentry>
732
732
</variablelist></refsect2>
733
733
<refsect2>
734
734
<title><anchor id="gnome-config-private-get-bool"/>gnome_config_private_get_bool()</title>
735
 
<indexterm><primary>gnome_config_private_get_bool</primary></indexterm><programlisting>#define     gnome_config_private_get_bool(path)</programlisting>
 
735
<indexterm role="deprecated"><primary>gnome_config_private_get_bool</primary></indexterm><programlisting>#define     gnome_config_private_get_bool(path)</programlisting>
736
736
<warning><para><literal>gnome_config_private_get_bool</literal> is deprecated and should not be used in newly-written code.</para></warning>
737
737
<para>
738
738
Retrieves the item from the user's private configuration storage area.</para>
742
742
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
743
743
<listitem><simpara> A gnome configuration path to an item in the user-private namespace.
744
744
</simpara></listitem></varlistentry>
745
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as a boolean.
 
745
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as a boolean.
746
746
</simpara></listitem></varlistentry>
747
747
</variablelist></refsect2>
748
748
<refsect2>
749
749
<title><anchor id="gnome-config-private-get-bool-with-default"/>gnome_config_private_get_bool_with_default()</title>
750
 
<indexterm><primary>gnome_config_private_get_bool_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_bool_with_default(path,def)</programlisting>
 
750
<indexterm role="deprecated"><primary>gnome_config_private_get_bool_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_bool_with_default(path,def)</programlisting>
751
751
<warning><para><literal>gnome_config_private_get_bool_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
752
752
<para>
753
753
Retrieves the item from the user's private configuration storage area.</para>
761
761
<listitem><simpara> A pointer to a flag that will be set if the default value for the item
762
762
is returned.
763
763
</simpara></listitem></varlistentry>
764
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of a configuration item as a boolean, or <parameter>def</parameter> if the
 
764
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The value of a configuration item as a boolean, or <parameter>def</parameter> if the
765
765
configuration item does not exist.
766
766
</simpara></listitem></varlistentry>
767
767
</variablelist></refsect2>
768
768
<refsect2>
769
769
<title><anchor id="gnome-config-set-bool"/>gnome_config_set_bool()</title>
770
 
<indexterm><primary>gnome_config_set_bool</primary></indexterm><programlisting>#define     gnome_config_set_bool(path,new_value)</programlisting>
 
770
<indexterm role="deprecated"><primary>gnome_config_set_bool</primary></indexterm><programlisting>#define     gnome_config_set_bool(path,new_value)</programlisting>
771
771
<warning><para><literal>gnome_config_set_bool</literal> is deprecated and should not be used in newly-written code.</para></warning>
772
772
<para>
773
773
Stores boolean value <parameter>new_value</parameter> in the file/section/key defined by
784
784
</variablelist></refsect2>
785
785
<refsect2>
786
786
<title><anchor id="gnome-config-private-set-bool"/>gnome_config_private_set_bool()</title>
787
 
<indexterm><primary>gnome_config_private_set_bool</primary></indexterm><programlisting>#define     gnome_config_private_set_bool(path,new_value)</programlisting>
 
787
<indexterm role="deprecated"><primary>gnome_config_private_set_bool</primary></indexterm><programlisting>#define     gnome_config_private_set_bool(path,new_value)</programlisting>
788
788
<warning><para><literal>gnome_config_private_set_bool</literal> is deprecated and should not be used in newly-written code.</para></warning>
789
789
<para>
790
790
Stores boolean value <parameter>new_value</parameter> in the file/section/key defined by <parameter>path</parameter>.
801
801
</variablelist></refsect2>
802
802
<refsect2>
803
803
<title><anchor id="gnome-config-get-vector"/>gnome_config_get_vector()</title>
804
 
<indexterm><primary>gnome_config_get_vector</primary></indexterm><programlisting>#define     gnome_config_get_vector(path, argcp, argvp)</programlisting>
 
804
<indexterm role="deprecated"><primary>gnome_config_get_vector</primary></indexterm><programlisting>#define     gnome_config_get_vector(path, argcp, argvp)</programlisting>
805
805
<warning><para><literal>gnome_config_get_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>
806
806
<para>
807
807
Retrieves the value of a configuration item as a string array.
821
821
</variablelist></refsect2>
822
822
<refsect2>
823
823
<title><anchor id="gnome-config-get-vector-with-default"/>gnome_config_get_vector_with_default()</title>
824
 
<indexterm><primary>gnome_config_get_vector_with_default</primary></indexterm><programlisting>#define     gnome_config_get_vector_with_default(path, argcp, argvp, def)</programlisting>
 
824
<indexterm role="deprecated"><primary>gnome_config_get_vector_with_default</primary></indexterm><programlisting>#define     gnome_config_get_vector_with_default(path, argcp, argvp, def)</programlisting>
825
825
<warning><para><literal>gnome_config_get_vector_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
826
826
<para>
827
827
Retrieves the value of a configuration item as a string array.
845
845
</variablelist></refsect2>
846
846
<refsect2>
847
847
<title><anchor id="gnome-config-private-get-vector"/>gnome_config_private_get_vector()</title>
848
 
<indexterm><primary>gnome_config_private_get_vector</primary></indexterm><programlisting>#define     gnome_config_private_get_vector(path, argcp, argvp)</programlisting>
 
848
<indexterm role="deprecated"><primary>gnome_config_private_get_vector</primary></indexterm><programlisting>#define     gnome_config_private_get_vector(path, argcp, argvp)</programlisting>
849
849
<warning><para><literal>gnome_config_private_get_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>
850
850
<para>
851
851
Retrieves the value of a configuration item as a string array.
867
867
</variablelist></refsect2>
868
868
<refsect2>
869
869
<title><anchor id="gnome-config-private-get-vector-with-default"/>gnome_config_private_get_vector_with_default()</title>
870
 
<indexterm><primary>gnome_config_private_get_vector_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_vector_with_default(path, argcp, argvp, def)</programlisting>
 
870
<indexterm role="deprecated"><primary>gnome_config_private_get_vector_with_default</primary></indexterm><programlisting>#define     gnome_config_private_get_vector_with_default(path, argcp, argvp, def)</programlisting>
871
871
<warning><para><literal>gnome_config_private_get_vector_with_default</literal> is deprecated and should not be used in newly-written code.</para></warning>
872
872
<para>
873
873
Retrieves the value of a configuration item as a string array.
893
893
</variablelist></refsect2>
894
894
<refsect2>
895
895
<title><anchor id="gnome-config-set-vector"/>gnome_config_set_vector()</title>
896
 
<indexterm><primary>gnome_config_set_vector</primary></indexterm><programlisting>#define     gnome_config_set_vector(path,argc,argv)</programlisting>
 
896
<indexterm role="deprecated"><primary>gnome_config_set_vector</primary></indexterm><programlisting>#define     gnome_config_set_vector(path,argc,argv)</programlisting>
897
897
<warning><para><literal>gnome_config_set_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>
898
898
<para>
899
899
Stores vector <parameter>argv</parameter> in the file/section/key defined by
913
913
</variablelist></refsect2>
914
914
<refsect2>
915
915
<title><anchor id="gnome-config-private-set-vector"/>gnome_config_private_set_vector()</title>
916
 
<indexterm><primary>gnome_config_private_set_vector</primary></indexterm><programlisting>#define     gnome_config_private_set_vector(path,argc,argv)</programlisting>
 
916
<indexterm role="deprecated"><primary>gnome_config_private_set_vector</primary></indexterm><programlisting>#define     gnome_config_private_set_vector(path,argc,argv)</programlisting>
917
917
<warning><para><literal>gnome_config_private_set_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>
918
918
<para>
919
919
Stores vector <parameter>argv</parameter> in the file/section/key defined by <parameter>path</parameter>. The
933
933
</variablelist></refsect2>
934
934
<refsect2>
935
935
<title><anchor id="gnome-config-assemble-vector"/>gnome_config_assemble_vector ()</title>
936
 
<indexterm><primary>gnome_config_assemble_vector</primary></indexterm><programlisting><link linkend="char">char</link>*       gnome_config_assemble_vector    (<link linkend="int">int</link> argc,
 
936
<indexterm role="deprecated"><primary>gnome_config_assemble_vector</primary></indexterm><programlisting><link linkend="char">char</link>*       gnome_config_assemble_vector    (<link linkend="int">int</link> argc,
937
937
                                             const <link linkend="char">char</link> *const argv[]);</programlisting>
938
938
<warning><para><literal>gnome_config_assemble_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>
939
939
<para>
949
949
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
950
950
<listitem><simpara> An array of strings.
951
951
</simpara></listitem></varlistentry>
952
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string with the concatenation results.
 
952
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string with the concatenation results.
953
953
</simpara></listitem></varlistentry>
954
954
</variablelist></refsect2>
955
955
<refsect2>
956
956
<title><anchor id="gnome-config-has-section"/>gnome_config_has_section()</title>
957
 
<indexterm><primary>gnome_config_has_section</primary></indexterm><programlisting>#define     gnome_config_has_section(path)</programlisting>
 
957
<indexterm role="deprecated"><primary>gnome_config_has_section</primary></indexterm><programlisting>#define     gnome_config_has_section(path)</programlisting>
958
958
<warning><para><literal>gnome_config_has_section</literal> is deprecated and should not be used in newly-written code.</para></warning>
959
959
<para>
960
960
Queries the gnome configuration file for the presence
965
965
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
966
966
<listitem><simpara> A gnome configuration path to a section
967
967
</simpara></listitem></varlistentry>
968
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the section exists, <literal>FALSE</literal> otherwise.
 
968
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if the section exists, <literal>FALSE</literal> otherwise.
969
969
</simpara></listitem></varlistentry>
970
970
</variablelist></refsect2>
971
971
<refsect2>
972
972
<title><anchor id="gnome-config-private-has-section"/>gnome_config_private_has_section()</title>
973
 
<indexterm><primary>gnome_config_private_has_section</primary></indexterm><programlisting>#define     gnome_config_private_has_section(path)</programlisting>
 
973
<indexterm role="deprecated"><primary>gnome_config_private_has_section</primary></indexterm><programlisting>#define     gnome_config_private_has_section(path)</programlisting>
974
974
<warning><para><literal>gnome_config_private_has_section</literal> is deprecated and should not be used in newly-written code.</para></warning>
975
975
<para>
976
976
Queries the private gnome configuration file for the presence
981
981
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
982
982
<listitem><simpara> A gnome configuration path to a section
983
983
</simpara></listitem></varlistentry>
984
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the section exists, <literal>FALSE</literal> otherwise.
 
984
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if the section exists, <literal>FALSE</literal> otherwise.
985
985
</simpara></listitem></varlistentry>
986
986
</variablelist></refsect2>
987
987
<refsect2>
988
988
<title><anchor id="gnome-config-init-iterator"/>gnome_config_init_iterator()</title>
989
 
<indexterm><primary>gnome_config_init_iterator</primary></indexterm><programlisting>#define     gnome_config_init_iterator(path)</programlisting>
 
989
<indexterm role="deprecated"><primary>gnome_config_init_iterator</primary></indexterm><programlisting>#define     gnome_config_init_iterator(path)</programlisting>
990
990
<warning><para><literal>gnome_config_init_iterator</literal> is deprecated and should not be used in newly-written code.</para></warning>
991
991
<para>
992
992
Creates an iterator handle that can be used to
999
999
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1000
1000
<listitem><simpara> A gnome configuration path for a section.
1001
1001
</simpara></listitem></varlistentry>
1002
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The iterator handle.
 
1002
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The iterator handle.
1003
1003
</simpara></listitem></varlistentry>
1004
1004
</variablelist></refsect2>
1005
1005
<refsect2>
1006
1006
<title><anchor id="gnome-config-private-init-iterator"/>gnome_config_private_init_iterator()</title>
1007
 
<indexterm><primary>gnome_config_private_init_iterator</primary></indexterm><programlisting>#define     gnome_config_private_init_iterator(path)</programlisting>
 
1007
<indexterm role="deprecated"><primary>gnome_config_private_init_iterator</primary></indexterm><programlisting>#define     gnome_config_private_init_iterator(path)</programlisting>
1008
1008
<warning><para><literal>gnome_config_private_init_iterator</literal> is deprecated and should not be used in newly-written code.</para></warning>
1009
1009
<para>
1010
1010
Creates an iterator handle that can be used to
1017
1017
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1018
1018
<listitem><simpara> A gnome configuration path for a section.
1019
1019
</simpara></listitem></varlistentry>
1020
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The iterator handle.
 
1020
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The iterator handle.
1021
1021
</simpara></listitem></varlistentry>
1022
1022
</variablelist></refsect2>
1023
1023
<refsect2>
1024
1024
<title><anchor id="gnome-config-init-iterator-sections"/>gnome_config_init_iterator_sections()</title>
1025
 
<indexterm><primary>gnome_config_init_iterator_sections</primary></indexterm><programlisting>#define     gnome_config_init_iterator_sections(path)</programlisting>
 
1025
<indexterm role="deprecated"><primary>gnome_config_init_iterator_sections</primary></indexterm><programlisting>#define     gnome_config_init_iterator_sections(path)</programlisting>
1026
1026
<warning><para><literal>gnome_config_init_iterator_sections</literal> is deprecated and should not be used in newly-written code.</para></warning>
1027
1027
<para>
1028
1028
Creates an iterator handle that can be used to iterate over the
1035
1035
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1036
1036
<listitem><simpara> A gnome configuration path for a file.
1037
1037
</simpara></listitem></varlistentry>
1038
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The iterator handle.
 
1038
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The iterator handle.
1039
1039
</simpara></listitem></varlistentry>
1040
1040
</variablelist></refsect2>
1041
1041
<refsect2>
1042
1042
<title><anchor id="gnome-config-private-init-iterator-sections"/>gnome_config_private_init_iterator_sections()</title>
1043
 
<indexterm><primary>gnome_config_private_init_iterator_sections</primary></indexterm><programlisting>#define     gnome_config_private_init_iterator_sections(path)</programlisting>
 
1043
<indexterm role="deprecated"><primary>gnome_config_private_init_iterator_sections</primary></indexterm><programlisting>#define     gnome_config_private_init_iterator_sections(path)</programlisting>
1044
1044
<warning><para><literal>gnome_config_private_init_iterator_sections</literal> is deprecated and should not be used in newly-written code.</para></warning>
1045
1045
<para>
1046
1046
Creates an iterator handle that can be used to iterate over the
1053
1053
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1054
1054
<listitem><simpara> A gnome configuration path for a file
1055
1055
</simpara></listitem></varlistentry>
1056
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The iterator handle.
 
1056
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The iterator handle.
1057
1057
</simpara></listitem></varlistentry>
1058
1058
</variablelist></refsect2>
1059
1059
<refsect2>
1060
1060
<title><anchor id="gnome-config-iterator-next"/>gnome_config_iterator_next ()</title>
1061
 
<indexterm><primary>gnome_config_iterator_next</primary></indexterm><programlisting><link linkend="void">void</link>*       gnome_config_iterator_next      (<link linkend="void">void</link> *iterator_handle,
 
1061
<indexterm role="deprecated"><primary>gnome_config_iterator_next</primary></indexterm><programlisting><link linkend="void">void</link>*       gnome_config_iterator_next      (<link linkend="void">void</link> *iterator_handle,
1062
1062
                                             <link linkend="char">char</link> **key,
1063
1063
                                             <link linkend="char">char</link> **value);</programlisting>
1064
1064
<warning><para><literal>gnome_config_iterator_next</literal> is deprecated and should not be used in newly-written code.</para></warning>
1082
1082
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
1083
1083
<listitem><simpara> Address where the value gets stored.
1084
1084
</simpara></listitem></varlistentry>
 
1085
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
1086
 
 
1087
 
 
1088
</simpara></listitem></varlistentry>
1085
1089
</variablelist></refsect2>
1086
1090
<refsect2>
1087
1091
<title><anchor id="gnome-config-drop-all"/>gnome_config_drop_all ()</title>
1088
 
<indexterm><primary>gnome_config_drop_all</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_drop_all           (void);</programlisting>
 
1092
<indexterm role="deprecated"><primary>gnome_config_drop_all</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_drop_all           (void);</programlisting>
1089
1093
<warning><para><literal>gnome_config_drop_all</literal> is deprecated and should not be used in newly-written code.</para></warning>
1090
1094
<para>
1091
1095
Drops any information cached in memory that was fetched with
1096
1100
</para></refsect2>
1097
1101
<refsect2>
1098
1102
<title><anchor id="gnome-config-sync"/>gnome_config_sync ()</title>
1099
 
<indexterm><primary>gnome_config_sync</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_config_sync               (void);</programlisting>
 
1103
<indexterm role="deprecated"><primary>gnome_config_sync</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_config_sync               (void);</programlisting>
1100
1104
<warning><para><literal>gnome_config_sync</literal> is deprecated and should not be used in newly-written code.</para></warning>
1101
1105
<para>
1102
1106
Writes all of the information modified by gnome-config to the
1108
1112
<para>
1109
1113
 
1110
1114
</para><variablelist role="params">
1111
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if everything went well. <literal>FALSE</literal> if any file
 
1115
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if everything went well. <literal>FALSE</literal> if any file
1112
1116
could not be written to disk.
1113
1117
</simpara></listitem></varlistentry>
1114
1118
</variablelist></refsect2>
1115
1119
<refsect2>
1116
1120
<title><anchor id="gnome-config-sync-file"/>gnome_config_sync_file()</title>
1117
 
<indexterm><primary>gnome_config_sync_file</primary></indexterm><programlisting>#define     gnome_config_sync_file(path)</programlisting>
 
1121
<indexterm role="deprecated"><primary>gnome_config_sync_file</primary></indexterm><programlisting>#define     gnome_config_sync_file(path)</programlisting>
1118
1122
<warning><para><literal>gnome_config_sync_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1119
1123
<para>
1120
1124
Writes all of the information modified by gnome-config to the
1130
1134
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1131
1135
<listitem><simpara> A gnome-config path
1132
1136
</simpara></listitem></varlistentry>
1133
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if everything went well, <literal>FALSE</literal> if the file
 
1137
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if everything went well, <literal>FALSE</literal> if the file
1134
1138
could not be written to for some reason.  <literal>FALSE</literal> is only returned
1135
1139
when a write was actually attempted and failed.
1136
1140
</simpara></listitem></varlistentry>
1137
1141
</variablelist></refsect2>
1138
1142
<refsect2>
1139
1143
<title><anchor id="gnome-config-private-sync-file"/>gnome_config_private_sync_file()</title>
1140
 
<indexterm><primary>gnome_config_private_sync_file</primary></indexterm><programlisting>#define     gnome_config_private_sync_file(path)</programlisting>
 
1144
<indexterm role="deprecated"><primary>gnome_config_private_sync_file</primary></indexterm><programlisting>#define     gnome_config_private_sync_file(path)</programlisting>
1141
1145
<warning><para><literal>gnome_config_private_sync_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1142
1146
<para>
1143
1147
Writes all of the information modified by gnome-config to the
1153
1157
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
1154
1158
<listitem><simpara> A gnome-config path
1155
1159
</simpara></listitem></varlistentry>
1156
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if everything went well, <literal>FALSE</literal> if the file
 
1160
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if everything went well, <literal>FALSE</literal> if the file
1157
1161
could not be written to for some reason.  <literal>FALSE</literal> is only returned
1158
1162
when a write was actually attempted and failed.
1159
1163
</simpara></listitem></varlistentry>
1160
1164
</variablelist></refsect2>
1161
1165
<refsect2>
1162
1166
<title><anchor id="gnome-config-drop-file"/>gnome_config_drop_file()</title>
1163
 
<indexterm><primary>gnome_config_drop_file</primary></indexterm><programlisting>#define     gnome_config_drop_file(path)</programlisting>
 
1167
<indexterm role="deprecated"><primary>gnome_config_drop_file</primary></indexterm><programlisting>#define     gnome_config_drop_file(path)</programlisting>
1164
1168
<warning><para><literal>gnome_config_drop_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1165
1169
<para>
1166
1170
Releases any memory resources that were allocated from accessing
1175
1179
</variablelist></refsect2>
1176
1180
<refsect2>
1177
1181
<title><anchor id="gnome-config-private-drop-file"/>gnome_config_private_drop_file()</title>
1178
 
<indexterm><primary>gnome_config_private_drop_file</primary></indexterm><programlisting>#define     gnome_config_private_drop_file(path)</programlisting>
 
1182
<indexterm role="deprecated"><primary>gnome_config_private_drop_file</primary></indexterm><programlisting>#define     gnome_config_private_drop_file(path)</programlisting>
1179
1183
<warning><para><literal>gnome_config_private_drop_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1180
1184
<para>
1181
1185
Releases any memory resources that were allocated from accessing the
1189
1193
</variablelist></refsect2>
1190
1194
<refsect2>
1191
1195
<title><anchor id="gnome-config-clean-file"/>gnome_config_clean_file()</title>
1192
 
<indexterm><primary>gnome_config_clean_file</primary></indexterm><programlisting>#define     gnome_config_clean_file(path)</programlisting>
 
1196
<indexterm role="deprecated"><primary>gnome_config_clean_file</primary></indexterm><programlisting>#define     gnome_config_clean_file(path)</programlisting>
1193
1197
<warning><para><literal>gnome_config_clean_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1194
1198
<para>
1195
1199
Cleans up the configuration file specified by <parameter>path</parameter> from any
1206
1210
</variablelist></refsect2>
1207
1211
<refsect2>
1208
1212
<title><anchor id="gnome-config-private-clean-file"/>gnome_config_private_clean_file()</title>
1209
 
<indexterm><primary>gnome_config_private_clean_file</primary></indexterm><programlisting>#define     gnome_config_private_clean_file(path)</programlisting>
 
1213
<indexterm role="deprecated"><primary>gnome_config_private_clean_file</primary></indexterm><programlisting>#define     gnome_config_private_clean_file(path)</programlisting>
1210
1214
<warning><para><literal>gnome_config_private_clean_file</literal> is deprecated and should not be used in newly-written code.</para></warning>
1211
1215
<para>
1212
1216
Cleans up the private configuration file specified by <parameter>path</parameter> from
1223
1227
</variablelist></refsect2>
1224
1228
<refsect2>
1225
1229
<title><anchor id="gnome-config-clean-section"/>gnome_config_clean_section()</title>
1226
 
<indexterm><primary>gnome_config_clean_section</primary></indexterm><programlisting>#define     gnome_config_clean_section(path)</programlisting>
 
1230
<indexterm role="deprecated"><primary>gnome_config_clean_section</primary></indexterm><programlisting>#define     gnome_config_clean_section(path)</programlisting>
1227
1231
<warning><para><literal>gnome_config_clean_section</literal> is deprecated and should not be used in newly-written code.</para></warning>
1228
1232
<para>
1229
1233
Cleans up the section specified by <parameter>path</parameter> from any
1238
1242
</variablelist></refsect2>
1239
1243
<refsect2>
1240
1244
<title><anchor id="gnome-config-private-clean-section"/>gnome_config_private_clean_section()</title>
1241
 
<indexterm><primary>gnome_config_private_clean_section</primary></indexterm><programlisting>#define     gnome_config_private_clean_section(path)</programlisting>
 
1245
<indexterm role="deprecated"><primary>gnome_config_private_clean_section</primary></indexterm><programlisting>#define     gnome_config_private_clean_section(path)</programlisting>
1242
1246
<warning><para><literal>gnome_config_private_clean_section</literal> is deprecated and should not be used in newly-written code.</para></warning>
1243
1247
<para>
1244
1248
Cleans up the section specified by <parameter>path</parameter> in a private file from any
1253
1257
</variablelist></refsect2>
1254
1258
<refsect2>
1255
1259
<title><anchor id="gnome-config-clean-key"/>gnome_config_clean_key()</title>
1256
 
<indexterm><primary>gnome_config_clean_key</primary></indexterm><programlisting>#define     gnome_config_clean_key(path)</programlisting>
 
1260
<indexterm role="deprecated"><primary>gnome_config_clean_key</primary></indexterm><programlisting>#define     gnome_config_clean_key(path)</programlisting>
1257
1261
<warning><para><literal>gnome_config_clean_key</literal> is deprecated and should not be used in newly-written code.</para></warning>
1258
1262
<para>
1259
1263
Removes the definition for the key on a gnome configuration file.
1269
1273
</variablelist></refsect2>
1270
1274
<refsect2>
1271
1275
<title><anchor id="gnome-config-private-clean-key"/>gnome_config_private_clean_key()</title>
1272
 
<indexterm><primary>gnome_config_private_clean_key</primary></indexterm><programlisting>#define     gnome_config_private_clean_key(path)</programlisting>
 
1276
<indexterm role="deprecated"><primary>gnome_config_private_clean_key</primary></indexterm><programlisting>#define     gnome_config_private_clean_key(path)</programlisting>
1273
1277
<warning><para><literal>gnome_config_private_clean_key</literal> is deprecated and should not be used in newly-written code.</para></warning>
1274
1278
<para>
1275
1279
Removes the definition for the key on a private gnome configuration
1286
1290
</variablelist></refsect2>
1287
1291
<refsect2>
1288
1292
<title><anchor id="gnome-config-get-real-path"/>gnome_config_get_real_path()</title>
1289
 
<indexterm><primary>gnome_config_get_real_path</primary></indexterm><programlisting>#define     gnome_config_get_real_path(path)</programlisting>
 
1293
<indexterm role="deprecated"><primary>gnome_config_get_real_path</primary></indexterm><programlisting>#define     gnome_config_get_real_path(path)</programlisting>
1290
1294
<warning><para><literal>gnome_config_get_real_path</literal> is deprecated and should not be used in newly-written code.</para></warning>
1291
1295
<para>
1292
1296
Retrieves the full (absolute) path to a configuration file.
1295
1299
<listitem><simpara>A configuration file (this should only be the file, not the section or
1296
1300
key).
1297
1301
</simpara></listitem></varlistentry>
1298
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>An absolute path to the config file.
 
1302
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>An absolute path to the config file.
1299
1303
 
1300
1304
 
1301
1305
</simpara></listitem></varlistentry>
1302
1306
</variablelist></refsect2>
1303
1307
<refsect2>
1304
1308
<title><anchor id="gnome-config-private-get-real-path"/>gnome_config_private_get_real_path()</title>
1305
 
<indexterm><primary>gnome_config_private_get_real_path</primary></indexterm><programlisting>#define     gnome_config_private_get_real_path(path)</programlisting>
 
1309
<indexterm role="deprecated"><primary>gnome_config_private_get_real_path</primary></indexterm><programlisting>#define     gnome_config_private_get_real_path(path)</programlisting>
1306
1310
<warning><para><literal>gnome_config_private_get_real_path</literal> is deprecated and should not be used in newly-written code.</para></warning>
1307
1311
<para>
1308
1312
Retrieves the full (absolute) path to a configuration file in the user's
1312
1316
<listitem><simpara>A configuration file (this should only be the file, not the section or
1313
1317
key).
1314
1318
</simpara></listitem></varlistentry>
1315
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>An absolute path to the config file.
 
1319
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>An absolute path to the config file.
1316
1320
 
1317
1321
 
1318
1322
</simpara></listitem></varlistentry>
1319
1323
</variablelist></refsect2>
1320
1324
<refsect2>
1321
1325
<title><anchor id="gnome-config-push-prefix"/>gnome_config_push_prefix ()</title>
1322
 
<indexterm><primary>gnome_config_push_prefix</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_push_prefix        (const <link linkend="char">char</link> *path);</programlisting>
 
1326
<indexterm role="deprecated"><primary>gnome_config_push_prefix</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_push_prefix        (const <link linkend="char">char</link> *path);</programlisting>
1323
1327
<warning><para><literal>gnome_config_push_prefix</literal> is deprecated and should not be used in newly-written code.</para></warning>
1324
1328
<para>
1325
1329
<parameter>path</parameter> is a prefix that will be prepended automatically to any
1341
1345
</variablelist></refsect2>
1342
1346
<refsect2>
1343
1347
<title><anchor id="gnome-config-pop-prefix"/>gnome_config_pop_prefix ()</title>
1344
 
<indexterm><primary>gnome_config_pop_prefix</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_pop_prefix         (void);</programlisting>
 
1348
<indexterm role="deprecated"><primary>gnome_config_pop_prefix</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_pop_prefix         (void);</programlisting>
1345
1349
<warning><para><literal>gnome_config_pop_prefix</literal> is deprecated and should not be used in newly-written code.</para></warning>
1346
1350
<para>
1347
1351
Call this routine to remove the current configuration prefix from the stack.</para>
1350
1354
</para></refsect2>
1351
1355
<refsect2>
1352
1356
<title><anchor id="gnome-config-make-vector"/>gnome_config_make_vector ()</title>
1353
 
<indexterm><primary>gnome_config_make_vector</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_make_vector        (const <link linkend="char">char</link> *string,
 
1357
<indexterm role="deprecated"><primary>gnome_config_make_vector</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_config_make_vector        (const <link linkend="char">char</link> *string,
1354
1358
                                             <link linkend="int">int</link> *argcp,
1355
1359
                                             <link linkend="char">char</link> ***argvp);</programlisting>
1356
1360
<warning><para><literal>gnome_config_make_vector</literal> is deprecated and should not be used in newly-written code.</para></warning>