This c library takes the arguments which the program received and parses them into a nicely accessible form. ## Demo Here is a small demonstration of how the library works: https://hannesleonha.github.io/Vexillum/. ## Name If you are wondering where I got the name from. I remembered that the study of flags is called Vexillology. That name comes from the latin word for flag which is vexillum. ## Form The form with which the arguments will get converted is based on how shell scripts handle flags and will be explained in the following points: ### Loose arguments A loose argument is a piece of text that can be anywhere in the program arguments, but it can't start with a dash as that would make it a flag. They are seperated by spaces, but you can have arguments with spaces by using quotes (probably depends on how it is implemented in the terminal) - `program.exe path/to/some/file "Argument with spaces" -l "Argument between flags" -s` ### Flags It starts with a dash and has two variants. Short flags which are just one letter (case-sensitive). They can also be combined by using one dash and putting multiple letters after it. The other variant is a long flag which starts with two dashes and only contains lowercase words seperated by dashes. - Short flags: `program.exe -l -s -R` - Combined flags: `program.exe -lsR` - Long flags: `program.exe -rf --no-preserve-root` ### Options with arguments When setting the library up you can also specify that the flag has an argument after it. In that case the library expects an argument after the flag. If no argument is found the library will throw an error (see usage). Both long and short flags can have arguments but short flags can't be combined with other flags when this option is used. - `program.exe -f path/to/file --username Toast -p 7&NjT%8&` ## Usage To use the library add the built library in your build system and include it with `#include "Vexillum.h"`. Make sure to also copy the file `${BINARY_DIRECTORY}/src/error/ErrorDefinitions.h` into the header include directory (this problem will be fixed in the future). ### Functions In the future the functions will be documented in the header. For now please look at the implementation in `src/Vexillum.c` and at the examples in `test/*.c`.