diff options
Diffstat (limited to 'autoopts/optionSaveFile.3')
| -rw-r--r-- | autoopts/optionSaveFile.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/autoopts/optionSaveFile.3 b/autoopts/optionSaveFile.3 new file mode 100644 index 0000000..b443471 --- /dev/null +++ b/autoopts/optionSaveFile.3 @@ -0,0 +1,44 @@ +.TH optionSaveFile 3 2012-08-11 "" "Programmer's Manual" +.\" DO NOT EDIT THIS FILE (optionSaveFile.3) +.\" +.\" It has been AutoGen-ed August 11, 2012 at 09:44:56 AM by AutoGen 5.16.2 +.\" From the definitions ./funcs.def +.\" and the template file agman3.tpl +.SH NAME +optionSaveFile - saves the option state to a file +.sp 1 +.SH SYNOPSIS + +#include <\fIyour-opts.h\fP> +.br +cc [...] -o outfile infile.c -l\fBopts\fP [...] +.sp 1 +void \fBoptionSaveFile\fP(tOptions* \fIpOpts\fP); +.sp 1 +.SH 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 \fB--save-opts\fP +option, or by appending the \fBrcfile\fP attribute to the last +\fBhomerc\fP attribute. If no \fBrcfile\fP attribute was specified, it +will default to \fB.\fIprogramname\fPrc\fP. If you wish to specify another +file, you should invoke the \fBSET_OPT_SAVE_OPTS(\fIfilename\fP)\fP macro. + +The recommend usage is as follows: +.nf + optionProcess(&progOptions, argc, argv); + if (i_want_a_non_standard_place_for_this) + SET_OPT_SAVE_OPTS("myfilename"); + optionSaveFile(&progOptions); +.fi +.TP +.IR pOpts +program options descriptor +.sp 1 +.SH ERRORS +If no \fBhomerc\fP 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 \fBstderr\fP and the routine will return. +.SH SEE ALSO +The \fIinfo\fP documentation for the -l\fIopts\fP library. +.br +ao_string_tokenize(3), configFileLoad(3), optionFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(3), optionNextValue(3), optionOnlyUsage(3), optionProcess(3), optionRestore(3), optionSaveState(3), optionUnloadNested(3), optionVersion(3), pathfind(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3), |