---
name: "rte_argparse"
section: "3"
platform: "linux"
package: "dpdk-doc"
version: "24.11.4-0+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rte_argparse"
---

# rte\_argparse(3)

## NAME

rte\_argparse

## SYNOPSIS

`#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.

Definition at line **145** of file **rte\_argparse.h**.

## Field Documentation

### const char\* prog\_name

Program name. Must not be NULL.

Definition at line **147** of file **rte\_argparse.h**.

### const char\* usage

How to use the program. Must not be NULL.

Definition at line **149** of file **rte\_argparse.h**.

### const char\* descriptor

Explain what the program does. Could be NULL.

Definition at line **151** of file **rte\_argparse.h**.

### const char\* epilog

Text at the bottom of help. Could be NULL.

Definition at line **153** of file **rte\_argparse.h**.

### bool exit\_on\_error

Whether exit when error.

Definition at line **155** of file **rte\_argparse.h**.

### rte\_arg\_parser\_t callback

User callback for parsing arguments.

Definition at line **157** of file **rte\_argparse.h**.

### void\* opaque

Opaque which used to invoke callback.

Definition at line **159** of file **rte\_argparse.h**.

### void\* reserved\[16\]

Reserved field used for future extension.

Definition at line **161** of file **rte\_argparse.h**.

### struct rte\_argparse\_arg args\[\]

Arguments configuration. Must ended with ARGPARSE\_ARG\_END().

Definition at line **163** of file **rte\_argparse.h**.

## Author

Generated automatically by Doxygen for DPDK from the source code.
