~mdw / mLib / blame
| Commit | Line | Data |
|---|---|---|
| c4ccbbf9 MW |
1 | .\" -*-nroff-*- |
| 2 | .\" | |
| 3 | .\" Manual for test-vector framework front-end | |
| 4 | .\" | |
| 5 | .\" (c) 2024 Straylight/Edgeware | |
| 6 | .\" | |
| 7 | . | |
| 8 | .\"----- Licensing notice --------------------------------------------------- | |
| 9 | .\" | |
| 10 | .\" This file is part of the mLib utilities library. | |
| 11 | .\" | |
| 12 | .\" mLib is free software: you can redistribute it and/or modify it under | |
| 13 | .\" the terms of the GNU Library General Public License as published by | |
| 14 | .\" the Free Software Foundation; either version 2 of the License, or (at | |
| 15 | .\" your option) any later version. | |
| 16 | .\" | |
| 17 | .\" mLib is distributed in the hope that it will be useful, but WITHOUT | |
| 18 | .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 19 | .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public | |
| 20 | .\" License for more details. | |
| 21 | .\" | |
| 22 | .\" You should have received a copy of the GNU Library General Public | |
| 23 | .\" License along with mLib. If not, write to the Free Software | |
| 24 | .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, | |
| 25 | .\" USA. | |
| 26 | . | |
| 27 | .\"-------------------------------------------------------------------------- | |
| 28 | .so ../defs.man \" @@@PRE@@@ | |
| 29 | . | |
| 30 | .\"-------------------------------------------------------------------------- | |
| 31 | .TH tvec-main 3mLib "11 March 2024" "Straylight/Edgeware" "mLib utilities library" | |
| 32 | .\" @tvec_parseargs | |
| 33 | .\" @tvec_readstdin | |
| 34 | .\" @tvec_readfile | |
| 35 | .\" @tvec_readarg | |
| 36 | .\" @tvec_readdflt | |
| 37 | .\" @tvec_readargs | |
| 38 | .\" @tvec_main | |
| 39 | . | |
| 40 | .\"-------------------------------------------------------------------------- | |
| 41 | .SH NAME | |
| 42 | tvec-main \- test vector framework program frontend | |
| 43 | . | |
| 44 | .\"-------------------------------------------------------------------------- | |
| 45 | .SH SYNOPSIS | |
| 46 | . | |
| 47 | .nf | |
| 48 | .B "#include <mLib/tvec.h>" | |
| 49 | .PP | |
| 50 | .ta \w'\fBvoid tvec_parseargs('u | |
| 51 | .BI "void tvec_parseargs(int " argc ", char *" argv "[]," | |
| 52 | .BI " struct tvec_state *" tv_out , | |
| 53 | .BI " int *" argpos_out , | |
| 54 | .BI " const struct tvec_config *" config ); | |
| 55 | .BI "int tvec_readstdin(struct tvec_state *" tv ); | |
| 56 | .BI "int tvec_readfile(struct tvec_state *" tv ", const char *" file ); | |
| 57 | .BI "int tvec_readarg(struct tvec_state *" tv ", const char *" arg ); | |
| 58 | .BI "int tvec_readdflt(struct tvec_state *" tv ", const char *" file ); | |
| 59 | .ta \w'\fBvoid tvec_readargs('u | |
| 60 | .BI "void tvec_readargs(int " argc ", char *" argv "[]," | |
| 61 | .BI " struct tvec_state *" tv , | |
| 62 | .BI " int *" argpos_out ", const char *" dflt ); | |
| 63 | .ta \w'\fBvoid tvec_main('u | |
| 64 | .BI "void tvec_main(int " argc ", char *" argv "[]," | |
| 65 | .BI " const struct tvec_config *" config ", const char *" dflt ); | |
| 66 | .fi |