summaryrefslogtreecommitdiff
path: root/libs/cargs/docs/reference/index.md
blob: 654d9feeff990ca494e147093b80ac0d6f8e0dd5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
---
title: Reference
description: A complete reference of the cargs command line arguments parser library for C/C++.
---

## Basic
The basic functions available in cargs, which can be used to do basic command line argument parsing.

### Functions
* **[cag_option_prepare]({{ site.baseurl }}{% link reference/cag_option_prepare.md %})**  
Prepare argument options context for parsing.

* **[cag_option_fetch]({{ site.baseurl }}{% link reference/cag_option_fetch.md %})**  
Fetches an option from the argument list.

* **[cag_option_get]({{ site.baseurl }}{% link reference/cag_option_get.md %})**  
 Gets the identifier of the option.

* **[cag_option_get_value]({{ site.baseurl }}{% link reference/cag_option_get_value.md %})**  
Gets the value from the option.

* **[cag_option_get_index]({{ site.baseurl }}{% link reference/cag_option_get_index.md %})**  
Gets the current index of the context.

## Output
This section describes functions which are used to output argument information.

### Functions
* **[cag_option_print]({{ site.baseurl }}{% link reference/cag_option_print.md %})**  
Prints all options to the terminal.