1\" Generated by c2man from bl_fastx_read.c 2.TH bl_fastx_read 3 3 4.SH LIBRARY 5\" Indicate #includes, library name, -L and -l flags 6.nf 7.na 8#include <biolibc/fastx.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_read(FILE *fastx_stream, bl_fastx_t *record) 18 19.SH ARGUMENTS 20.nf 21.na 22fastx_stream FILE stream from which FASTA data are read 23record Pointer to a bl_fastx_t structure to receive data 24.ad 25.fi 26 27.SH DESCRIPTION 28 29Read a FASTA or FASTQ record from a FILE stream by calling 30bl_read_fasta(3) or bl_read_fastq(3). The bl_fastx_t structure 31must first be initialized by assigning it BL_FASTX_INIT and 32calling bl_fastx_init(3). 33See bl_fasta_read(3) and bl_fastq_read(3) for further details. 34 35.SH RETURN VALUES 36 37BL_READ_OK upon successful read of description and sequence 38BL_READ_BAD_DATA if something is amiss with input format 39BL_READ_EOF if no more data are available 40 41.SH EXAMPLES 42.nf 43.na 44 45bl_fastx_t rec = BL_FASTX_INIT; 46 47bl_fastx_init(stdin, &rec); 48while ( bl_fastx_read(stdin, &rec) != BL_READ_EOF ) 49 bl_fastx_write(stdout, &rec, BL_FASTX_LINE_UNLIMITED); 50bl_fastx_free(&rec); 51.ad 52.fi 53 54.SH SEE ALSO 55 56bl_fastx_write(3), bl_fastq_read(3), bl_fastq_write(3), 57bl_fastx_free(3) 58 59