cmdlineargs.h File Reference

Header file for command line processing. More...

#include <limits.h>
#include <portability.h>

Include dependency graph for cmdlineargs.h:

Go to the source code of this file.

Data Structures
struct	cla
	Command line argument. More...

Macros
#define	ARG_BUF   PATH_MAX
	Use maximum path length as size of argument for want of a more meaningful value. More...

Functions
int	process_cla (int argc, char **argv,...)
	Process command line arguments using getopt_long. More...

Detailed Description

Header file for command line processing.

Author

Copyright (C) 2015-2017, 2019 Mark Grant

Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0

Version

v1.0.6 ==== 18/05/2019

Macro Definition Documentation

ARG_BUF

#define ARG_BUF   PATH_MAX

Use maximum path length as size of argument for want of a more meaningful value.

Function Documentation

process_cla()

int process_cla	(	int	argc,
		char **	argv,
			...
	)

Process command line arguments using getopt_long.

Parameters

argc	The standard CLA argc.
argv	The standard CLA argv.
...	Variable number of flag structs.

Returns

0 on success, on failure standard EX_USAGE (64) command line usage error.

Parameters

argc	The standard CLA argc.
argv	The standard CLA argv.
...	No further args. Here due to shared prototype.

Returns

0 on success, on failure standard EX_USAGE (64) command line usage error.