Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
rte_argparse(3) 		      DPDK			 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
     bool ignore_non_flag_args
     rte_arg_parser_t callback
     void * opaque
     void(* print_help )(const struct rte_argparse *obj)
     void * reserved [15]
     struct rte_argparse_arg args []

Detailed Description
     A structure used to hold argparse's configuration.

     Definition at line 150 of file rte_argparse.h.

Field Documentation
   const char* prog_name
     Program name. Must not be NULL.

     Definition at line 152 of file rte_argparse.h.

   const char* usage
     How to use the program. Must not be NULL.

     Definition at line 154 of file rte_argparse.h.

   const char* descriptor
     Explain what the program does. Could be NULL.

     Definition at line 156 of file rte_argparse.h.

   const char* epilog
     Text at the bottom of help. Could be NULL.

     Definition at line 158 of file rte_argparse.h.

   bool exit_on_error
     Whether exit when error.

     Definition at line 160 of file rte_argparse.h.

   bool ignore_non_flag_args
     behave  like getopt and move non-flag args to the end, ignoring them other-
     wise. If this flag is specified, no positional args are allowed.

     Definition at line 164 of file rte_argparse.h.

   rte_arg_parser_t callback
     User callback for parsing arguments.

     Definition at line 168 of file rte_argparse.h.

   void* opaque
     Opaque which used to invoke callback.

     Definition at line 170 of file rte_argparse.h.

   void(* print_help) (const struct rte_argparse *obj)
     Function pointer for printing usage when -h is passed. If this is NULL, de-
     fault printing function will be used.

     Definition at line 175 of file rte_argparse.h.

   void* reserved[15]
     Reserved field used for future extension.

     Definition at line 177 of file rte_argparse.h.

   struct rte_argparse_arg args[]
     Arguments configuration. Must ended with ARGPARSE_ARG_END().

     Definition at line 179 of file rte_argparse.h.

Author
     Generated automatically by Doxygen for DPDK from the source code.

Version 25.11.0 		 Thu Aug 27 2026		 rte_argparse(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=prog_name&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help