cli.h File Reference

Front-end to the CLI to fetch user parameters. More...

#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include "lib/cargs/include/cargs.h"
#include "utils.h"

Go to the source code of this file.

Classes
struct	builder_cli_configuration

Macros
#define	CLI_OK   2
#define	VTOR_ALIGN_BYTES   1024
#define	AUTH_KEY_MIN_SIZE   16

Functions
int	parse_options (int argc, char **argv, struct builder_cli_configuration *cli_options)
	Parse the CLI options provided by the user.

Detailed Description

Front-end to the CLI to fetch user parameters.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2021-2026 Oryx Embedded SARL. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.6.6

Function Documentation

parse_options()

int parse_options	(	int	argc,
		char **	argv,
		struct builder_cli_configuration *	cli_options
	)

Parse the CLI options provided by the user.

This is the main configuration of all CLI options available.

Parameters

[in]	argc	Argument count
[in]	argv	Argument vector
[in]	cli_options	Struct to store the user arguments

Returns

Status code