Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
aa_parseoptions(3)	   Library Functions Manual	    aa_parseoptions(3)

NAME
       aa_parseoptions	-  parse the standard command line options used	by AA-
       lib.

SYNOPSIS
       #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".

DESCRIPTION
       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_hard-
       ware_params  and	 aa_renderparams  structures and removes known options
       from the	argc/argv lists. It also parse the  AAOPTS  environment	 vari-
       able.   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.

SEE ALSO
       save_d(3), mem_d(3), aa_help(3),	aa_formats(3), aa_fonts(3), aa_dither-
       names(3), aa_drivers(3),	aa_kbddrivers(3),  aa_mousedrivers(3),	aa_kb-
       drecommended(3),	   aa_mouserecommended(3),   aa_displayrecommended(3),
       aa_defparams(3),		aa_defrenderparams(3),	       aa_scrwidth(3),
       aa_scrheight(3),	   aa_mmwidth(3),    aa_mmheight(3),   aa_imgwidth(3),
       aa_imgheight(3),	 aa_image(3),  aa_text(3),  aa_attrs(3),   aa_current-
       font(3),	   aa_autoinit(3),   aa_autoinitkbd(3),	  aa_autoinitmouse(3),
       aa_recommendhi(3),   aa_recommendlow(3),	  aa_init(3),	aa_initkbd(3),
       aa_initmouse(3),	  aa_close(3),	 aa_uninitkbd(3),   aa_uninitmouse(3),
       aa_fastrender(3), aa_render(3), aa_puts(3), aa_printf(3), aa_gotoxy(3),
       aa_hidecursor(3),  aa_showcursor(3),  aa_getmouse(3),  aa_hidemouse(3),
       aa_showmouse(3),	aa_registerfont(3), aa_setsupported(3),	aa_setfont(3),
       aa_getevent(3),	  aa_getkey(3),	  aa_resize(3),	  aa_resizehandler(3),
       aa_edit(3), aa_createedit(3), aa_editkey(3), aa_putpixel(3),  aa_recom-
       mendhikbd(3),  aa_recommendlowkbd(3), aa_recommendhimouse(3), aa_recom-
       mendlowmouse(3),	aa_recommendhidisplay(3), aa_recommendlowdisplay(3)

c2man aalib.h		       8 September 1999		    aa_parseoptions(3)

NAME | SYNOPSIS | PARAMETERS | DESCRIPTION | RETURNS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=aa_parseoptions&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help