chiark - git - mdw - tripe/blob - common/util.h

   1 /* -*-c-*-
   2  *
   3  * $Id: util.h,v 1.3 2004/04/08 01:36:17 mdw Exp $
   4  *
   5  * Utilities for the client and the server
   6  *
   7  * (c) 2001 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Trivial IP Encryption (TrIPE).
  13  *
  14  * TrIPE is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * TrIPE is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with TrIPE; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef UTIL_H
  30 #define UTIL_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Functions provided ------------------------------------------------*/
  37
  38 /* --- @u_quotify@ --- *
  39  *
  40  * Arguments:   @dstr *d@ = where to write the answer
  41  *              @const char *p@ = string to quotify
  42  *
  43  * Returns:     ---
  44  *
  45  * Use:         Quotes the given string if necessary, according to our
  46  *              quoting rules.
  47  */
  48
  49 extern void u_quotify(dstr */*d*/, const char */*p*/);
  50
  51 /* --- @u_detach@ --- *
  52  *
  53  * Arguments:   ---
  54  *
  55  * Returns:     ---
  56  *
  57  * Use:         Detaches from the current terminal and ensures it can never
  58  *              acquire a new one.  Calls @fork@.
  59  */
  60
  61 extern void u_detach(void);
  62
  63 /* --- @u_daemon@ --- *
  64  *
  65  * Arguments:   ---
  66  *
  67  * Returns:     Zero if OK, nonzero on failure.
  68  *
  69  * Use:         Becomes a daemon.
  70  */
  71
  72 extern int u_daemon(void);
  73
  74 /*----- That's all, folks -------------------------------------------------*/
  75
  76 #ifdef __cplusplus
  77   }
  78 #endif
  79
  80 #endif