plucky (3) shishi_init_with_paths.3.gz

Provided by: shishi-doc_1.0.3-5_all bug

NAME
       shishi_init_with_paths - API function


SYNOPSIS
       #include <shishi.h>

       int  shishi_init_with_paths(Shishi  **  handle,  const char * tktsfile, const char * systemcfgfile, const
       char * usercfgfile);


ARGUMENTS
       Shishi ** handle
                   Pointer to a Shishi handle created by this call.

       const char * tktsfile
                   Filename of ticket file, or NULL.

       const char * systemcfgfile
                   Filename of system configuration, or NULL.

       const char * usercfgfile
                   Filename of user configuration, or NULL.


DESCRIPTION
       Creates a Shishi  library  handle,  using  shishi(),  and  reads  the  system  configuration  file,  user
       configuration  file, and user tickets at the specified locations.  If any of usercfgfile or systemcfgfile
       is NULL, 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 NULL, a ticket file is not read at all.

       The handle is allocated regardless of return value.   The  single  exception  being  SHISHI_HANDLE_ERROR,
       which  indicates  a  problem  in allocating the handle.  Other error conditions could arise while reading
       files.


RETURN VALUE
       Returns SHISHI_OK iff successful.


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/


       Copyright © 2002-2022 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.