#include <rte_argparse.h>

Data Fields
const char *	prog_name

const char *	usage

const char *	descriptor

const char *	epilog

bool	exit_on_error

rte_arg_parser_t	callback

void *	opaque

void *	reserved [16]

struct rte_argparse_arg	args []

Detailed Description

A structure used to hold argparse's configuration.

Examples: examples/dma/dmafwd.c, and examples/flow_filtering/main.c.

Definition at line 145 of file rte_argparse.h.

Field Documentation

◆ prog_name

const char* prog_name

Program name. Must not be NULL.

Examples: examples/dma/dmafwd.c, and examples/flow_filtering/main.c.

Definition at line 147 of file rte_argparse.h.

◆ usage

const char* usage

How to use the program. Must not be NULL.

Definition at line 149 of file rte_argparse.h.

◆ descriptor

const char* descriptor

Explain what the program does. Could be NULL.

Definition at line 151 of file rte_argparse.h.

◆ epilog

const char* epilog

Text at the bottom of help. Could be NULL.

Definition at line 153 of file rte_argparse.h.

◆ exit_on_error

bool exit_on_error

Whether exit when error.

Definition at line 155 of file rte_argparse.h.

◆ callback

rte_arg_parser_t callback

User callback for parsing arguments.

Definition at line 157 of file rte_argparse.h.

◆ opaque

void* opaque

Opaque which used to invoke callback.

Definition at line 159 of file rte_argparse.h.

◆ reserved

void* reserved[16]

Reserved field used for future extension.

Definition at line 161 of file rte_argparse.h.

◆ args

struct rte_argparse_arg args[]

Arguments configuration. Must ended with ARGPARSE_ARG_END().

Definition at line 163 of file rte_argparse.h.

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

lib/argparse/rte_argparse.h

Data Fields