Dokumentacja pliku ekg/ekg.c

#include "ekg2-config.h"
#include "win32.h"
#include <sys/types.h>
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/resource.h>
#include <sys/select.h>
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include "compat/getopt.h"
#include <limits.h>
#include <locale.h>
#include <pwd.h>
#include <signal.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include "audio.h"
#include "bindings.h"
#include "commands.h"
#include "debug.h"
#include "events.h"
#include "configfile.h"
#include "emoticons.h"
#include "log.h"
#include "metacontacts.h"
#include "msgqueue.h"
#include "plugins.h"
#include "protocol.h"
#include "compat/strlcpy.h"
#include "sessions.h"
#include "stuff.h"
#include "themes.h"
#include "userlist.h"
#include "scripts.h"
#include "vars.h"
#include "windows.h"
#include "xmalloc.h"
#include "queries.h"

Definicje
#define	_XOPEN_SOURCE   600
#define	__EXTENSIONS__
#define	__USE_BSD
#define	EKG_USAGE
Funkcje
static int	ekg_autoaway_timer (int type, void *data)
void	ekg_loop ()
static void	handle_sigusr1 ()
static void	handle_sigusr2 ()
static void	handle_sighup ()
static void	handle_sigsegv ()
static char *	prepare_batch_line (int argc, char *argv[], int n)
static int	handle_stderr (int type, int fd, const char *watch, void *data)
void	ekg_debug_handler (int level, const char *format, va_list ap)
int	main (int argc, char **argv)
void	ekg_exit ()
Zmienne
char *	config_dir
int	mesg_startup
int	ekg_watches_removed
static char	argv0 [PATH_MAX]
pid_t	speech_pid = 0
static int	stderr_backup = -1
int	no_mouse = 0
struct option	ekg_options []

---

Dokumentacja definicji

#define __EXTENSIONS__

#define __USE_BSD

#define _XOPEN_SOURCE   600

#define EKG_USAGE

Wartość:

N_( \
"Usage: %s [OPTIONS] [COMMANDS]\n" \
"  -u, --user=NAME             uses profile NAME\n" \
"  -t, --theme=FILE            loads theme from FILE\n"\
"  -n, --no-auto               does not connect to server automatically\n" \
"  -m, --no-mouse              does not load mouse support\n" \
"  -N, --no-global-config      ignores global configuration file\n" \
"  -F, --frontend=NAME         uses NAME frontend (default is ncurses)\n" \
\
"  -a, --away[=DESCRIPTION]    changes status to ``away''\n" \
"  -b, --back[=DESCRIPTION]    changes status to ``available''\n" \
"  -i, --invisible[=DESCR]     changes status to ``invisible''\n" \
"  -d, --dnd[=DESCRIPTION]     changes status to ``do not disturb''\n" \
"  -f, --free-for-chat[=DESCR] changes status to ``free for chat''\n" \
"  -x, --xa[=DESCRIPTION]      changes status to ``very busy''\n" \
\
"  -h, --help                  displays this help message\n" \
"  -v, --version               displays program version and exits\n" \
"\n" \
"Options concerned with status depend on the protocol of particular session --\n" \
"some sessions may not support ``do not disturb'' status, etc.\n" \
"\n" )

---

Dokumentacja funkcji

static int ekg_autoaway_timer	(	int	type,
		void *	data
	)			[static]

ekg_autoaway_timer()

less important things which don't need to be checked every main loop iteration e.g. autoaways

executed each second.

void ekg_debug_handler	(	int	level,
		const char *	format,
		va_list	ap
	)

ekg_debug_handler()

debug message [if config_debug set] coming direct from libgadu (by libgadu_debug_handler()) or by debug() or by debug_ext()
XXX, doc more. But function now is ok.

Zobacz również:

debug_ext()

Błąd:

It can happen than internal string_t line will be not freed.

Parametry:

	level
	format
	ap

void ekg_exit

(

)

void ekg_loop

(

)

static void handle_sighup

(

)

[static]

static void handle_sigsegv

(

)

[static]

static void handle_sigusr1

(

)

[static]

static void handle_sigusr2

(

)

[static]

static int handle_stderr	(	int	type,
		int	fd,
		const char *	watch,
		void *	data
	)			[static]

int main	(	int	argc,
		char **	argv
	)

static char* prepare_batch_line	(	int	argc,
		char *	argv[],
		int	n
	)			[static]

---

Dokumentacja zmiennych

char argv0[PATH_MAX] [static]

char* config_dir

struct option ekg_options[]

Wartość początkowa:

 {
        { "user", required_argument, 0, 'u' },
        { "theme", required_argument, 0, 't' },
        { "no-auto", no_argument, 0, 'n' },
        { "no-mouse", no_argument, 0, 'm' },
        { "no-global-config", no_argument, 0, 'N' },
        { "frontend", required_argument, 0, 'F' },

        { "away", optional_argument, 0, 'a' },
        { "back", optional_argument, 0, 'b' },
        { "invisible", optional_argument, 0, 'i' },
        { "dnd", optional_argument, 0, 'd' },
        { "free-for-chat", optional_argument, 0, 'f' },
        { "xa", optional_argument, 0, 'x' },

        { "unicode", no_argument, 0, 'U' }, 

        { "help", no_argument, 0, 'h' },
        { "version", no_argument, 0, 'v' },
        { 0, 0, 0, 0 }
}

int ekg_watches_removed

int mesg_startup

int no_mouse = 0

pid_t speech_pid = 0

int stderr_backup = -1 [static]