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
50
51
52
53
54
55
|
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
.TH "shishi_init_with_paths" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shishi_init_with_paths \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "int shishi_init_with_paths(Shishi ** " handle ", const char * " tktsfile ", const char * " systemcfgfile ", const char * " usercfgfile ");"
.SH ARGUMENTS
.IP "Shishi ** handle" 12
Pointer to a Shishi handle created by this call.
.IP "const char * tktsfile" 12
Filename of ticket file, or \fBNULL\fP.
.IP "const char * systemcfgfile" 12
Filename of system configuration, or \fBNULL\fP.
.IP "const char * usercfgfile" 12
Filename of user configuration, or \fBNULL\fP.
.SH "DESCRIPTION"
Creates a Shishi library handle, using \fBshishi()\fP, and reads the system
configuration file, user configuration file, and user tickets at
the specified locations. If any of \fIusercfgfile\fP or \fIsystemcfgfile\fP
is \fBNULL\fP, the file is read from its default location, which for
the system configuration is decided at compile time, and is
$sysconfdir/shishi.conf, and for the user configuration it is
$HOME/.shishi/config. If the ticket file name is \fBNULL\fP, a ticket
file is not read at all.
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 files.
.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.
|
