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

FreeBSD Manual Pages

  
 
  

home | help
optionSaveFile(3)	      Programmer's Manual	     optionSaveFile(3)

NAME
       optionSaveFile -	saves the option state to a file

SYNOPSIS
       #include	<your-opts.h>
       cc [...]	-o outfile infile.c -lopts [...]

       void optionSaveFile(tOptions * opts);

DESCRIPTION
       This  routine  will save	the state of option processing to a file.  The
       name of that file can be	specified with the argument to the --save-opts
       option,	or by appending	the rcfile attribute to	the last homerc	attri-
       bute.  If no rcfile attribute was specified, it will default  to	 .pro-
       gramnamerc.  If you wish	to specify another file, you should invoke the
       SET_OPT_SAVE_OPTS(filename) macro.

       The recommend usage is as follows:
	   optionProcess(_progOptions, argc, argv);
	   if (i_want_a_non_standard_place_for_this)
	   SET_OPT_SAVE_OPTS("myfilename");
	   optionSaveFile(_progOptions);

       opts   program options descriptor

ERRORS
       If no homerc file was specified,	this routine will silently return  and
       do nothing.  If the output file cannot be created or updated, a message
       will be printed to stderr and the routine will return.

SEE ALSO
       The info	documentation for the -lopts library.
       ao_string_tokenize(3),  configFileLoad(3),  optionFileLoad(3),  option-
       FindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3),
       optionLoadLine(3), optionMemberList(3),	optionNextValue(3),  optionOn-
       lyUsage(3),  optionPrintVersion(3), optionPrintVersionAndReturn(3), op-
       tionProcess(3),	optionRestore(3),  optionSaveState(3),	 optionUnload-
       Nested(3),  optionVersion(3), strequate(3), streqvcmp(3), streqvmap(3),
       strneqvcmp(3), strtransform(3),

				  2020-08-27		     optionSaveFile(3)

NAME | SYNOPSIS | DESCRIPTION | ERRORS | SEE ALSO

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

home | help