File: shisa_init_with_paths.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 (49 lines) | stat: -rw-r--r-- 1,741 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
45
46
47
48
49
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_init_with_paths" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shisa_init_with_paths \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_init_with_paths(Shisa ** " dbh ", const char * " file ");"
.SH ARGUMENTS
.IP "Shisa ** dbh" 12
Returned pointer to a created Shisa library handle.
.IP "const char * file" 12
Filename of system configuration, or \fBNULL\fP.
.SH "DESCRIPTION"
Creates a Shisa library handle, using \fBshisa()\fP, but reading
the system configuration file at the location \fIfile\fP, or at
the default location, should \fIfile\fP be \fBNULL\fP.  The path to
the default system configuration file is decided at compile
time ($sysconfdir/shisa.conf).

The handle is allocated regardless of return value, the only
exception being \fBSHISA_INIT_ERROR\fP, which indicates a problem
in allocating the handle.  Other error conditions arise while
reading a file.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP, or an error code.  The value
\fBSHISA_INIT_ERROR\fP indicates a failure to create the handle.
.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.