annotate doc/libaudacious/tmpl/rcfile.sgml @ 2317:49d285f6008b trunk

[svn] Full support for XDG basedir added. The old config doesn't get automatically converted yet.
author js
date Sat, 13 Jan 2007 09:19:52 -0800
parents 53a3d5db6b58
children 72ec866d6b81
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
1 <!-- ##### SECTION Title ##### -->
2057
a55ad33d882e [svn] - document rcfile
nenolod
parents: 2034
diff changeset
2 RcFile
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
3
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
4 <!-- ##### SECTION Short_Description ##### -->
2057
a55ad33d882e [svn] - document rcfile
nenolod
parents: 2034
diff changeset
5 Manipulation of RcFiles (old XMMS ConfigFile)
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
6
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
7 <!-- ##### SECTION Long_Description ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
8 <para>
2060
53a3d5db6b58 [svn] - finish documenting the libaudacious API
nenolod
parents: 2057
diff changeset
9 Audacious plugins use RcFiles to store additional configuration data which may not be suitable for storage in the configuration database.
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
10 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
11
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
12 <!-- ##### SECTION See_Also ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
13 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
14
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
15 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
16
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
17 <!-- ##### SECTION Stability_Level ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
18
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
19
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
20 <!-- ##### STRUCT RcLine ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
21 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
22
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
23 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
24
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
25 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
26 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
27
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
28 <!-- ##### STRUCT RcSection ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
29 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
30
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
31 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
32
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
33 @name:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
34 @lines:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
35
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
36 <!-- ##### STRUCT RcFile ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
37 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
38
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
39 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
40
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
41 @sections:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
42
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
43 <!-- ##### FUNCTION bmp_rcfile_new ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
44 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
45
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
46 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
47
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
48 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
49
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
50
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
51 <!-- ##### FUNCTION bmp_rcfile_free ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
52 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
53
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
54 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
55
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
56 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
57
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
58
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
59 <!-- ##### FUNCTION bmp_rcfile_open ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
60 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
61
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
62 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
63
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
64 @filename:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
65 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
66
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
67
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
68 <!-- ##### FUNCTION bmp_rcfile_write ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
69 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
70
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
71 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
72
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
73 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
74 @filename:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
75 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
76
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
77
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
78 <!-- ##### FUNCTION bmp_rcfile_read_string ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
79 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
80
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
81 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
82
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
83 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
84 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
85 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
86 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
87 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
88
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
89
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
90 <!-- ##### FUNCTION bmp_rcfile_read_int ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
91 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
92
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
93 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
94
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
95 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
96 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
97 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
98 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
99 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
100
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
101
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
102 <!-- ##### FUNCTION bmp_rcfile_read_bool ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
103 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
104
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
105 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
106
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
107 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
108 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
109 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
110 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
111 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
112
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
113
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
114 <!-- ##### FUNCTION bmp_rcfile_read_float ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
115 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
116
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
117 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
118
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
119 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
120 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
121 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
122 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
123 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
124
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
125
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
126 <!-- ##### FUNCTION bmp_rcfile_read_double ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
127 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
128
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
129 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
130
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
131 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
132 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
133 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
134 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
135 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
136
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
137
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
138 <!-- ##### FUNCTION bmp_rcfile_write_string ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
139 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
140
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
141 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
142
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
143 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
144 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
145 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
146 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
147
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
148
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
149 <!-- ##### FUNCTION bmp_rcfile_write_int ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
150 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
151
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
152 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
153
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
154 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
155 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
156 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
157 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
158
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
159
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
160 <!-- ##### FUNCTION bmp_rcfile_write_boolean ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
161 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
162
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
163 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
164
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
165 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
166 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
167 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
168 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
169
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
170
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
171 <!-- ##### FUNCTION bmp_rcfile_write_float ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
172 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
173
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
174 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
175
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
176 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
177 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
178 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
179 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
180
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
181
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
182 <!-- ##### FUNCTION bmp_rcfile_write_double ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
183 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
184
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
185 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
186
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
187 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
188 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
189 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
190 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
191
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
192
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
193 <!-- ##### FUNCTION bmp_rcfile_remove_key ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
194 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
195
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
196 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
197
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
198 @file:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
199 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
200 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
201
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
202