args_t Struct Reference

The program arguments data structure. More...

#include "args.h"

Data Fields
uint8_t	help
	Flag: Was -h provided? More...
uint8_t	daemon
	Flag: Was -d provided? More...
char *	pidfile
	A C string containing the path to the PID file. More...
char *	conffile
	A C string containing the path to the config file. More...
uint8_t	test
	Flag: Was -t provided? More...
uint8_t	level
	Logging level. More...
char *	logfile
	The path to the log file. More...
uint8_t	syslog
	Flag: Was -s provided? More...
uint8_t	quiet
	Flag: Was -q provided? More...
uint8_t	color
	Flag: Was -C provided? More...
uint8_t	oneshot
	Flag: Was -o provided? More...

Detailed Description

The program arguments data structure.

See also

defaults.h

Field Documentation

uint8_t args_t::help

Flag: Was -h provided?

uint8_t args_t::daemon

Flag: Was -d provided?

char* args_t::pidfile

A C string containing the path to the PID file.

Providing -d means that this will be set to something, because running as a daemon requires a PID file. May be the argument to -p. Defaults to PEAPOD_PID_PATH.

char* args_t::conffile

A C string containing the path to the config file.

May be the argument to -c. Defaults to PEAPOD_CONF_PATH.

uint8_t args_t::test

Flag: Was -t provided?

uint8_t args_t::level

Logging level.

Defaults to LOG_NOTICE (5). Providing -v increments this up to LOG_DEBUGPKT (8).

See also

log.h

char* args_t::logfile

The path to the log file.

Independently of whether logs are emitted to the console and/or syslog, controls whether logs are emitted to a log file. If -l is not provided, remains NULL, and a log file is not used. Otherwise, may be the optional argument to -l, or the default of PEAPOD_LOG_PATH.

uint8_t args_t::syslog

Flag: Was -s provided?

uint8_t args_t::quiet

Flag: Was -q provided?

uint8_t args_t::color

Flag: Was -C provided?

uint8_t args_t::oneshot

Flag: Was -o provided?

---

The documentation for this struct was generated from the following file:

• include/args.h