1\" Generated by c2man from bl_gff_read.c 2.TH bl_gff_read 3 3 4.SH LIBRARY 5\" Indicate #includes, library name, -L and -l flags 6.nf 7.na 8#include <biolibc/gff.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_gff_read(bl_gff_t *gff_feature, gff_field_mask_t field_mask, 18FILE *gff_stream) 19 20.SH ARGUMENTS 21.nf 22.na 23gff_stream A FILE stream from which to read the line 24gff_feature Pointer to a bl_gff_t structure 25field_mask Bit mask indicating which fields to store in gff_feature 26.ad 27.fi 28 29.SH DESCRIPTION 30 31Read next feature (line) from a GFF file. 32 33If field_mask is not BL_GFF_FIELD_ALL, fields not indicated by a 1 34in the bit mask are discarded rather than stored in gff_feature. 35That field in the structure is then populated with an appropriate 36marker, such as '.'. Possible mask values are: 37 38BL_GFF_FIELD_ALL 39BL_GFF_FIELD_SEQUENCE 40BL_GFF_FIELD_SOURCE 41BL_GFF_FIELD_FEATURE 42BL_GFF_FIELD_START 43BL_GFF_FIELD_END 44BL_GFF_FIELD_SCORE 45BL_GFF_FIELD_STRAND 46BL_GFF_FIELD_PHASE 47BL_GFF_FIELD_ATTRIBUTES 48 49.SH RETURN VALUES 50 51BL_READ_OK on successful read 52BL_READ_EOF if EOF is encountered after a complete feature 53BL_READ_TRUNCATED if EOF or bad data is encountered elsewhere 54 55.SH EXAMPLES 56.nf 57.na 58 59bl_gff_read(stdin, &gff_feature, BL_GFF_FIELD_ALL); 60bl_gff_read(gff_stream, &gff_feature, 61 BL_GFF_FIELD_SEQUENCE|BL_GFF_FIELD_START|BL_GFF_FIELD_END); 62.ad 63.fi 64 65.SH SEE ALSO 66 67bl_gff_write(3) 68 69