DragonFly On-Line Manual Pages

Search: Section:  

shishi_init(3)                      shishi                      shishi_init(3)


NAME

       shishi_init - API function


SYNOPSIS

       #include <shishi.h>

       int shishi_init(Shishi ** handle);


ARGUMENTS

       Shishi ** handle
                   pointer to handle to be created.


DESCRIPTION

       Create a Shishi library handle, using shishi(), and read the system
       configuration file, user configuration file and user tickets from their
       default locations.  The paths to the system configuration file is
       decided at compile time, and is $sysconfdir/shishi.conf.  The user
       configuration file is $HOME/.shishi/config, and the user ticket file is
       $HOME/.shishi/ticket.

       The handle is allocated regardless of return values, except for
       SHISHI_HANDLE_ERROR which indicates a problem allocating the handle.
       (The other error conditions comes from reading the files.)


RETURN VALUE

       Returns SHISHI_OK iff successful.


REPORTING BUGS

       Report bugs to <bug-shishi@gnu.org>.


COPYRIGHT

       Copyright (C) 2002-2010 Simon Josefsson.
       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.


SEE ALSO

       The full documentation for shishi is maintained as a Texinfo manual.
       If the info and shishi programs are properly installed at your site,
       the command

              info shishi

       should give you access to the complete manual.

shishi                               1.0.2                      shishi_init(3)

Search: Section: