diff options
| author | sanine <sanine.not@pm.me> | 2022-08-24 00:02:17 -0500 |
|---|---|---|
| committer | sanine <sanine.not@pm.me> | 2022-08-24 00:02:17 -0500 |
| commit | 2cb3c3df4099297b0a0554bb482e2de04fe86b5c (patch) | |
| tree | 7796b4064c16460d9d603707b5256027649aa8b6 /libs/cargs/docs/reference/cag_option_print.md | |
| parent | 709e1b6e1ce86f8da4fc136747fcefbc6c6057bd (diff) | |
add command-line arguments
Diffstat (limited to 'libs/cargs/docs/reference/cag_option_print.md')
| -rwxr-xr-x | libs/cargs/docs/reference/cag_option_print.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/libs/cargs/docs/reference/cag_option_print.md b/libs/cargs/docs/reference/cag_option_print.md new file mode 100755 index 0000000..c4531eb --- /dev/null +++ b/libs/cargs/docs/reference/cag_option_print.md @@ -0,0 +1,28 @@ +---
+title: cag_option_print
+description: Prints all options to the terminal.
+---
+
+_(since v1.0.0)_
+description: Prints all options to the terminal.
+
+## Description
+```c
+void cag_option_print(const cag_option *options, size_t option_count,
+ FILE *destination);
+```
+
+This function prints all options to the terminal. This can be used to generate
+the output for a "--help" option.
+
+## Parameters
+ * **options**: The options which will be printed.
+ * **option_count**: The option count which will be printed.
+ * **destination**: The destination where the output will be printed.
+
+
+## Changelog
+
+| Version | Description |
+|------------|--------------------------------------------------------|
+| **v1.0.0** | The function is introduced. |
|