aa_parseoptions(3)

aa_parseoptions3

Parse the standard command line options used by aa-lib.

Usage

#include <aalib.h>

int aa_parseoptions
(

struct aa_hardware_params *p,

aa_renderparams *r,

int *argc,

char **argv
);

Parameters

struct aa_hardware_params *p

Hardware parameters structure to alter. It is expected that this structure only with necessary modifications will be later used to initialize the AA-lib context.

aa_renderparams *r

Rendering prameters structure to alter. It is expected that this structure only with necessary modifications will be later used to render images.

int *argc

Pointer to argc parameter passed to function "main".

char **argv

Pointer to argv parameter passed to function "main".

Overview

Use this function to parse the standard command line options used by AA-lib. Every AA-lib program ought to call this function to let user specify some extra parameters. The function alters the aa_hardware_params and aa_renderparams structures and removes known options from the argc/argv lists. It also parse the AAOPTS environment variable. When called with NULL for the argc/argv parameters, it parses AAOPTS only. At least this call ought to be in every AA-lib program.

Returns

1 when sucesfull and 0 on failure. The program then can print the help text available in aa_help variable.

Releases

Unchanged in 13 releases since Debian 3.0 (Woody).

  1. 3.0–Arch

From aalib 1.4rc5-19 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.