1\" Generated by c2man from bl_fastx_write.c
2.TH bl_fastx_write 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
17int     bl_fastx_write(FILE *fastx_stream, bl_fastx_t *record,
18size_t max_line_len)
19
20.SH ARGUMENTS
21.nf
22.na
23fastx_stream    FILE stream to which data are written
24record          Pointer to a bl_fastx_t structure to be written
25max_line_len    Maximum length of a sequence line in output
26.ad
27.fi
28
29.SH DESCRIPTION
30
31Write a FASTA or FASTQ record from a FILE stream by calling
32bl_fasta_write(3) or bl_fastq_write(3).  The bl_fastx_t structure
33must first be initialized by assigning it BL_FASTX_INIT and
34calling bl_fastx_init(3), and then populated by bl_fastx_read(3)
35or other means.  Previously used
36variables may be reused to process another record in the same
37format (FASTA or FASTQ) or reinitialized by bl_fastx_free(3);
38See bl_fasta_write(3) and bl_fastq_write(3) for further details.
39
40.SH RETURN VALUES
41
42BL_WRITE_OK upon success, BL_WRITE_FAILURE if a write error occurs.
43
44.SH EXAMPLES
45.nf
46.na
47
48bl_fastx_t  rec = BL_FASTX_INIT;
49
50bl_fastx_init(stdin, &rec);
51while ( bl_fastx_read(stdin, &rec) != BL_READ_EOF )
52    bl_fastx_write(stdout, &rec, BL_FASTX_LINE_UNLIMITED);
53bl_fastx_free(&rec);
54.ad
55.fi
56
57.SH SEE ALSO
58
59bl_fastx_read(3), bl_fastq_read(3), bl_fastq_write(3),
60
61