File: shishi_init_server.3

package info (click to toggle)
shishi 1.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 18,852 kB
  • sloc: ansic: 67,959; sh: 8,403; yacc: 1,856; makefile: 1,193; xml: 83; sed: 16
file content (44 lines) | stat: -rw-r--r-- 1,493 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shishi_init_server" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shishi_init_server \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "int shishi_init_server(Shishi ** " handle ");"
.SH ARGUMENTS
.IP "Shishi ** handle" 12
Pointer to a Shishi handle created by this call.
.SH "DESCRIPTION"
Creates a Shishi library handle, using \fBshishi_server()\fP, and reads
the system configuration file.  The path to the system configuration
file is decided at compile time, and is $sysconfdir/shishi.conf.

The handle is allocated regardless of return value.  The single
exception being \fBSHISHI_HANDLE_ERROR\fP, which indicates a problem
in allocating the handle.  Other error conditions could arise
while reading the file.
.SH "RETURN VALUE"
Returns \fBSHISHI_OK\fP iff successful.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
GNU Shishi home page: http://www.gnu.org/software/shishi/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2002-2022 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B shishi
is maintained as a Texinfo manual.  If the
.B info
and
.B shishi
programs are properly installed at your site, the command
.IP
.B info shishi
.PP
should give you access to the complete manual.