Print this page
11545 Want configurable output field separator for libofmt
Portions contributed by: Cody Peter Mello <cody.mello@joyent.com>
Reviewed by: Jason King <jason.king@joyent.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>

*** 11,27 **** .\" .\" Copyright 2010 Sun Microsystems, Inc. All rights reserved. .\" Copyright 2017 Nexenta Systems, Inc. .\" Copyright 2018 Joyent, Inc. .\" ! .Dd December 20, 2018 .Dt OFMT 3OFMT .Os .Sh NAME .Nm ofmt_open , .Nm ofmt_print , .Nm ofmt_update_winsize , .Nm ofmt_strerror , .Nm ofmt_close .Nd data structures and routines for printing output .Sh LIBRARY .Lb libofmt --- 11,29 ---- .\" .\" Copyright 2010 Sun Microsystems, Inc. All rights reserved. .\" Copyright 2017 Nexenta Systems, Inc. .\" Copyright 2018 Joyent, Inc. .\" ! .Dd February 13, 2019 .Dt OFMT 3OFMT .Os .Sh NAME .Nm ofmt_open , .Nm ofmt_print , + .Nm ofmt_print_header , .Nm ofmt_update_winsize , + .Nm ofmt_set_fs , .Nm ofmt_strerror , .Nm ofmt_close .Nd data structures and routines for printing output .Sh LIBRARY .Lb libofmt
*** 39,51 **** --- 41,62 ---- .Fo ofmt_print .Fa "ofmt_handle_t ofmt" .Fa "void *cbarg" .Fc .Ft void + .Fo ofmt_print_header + .Fa "ofmt_handle_t ofmt" + .Fc + .Ft void .Fo ofmt_update_winsize .Fa "ofmt_handle_t ofmt" .Fc + .Ft void + .Fo ofmt_set_fs + .Fa "ofmt_handle_t ofmt" + .Fa "char fs" + .Fc .Ft "char *" .Fo ofmt_strerror .Fa "ofmt_handle_t ofmt" .Fa "ofmt_status_t error" .Fa "char *buf"
*** 210,219 **** --- 221,233 ---- .Dv OFMT_PARSABLE will result in .Dv OFMT_EPARSEMULTI . .It Dv OFMT_RIGHTJUST Right justified output. + .It Dv OFMT_NOHEADER + Skip printing the header when calling + .Fn ofmt_print . .El .Pp The non-zero .Fa maxcols limits the number of output columns.
*** 239,248 **** --- 253,271 ---- .Pp The callback function should fill .Fa buf with the string to be printed for the field using the data in .Fa cbarg . + .Ss Fn ofmt_print_header + The + .Fn ofmt_print_header + function prints the output header. + This is usually done as part of calling + .Fn ofmt_print , + but is skipped when using + .Dv OFMT_NOHEADER . + This function allows you to insert it when and where desired. .Ss Fn ofmt_update_winsize The .Fn ofmt_update_winsize function updates the window size information .Pq which is initially computed when the handle is created
*** 249,258 **** --- 272,285 ---- in the .Fa ofmt . If the .Dv TIOCGWINSZ ioctl fails, the window size is set to 80x24. + .Ss Fn ofmt_set_fs + The + .Fn ofmt_set_fs + function sets the output field separator for parsable output. .Ss Fn ofmt_strerror The .Fn ofmt_strerror function returns error diagnostics in .Fa buf