1\" Generated by c2man from bl_fastx_init.c
2.TH bl_fastx_init 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/fasta.h>
9-lbiolibc -lxtend
10.ad
11.fi
12
13\" Convention:
14\" Underline anything that is typed verbatim - commands, etc.
15.SH SYNOPSIS
16.PP
17void    bl_fastx_init(FILE *fastx_stream, bl_fastx_t *record)
18
19.SH ARGUMENTS
20.nf
21.na
22record  Pointer to the bl_fastx_t structure to initialize.
23.ad
24.fi
25
26.SH DESCRIPTION
27
28Initialize a bl_fastx_t structure by peaking at the first character
29of the description string to determine whether the stream is FASTA
30or FASTQ, and then initializing the appropriate structure within
31the bl_fastx_t structure.  This must be done before
32passing it to bl_fastx_read() for the first time, so that
33bl_fastx_read() will know to allocate memory for the fields.
34
35.SH EXAMPLES
36.nf
37.na
38
39bl_fastx_t  rec = BL_FASTX_INIT;
40
41bl_fastx_init(&rec);
42bl_fastx_read(stdin, &rec);
43...
44bl_fastx_free(&rec);
45.ad
46.fi
47
48.SH SEE ALSO
49
50bl_fastx_read(3), bl_fastx_write(3)
51
52