2.19.4
[platform/upstream/glib.git] / docs / reference / glib / tmpl / glib-unused.sgml
1 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Long_Description ##### -->
2 <para>
3 The "GDesktopEntry" parser is intended to parse files written to
4 the <ulink
5 url="http://www.freedesktop.org/Standards/desktop-entry-spec">Desktop
6 Entry Specification</ulink>.  It supports deserialization of
7 desktop entries from files and in-memory data.  Desktop entries
8 are used for a variety of things including menus, application
9 MIME type registration, and launchers.
10 </para>
11
12 <para>
13 To load an existing desktop entry from a data directory (as
14 returned by g_get_user_data_dir() and g_get_system_data_dirs())
15 use g_desktop_entry_new_from_data_dirs().  To load an existing
16 desktop entry from an arbitrary location on the file system use
17 g_desktop_entry_new_from_file().  If the desktop entry is already
18 in memory use g_desktop_entry_new_from_data().  Once the desktop 
19 entry is loaded its keys can be queried using the g_desktop_entry_get 
20 family of functions.
21 </para>
22
23 <para>
24 To create a new desktop entry first call g_desktop_entry_new().
25 Then, call the g_desktop_entry_set family of functions.  Next,
26 call g_desktop_entry_to_data() to output the desktop entry to 
27 a byte array, which can be written to disk or sent over a
28 network.  Finally, call g_desktop_entry_free() to deallocate the
29 #GDesktopEntry object returned by g_desktop_entry_new().
30 </para>
31
32
33 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:See_Also ##### -->
34 <para>
35
36 </para>
37
38
39 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Short_Description ##### -->
40 serializes and deserializes a desktop entry.
41
42
43 <!-- ##### SECTION ./tmpl/desktop_entry.sgml:Title ##### -->
44 Desktop Entry Parser
45
46
47 <!-- ##### SECTION ./tmpl/glib-unused.sgml:Stability_Level ##### -->
48
49
50
51 <!-- ##### SECTION ./tmpl/testutils.sgml:Long_Description ##### -->
52 <para>
53
54 </para>
55
56
57 <!-- ##### SECTION ./tmpl/testutils.sgml:See_Also ##### -->
58 <para>
59
60 </para>
61
62
63 <!-- ##### SECTION ./tmpl/testutils.sgml:Short_Description ##### -->
64
65
66
67 <!-- ##### SECTION ./tmpl/testutils.sgml:Stability_Level ##### -->
68
69
70
71 <!-- ##### SECTION ./tmpl/testutils.sgml:Title ##### -->
72 Testing
73
74
75 <!-- ##### ENUM GChannelError ##### -->
76 <para>
77
78 </para>
79
80 @G_CHANNEL_ERROR_ACCES: 
81 @G_CHANNEL_ERROR_BADF: 
82 @G_CHANNEL_ERROR_DEADLK: 
83 @G_CHANNEL_ERROR_FAULT: 
84 @G_CHANNEL_ERROR_INVAL: 
85 @G_CHANNEL_ERROR_IO: 
86 @G_CHANNEL_ERROR_ISDIR: 
87 @G_CHANNEL_ERROR_MFILE: 
88 @G_CHANNEL_ERROR_NOLCK: 
89 @G_CHANNEL_ERROR_NOSPC: 
90 @G_CHANNEL_ERROR_PERM: 
91 @G_CHANNEL_ERROR_PIPE: 
92 @G_CHANNEL_ERROR_SPIPE: 
93 @G_CHANNEL_ERROR_ENCODE_RW: 
94 @G_CHANNEL_ERROR_FAILED: 
95
96 <!-- ##### ENUM GChannelStatus ##### -->
97 <para>
98
99 </para>
100
101 @G_CHANNEL_STATUS_NORMAL: 
102 @G_CHANNEL_STATUS_EOF: 
103 @G_CHANNEL_STATUS_PARTIAL_CHARS: 
104 @G_CHANNEL_STATUS_AGAIN: 
105 @G_CHANNEL_STATUS_INTR: 
106 @G_CHANNEL_STATUS_ERROR: 
107 @G_CHANNEL_STATUS_BAD_INPUT: 
108
109 <!-- ##### USER_FUNCTION GCompareFuncData ##### -->
110 <para>
111
112 </para>
113
114 @a: 
115 @b: 
116 @user_data: 
117 @Returns: 
118
119 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
120 <para>
121
122 </para>
123
124 @s1: 
125 @s2: 
126 @Returns: 
127
128 <!-- ##### STRUCT GDesktopEntry ##### -->
129 <para>
130
131 </para>
132
133
134 <!-- ##### ENUM GDesktopEntryError ##### -->
135 <para>
136 Error codes returned by desktop entry parsing.
137 </para>
138
139 @G_DESKTOP_ENTRY_ERROR_UNKNOWN_ENCODING: text being parsed is not UTF-8 and
140 cannot be guessed.
141 @G_DESKTOP_ENTRY_ERROR_BAD_START_GROUP: desktop entry does not start with a
142 legal start group.
143 @G_DESKTOP_ENTRY_ERROR_PARSE: desktop entry is empty or contains invalid
144 data.
145 @G_DESKTOP_ENTRY_ERROR_NOT_FOUND: valid desktop entry could not be found.
146 @G_DESKTOP_ENTRY_ERROR_KEY_NOT_FOUND: desktop entry does not have requested
147 key.
148 @G_DESKTOP_ENTRY_ERROR_GROUP_NOT_FOUND: desktop entry does not have requested
149 group
150 @G_DESKTOP_ENTRY_ERROR_INVALID_VALUE: desktop entry contains key which has
151 value that cannot be validated.
152
153 <!-- ##### ENUM GDesktopEntryFlags ##### -->
154 <para>
155 #GDesktopEntry supports a few flags for tweaking performance during
156 deserialization.  #G_DESKTOP_ENTRY_DISCARD_COMMENTS and 
157 #G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS will reduce memory footprint,
158 and #G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP will increase key lookup speed.
159 </para>
160
161 @G_DESKTOP_ENTRY_NONE: use parser defaults
162 @G_DESKTOP_ENTRY_DISCARD_COMMENTS:  Discard all lines that are blank
163 or start with "#".
164 @G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS: Only retain translations that
165 are returned by g_get_language_names().
166 @G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP: Generate a lookup map for key names to make lookups constant time at the cost of more memory.
167
168 <!-- ##### USER_FUNCTION GErrorFunc ##### -->
169 <para>
170 Specifies the type of function passed to g_set_error_handler().
171 </para>
172
173 @str: the error message.
174
175 <!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
176 <para>
177
178 </para>
179
180 @hook_list: 
181 @hook: 
182
183 <!-- ##### ENUM GIOFileMode ##### -->
184 <para>
185
186 </para>
187
188 @G_IO_FILE_MODE_READ: 
189 @G_IO_FILE_MODE_WRITE: 
190 @G_IO_FILE_MODE_APPEND: 
191 @G_IO_FILE_MODE_READ_WRITE: 
192 @G_IO_FILE_MODE_READ_WRITE_TRUNCATE: 
193 @G_IO_FILE_MODE_READ_WRITE_APPEND: 
194
195 <!-- ##### ENUM GMatchType ##### -->
196 <para>
197 Enumeration representing different kinds of patterns. This is only used
198 internally for optimizing the match algorithm.
199 </para>
200
201 @G_MATCH_ALL: a general pattern.
202 @G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
203 the end of the string.
204 @G_MATCH_HEAD: a pattern matching every string with a certain prefix.
205 @G_MATCH_TAIL: a pattern matching every string with a certain suffix.
206 @G_MATCH_EXACT: a pattern matching exactly one string.
207 @G_MATCH_LAST: 
208
209 <!-- ##### USER_FUNCTION GWarningFunc ##### -->
210 <para>
211 Specifies the type of function passed to g_set_warning_handler().
212 </para>
213
214 @str: the warning message.
215
216 <!-- ##### MACRO G_CHANNEL_ERROR ##### -->
217 <para>
218
219 </para>
220
221
222 <!-- ##### MACRO G_DESKTOP_ENTRY_ERROR ##### -->
223 <para>
224 Error domain for desktop entry parsing. Errors in this domain will
225 be from the #GDesktopEntryError enumeration. See #GError for information on 
226 error domains.
227 </para>
228
229
230 <!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### -->
231 <para>
232
233 </para>
234
235
236 <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
237 <para>
238
239 </para>
240
241
242 <!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
243 <para>
244 One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
245 or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
246 depending on the system type.
247 </para>
248
249
250 <!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
251 <para>
252
253 </para>
254
255
256 <!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
257 <para>
258 Encoding for nonbuffered IO. With this encoding, data must be
259 read using g_io_channel_read_chars(); the other functions will
260 not work.
261 </para>
262
263
264 <!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
265 <para>
266
267 </para>
268
269
270 <!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
271 <para>
272
273 </para>
274
275
276 <!-- ##### MACRO NAME_MAX ##### -->
277 <para>
278 Provided for UNIX emulation on Windows; equivalent to UNIX macro 
279 %NAME_MAX, which is the maximum length of a single path component.
280 i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
281 </para>
282
283
284 <!-- ##### MACRO _ ##### -->
285 <para>
286 Marks a string for translation, gets replaced with the translated string
287 at runtime.
288 </para>
289
290 @String: the string to be translated
291 @Since: 2.4
292
293 <!-- ##### MACRO access ##### -->
294 <para>
295
296 </para>
297
298
299 <!-- ##### MACRO close ##### -->
300 <para>
301
302 </para>
303
304
305 <!-- ##### FUNCTION closedir ##### -->
306 <para>
307 Provided for UNIX emulation on Windows; see documentation for <function>closedir()</function>
308 in any UNIX manual.
309 </para>
310
311 @Param1: 
312 @Returns: 
313
314 <!-- ##### MACRO fdopen ##### -->
315 <para>
316
317 </para>
318
319
320 <!-- ##### MACRO ftruncate ##### -->
321 <para>
322 Provided for UNIX emulation on Windows; see documentation for ftruncate()
323 in any UNIX manual.
324 </para>
325
326 @fd: 
327 @size: 
328
329 <!-- ##### FUNCTION g_channel_error_from_errno ##### -->
330 <para>
331
332 </para>
333
334 @en: 
335 @Returns: 
336
337 <!-- ##### FUNCTION g_channel_error_quark ##### -->
338 <para>
339
340 </para>
341
342 @Returns: 
343
344 <!-- ##### FUNCTION g_convert_error_quark ##### -->
345 <para>
346
347 </para>
348
349 @Returns: 
350
351 <!-- ##### FUNCTION g_desktop_entry_escape_strings ##### -->
352 <para>
353
354 </para>
355
356 @entry: 
357 @should_escape: 
358
359 <!-- ##### FUNCTION g_desktop_entry_free ##### -->
360 <para>
361
362 </para>
363
364 @entry: 
365
366 <!-- ##### FUNCTION g_desktop_entry_get_boolean ##### -->
367 <para>
368
369 </para>
370
371 @entry: 
372 @group_name: 
373 @key: 
374 @error: 
375 @Returns: 
376
377 <!-- ##### FUNCTION g_desktop_entry_get_boolean_list ##### -->
378 <para>
379
380 </para>
381
382 @entry: 
383 @group_name: 
384 @key: 
385 @length: 
386 @error: 
387 @Returns: 
388
389 <!-- ##### FUNCTION g_desktop_entry_get_groups ##### -->
390 <para>
391
392 </para>
393
394 @entry: 
395 @length: 
396 @Returns: 
397
398 <!-- ##### FUNCTION g_desktop_entry_get_integer ##### -->
399 <para>
400
401 </para>
402
403 @entry: 
404 @group_name: 
405 @key: 
406 @error: 
407 @Returns: 
408
409 <!-- ##### FUNCTION g_desktop_entry_get_integer_list ##### -->
410 <para>
411
412 </para>
413
414 @entry: 
415 @group_name: 
416 @key: 
417 @length: 
418 @error: 
419 @Returns: 
420
421 <!-- ##### FUNCTION g_desktop_entry_get_keys ##### -->
422 <para>
423
424 </para>
425
426 @entry: 
427 @group_name: 
428 @length: 
429 @error: 
430 @Returns: 
431
432 <!-- ##### FUNCTION g_desktop_entry_get_locale_string ##### -->
433 <para>
434
435 </para>
436
437 @entry: 
438 @group_name: 
439 @key: 
440 @locale: 
441 @error: 
442 @Returns: 
443
444 <!-- ##### FUNCTION g_desktop_entry_get_locale_string_list ##### -->
445 <para>
446
447 </para>
448
449 @entry: 
450 @group_name: 
451 @key: 
452 @locale: 
453 @length: 
454 @error: 
455 @Returns: 
456
457 <!-- ##### FUNCTION g_desktop_entry_get_start_group ##### -->
458 <para>
459
460 </para>
461
462 @entry: 
463 @Returns: 
464
465 <!-- ##### FUNCTION g_desktop_entry_get_string ##### -->
466 <para>
467
468 </para>
469
470 @entry: 
471 @group_name: 
472 @key: 
473 @error: 
474 @Returns: 
475
476 <!-- ##### FUNCTION g_desktop_entry_get_string_list ##### -->
477 <para>
478
479 </para>
480
481 @entry: 
482 @group_name: 
483 @key: 
484 @length: 
485 @error: 
486 @Returns: 
487
488 <!-- ##### FUNCTION g_desktop_entry_has_group ##### -->
489 <para>
490
491 </para>
492
493 @entry: 
494 @group_name: 
495 @Returns: 
496
497 <!-- ##### FUNCTION g_desktop_entry_has_key ##### -->
498 <para>
499
500 </para>
501
502 @entry: 
503 @group_name: 
504 @key: 
505 @error: 
506 @Returns: 
507
508 <!-- ##### FUNCTION g_desktop_entry_new ##### -->
509 <para>
510
511 </para>
512
513 @flags: 
514 @error: 
515 @Returns: 
516
517 <!-- ##### FUNCTION g_desktop_entry_new_from_data ##### -->
518 <para>
519
520 </para>
521
522 @data: 
523 @length: 
524 @legal_start_groups: 
525 @flags: 
526 @error: 
527 @Returns: 
528
529 <!-- ##### FUNCTION g_desktop_entry_new_from_data_dirs ##### -->
530 <para>
531
532 </para>
533
534 @file: 
535 @full_path: 
536 @legal_start_groups: 
537 @flags: 
538 @error: 
539 @Returns: 
540
541 <!-- ##### FUNCTION g_desktop_entry_new_from_file ##### -->
542 <para>
543
544 </para>
545
546 @file: 
547 @legal_start_groups: 
548 @flags: 
549 @error: 
550 @Returns: 
551
552 <!-- ##### FUNCTION g_desktop_entry_remove_group ##### -->
553 <para>
554
555 </para>
556
557 @entry: 
558 @group_name: 
559 @error: 
560
561 <!-- ##### FUNCTION g_desktop_entry_remove_key ##### -->
562 <para>
563
564 </para>
565
566 @entry: 
567 @group_name: 
568 @key: 
569 @error: 
570
571 <!-- ##### FUNCTION g_desktop_entry_set_boolean ##### -->
572 <para>
573
574 </para>
575
576 @entry: 
577 @group_name: 
578 @key: 
579 @boolean: 
580 @error: 
581
582 <!-- ##### FUNCTION g_desktop_entry_set_boolean_list ##### -->
583 <para>
584
585 </para>
586
587 @entry: 
588 @group_name: 
589 @key: 
590 @list: 
591 @length: 
592 @error: 
593
594 <!-- ##### FUNCTION g_desktop_entry_set_integer ##### -->
595 <para>
596
597 </para>
598
599 @entry: 
600 @group_name: 
601 @key: 
602 @integer: 
603 @error: 
604
605 <!-- ##### FUNCTION g_desktop_entry_set_integer_list ##### -->
606 <para>
607
608 </para>
609
610 @entry: 
611 @group_name: 
612 @key: 
613 @list: 
614 @length: 
615 @error: 
616
617 <!-- ##### FUNCTION g_desktop_entry_set_locale_string ##### -->
618 <para>
619
620 </para>
621
622 @entry: 
623 @group_name: 
624 @key: 
625 @locale: 
626 @string: 
627 @error: 
628
629 <!-- ##### FUNCTION g_desktop_entry_set_locale_string_list ##### -->
630 <para>
631
632 </para>
633
634 @entry: 
635 @group_name: 
636 @key: 
637 @locale: 
638 @list: 
639 @length: 
640 @error: 
641
642 <!-- ##### FUNCTION g_desktop_entry_set_string ##### -->
643 <para>
644
645 </para>
646
647 @entry: 
648 @group_name: 
649 @key: 
650 @string: 
651 @error: 
652
653 <!-- ##### FUNCTION g_desktop_entry_set_string_list ##### -->
654 <para>
655
656 </para>
657
658 @entry: 
659 @group_name: 
660 @key: 
661 @list: 
662 @length: 
663 @error: 
664
665 <!-- ##### FUNCTION g_desktop_entry_to_data ##### -->
666 <para>
667
668 </para>
669
670 @entry: 
671 @length: 
672 @error: 
673 @Returns: 
674
675 <!-- ##### FUNCTION g_file_replace ##### -->
676 <para>
677
678 </para>
679
680 @filename: 
681 @contents: 
682 @length: 
683 @error: 
684 @Returns: 
685
686 <!-- ##### FUNCTION g_format_file_size_for_display ##### -->
687 <para>
688
689 </para>
690
691 @size: 
692 @Returns: 
693
694 <!-- ##### FUNCTION g_io_channel_error_quark ##### -->
695 <para>
696
697 </para>
698
699 @Returns: 
700
701 <!-- ##### VARIABLE g_log_domain_glib ##### -->
702 <para>
703 The log domain used for messages logged by GLib itself.
704 </para>
705
706
707 <!-- ##### FUNCTION g_main_add_poll ##### -->
708 <para>
709 Adds a file descriptor to be polled.
710 This is usually combined with g_source_add() to add an event source.
711 The event source's check function will typically test the revents
712 field in the #GPollFD struct and return TRUE if events need to be processed.
713 </para>
714
715 @fd: a #GPollFD, which is a file descriptor together with a bitwise
716 combination of #GIOCondition flags determining which events to poll for.
717 @priority: the priority of the poll, which should be the same as the priority
718 used for g_source_add() to ensure that the file descriptor is polled whenever
719 the results may be needed.
720 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
721 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
722
723 <!-- ##### FUNCTION g_main_context_get ##### -->
724 <para>
725
726 </para>
727
728 @thread: 
729 @Returns: 
730
731 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
732 <para>
733
734 </para>
735
736 @loop: 
737
738 <!-- ##### FUNCTION g_main_remove_poll ##### -->
739 <para>
740 Removes a file descriptor from the list being polled.
741 </para>
742
743 @fd: the #GPollFD to remove.
744
745 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
746 <para>
747
748 </para>
749
750 @Returns: 
751
752 <!-- ##### FUNCTION g_mem_check ##### -->
753 <para>
754 Checks if the given memory has already been freed. If it has it outputs
755 a warning message.
756 To use this function you must configure glib with the flag
757 '--enable-mem-check=yes' before compiling.
758 </para>
759
760 @mem: the memory to check.
761
762 <!-- ##### FUNCTION g_regex_error_quark ##### -->
763 <para>
764
765 </para>
766
767 @Returns: 
768
769 <!-- ##### FUNCTION g_regex_free ##### -->
770 <para>
771
772 </para>
773
774 @regex: 
775
776 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
777 <para>
778 Gets the file attributes.
779 This is the <structfield>st_mode</structfield> field from the
780 <structname>stat</structname> structure. See the <function>stat()</function>
781 documentation.
782 </para>
783
784 @filename: the file name.
785 @Returns: the file attributes.
786
787 <!-- ##### FUNCTION g_set_error_handler ##### -->
788 <para>
789 Sets the function to be called to handle error messages.
790 This function is deprecated in favour of the new logging facilities.
791 </para>
792
793 @func: the function to be called to handle error messages.
794 @Returns: the old error handler.
795
796 <!-- ##### FUNCTION g_set_message_handler ##### -->
797 <para>
798 Sets the function to be called to handle messages.
799 This function is deprecated in favour of the new logging facilities.
800 </para>
801
802 @func: the function to be called to handle normal messages.
803 @Returns: the old message handler.
804
805 <!-- ##### FUNCTION g_set_warning_handler ##### -->
806 <para>
807 Sets the function to be called to handle warning messages.
808 This function is deprecated in favour of the new logging facilities.
809 </para>
810
811 @func: the function to be called to handle warning messages.
812 @Returns: the old warning handler.
813
814 <!-- ##### FUNCTION g_source_add ##### -->
815 <para>
816 </para>
817
818 @priority: 
819 @can_recurse: 
820 @funcs: 
821 @source_data: 
822 @user_data: 
823 @notify: 
824 @Returns: 
825 @source: 
826 @context: 
827
828 <!-- ##### FUNCTION g_source_connect ##### -->
829 <para>
830
831 </para>
832
833 @source: 
834 @func: 
835 @data: 
836 @notify: 
837
838 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
839 <para>
840
841 </para>
842
843 @source: 
844 @callback_data: 
845 @callback_funcs: 
846
847 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
848 <para>
849 Removes the first event source found with the given source data.
850 </para>
851 <para>
852 Event sources are sorted with the highest priority first. Sources with equal
853 priority are stored in the order in which they were added.
854 </para>
855
856 @source_data: the source data, which contains information specific to the
857 type of source.
858 @Returns: TRUE if an event source was found and removed.
859
860 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
861 <para>
862
863 </para>
864
865 @private_key: 
866 @thread: 
867 @Returns: 
868
869 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
870 <para>
871
872 </para>
873
874 @private_key: 
875 @thread: 
876 @data: 
877 @notify: 
878
879 <!-- ##### MACRO g_string ##### -->
880 <para>
881 Turns the argument into a string literal by using the '#' stringizing operator.
882 </para>
883
884 @x: text to convert to a literal string.
885
886 <!-- ##### FUNCTION g_warn_message ##### -->
887 <para>
888
889 </para>
890
891 @domain: 
892 @file: 
893 @line: 
894 @func: 
895 @warnexpr: 
896
897 <!-- ##### MACRO getcwd ##### -->
898 <para>
899
900 </para>
901
902
903 <!-- ##### MACRO getpid ##### -->
904 <para>
905
906 </para>
907
908
909 <!-- ##### MACRO lseek ##### -->
910 <para>
911
912 </para>
913
914
915 <!-- ##### MACRO open ##### -->
916 <para>
917
918 </para>
919
920
921 <!-- ##### FUNCTION opendir ##### -->
922 <para>
923 Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
924 in any UNIX manual.
925 </para>
926
927 @Param1: 
928 @Returns: 
929
930 <!-- ##### MACRO pclose ##### -->
931 <para>
932
933 </para>
934
935
936 <!-- ##### MACRO pipe ##### -->
937 <para>
938 Provided for UNIX emulation on Windows; see documentation for pipe()
939 in any UNIX manual.
940 </para>
941
942 @phandles: file descriptors, the first one for reading, the second one for writing.
943
944 <!-- ##### MACRO popen ##### -->
945 <para>
946
947 </para>
948
949
950 <!-- ##### MACRO read ##### -->
951 <para>
952
953 </para>
954
955
956 <!-- ##### MACRO readdir ##### -->
957 <para>
958 Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
959 in any UNIX manual.
960 </para>
961
962
963 <!-- ##### FUNCTION rewinddir ##### -->
964 <para>
965 Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
966 in any UNIX manual.
967 </para>
968
969 @Param1: 
970
971 <!-- ##### MACRO write ##### -->
972 <para>
973
974 </para>
975
976