chiark / gitweb /
insufficient rights always produces 51x response
[disorder] / doc / disorder.3
index f84bd165cb9a4cabcf981af10f199141c97c1c33..b4d811ddedca852d1c5c7be7cbff517e7581f784 100644 (file)
@@ -77,6 +77,9 @@ you do not need to free the results.
 .IP
 Floating point conversions and wide character support are not
 currently implemented.
 .IP
 Floating point conversions and wide character support are not
 currently implemented.
+.IP
+These functions will cope with UTF-8 even if the current locale uses
+some other encoding.
 .PP
 "Never fail" in the above means that the process is terminated on error.
 .SH LOGGING
 .PP
 "Never fail" in the above means that the process is terminated on error.
 .SH LOGGING
@@ -167,8 +170,8 @@ Currently this means that they are not even defined outside the
 server.
 .PP
 All strings in this section are encoded using UTF-8.
 server.
 .PP
 All strings in this section are encoded using UTF-8.
-.SS tracklength.so
-This is a server plugin.
+.SS "Tracklength Plugins"
+These are server plugins defined by the \fBtracklength\fR directive.
 .PP
 .nf
 \fBlong disorder_tracklength(const char *track,
 .PP
 .nf
 \fBlong disorder_tracklength(const char *track,
@@ -181,6 +184,9 @@ null pointer otherwise.  \fBpath\fR will be the same byte string return from
 the scanner plugin, and so presumably encoded according to the
 filesystem encoding.
 .IP
 the scanner plugin, and so presumably encoded according to the
 filesystem encoding.
 .IP
+To clarify this point, if the track must be opened to compute its
+length, you would normally use \fBpath\fR and not \fBtrack\fR.
+.IP
 If the return value is positive it should be the track length in
 seconds (round up if it is not an integral number of seconds long).
 .IP
 If the return value is positive it should be the track length in
 seconds (round up if it is not an integral number of seconds long).
 .IP