[babeltrace.git] / doc / man / babeltrace2-plugin-text.7.txt

= babeltrace2-plugin-text(7)
:manpagetype: plugin
:revdate: 14 September 2019


== NAME

babeltrace2-plugin-text - Babeltrace 2's plain text plugin


== DESCRIPTION

The Babeltrace~2 `text` plugin contains component classes which
read or write plain text data.

include::common-see-babeltrace2-intro.txt[]


== COMPONENT CLASSES

compcls:source.text.dmesg::
    Reads the lines of a Linux kernel ring buffer, that is, the output
    of the man:dmesg(1) tool, and emits each line as an event message.
+
See man:babeltrace2-source.text.dmesg(7).

compcls:sink.text.details::
    Deterministically prints the messages it consumes with details to
    the standard output.
+
See man:babeltrace2-sink.text.details(7).

compcls:sink.text.pretty::
    Pretty-prints the messages it consumes to the standard output or to
    a file.
+
This is equivalent to the `text` output format of man:babeltrace(1)
(Babeltrace~1).
+
See man:babeltrace2-sink.text.pretty(7).


include::common-footer.txt[]


== SEE ALSO

man:babeltrace2-intro(7),
man:babeltrace2-source.text.dmesg(7),
man:babeltrace2-sink.text.details(7),
man:babeltrace2-sink.text.pretty(7)
Commit	Line	Data
	1	= babeltrace2-plugin-text(7)
	2	:manpagetype: plugin
	3	:revdate: 14 September 2019
	4
	5
	6	== NAME
	7
	8	babeltrace2-plugin-text - Babeltrace 2's plain text plugin
	9
	10
	11	== DESCRIPTION
	12
	13	The Babeltrace~2 `text` plugin contains component classes which
	14	read or write plain text data.
	15
	16	include::common-see-babeltrace2-intro.txt[]
	17
	18
	19	== COMPONENT CLASSES
	20
	21	compcls:source.text.dmesg::
	22	Reads the lines of a Linux kernel ring buffer, that is, the output
	23	of the man:dmesg(1) tool, and emits each line as an event message.
	24	+
	25	See man:babeltrace2-source.text.dmesg(7).
	26
	27	compcls:sink.text.details::
	28	Deterministically prints the messages it consumes with details to
	29	the standard output.
	30	+
	31	See man:babeltrace2-sink.text.details(7).
	32
	33	compcls:sink.text.pretty::
	34	Pretty-prints the messages it consumes to the standard output or to
	35	a file.
	36	+
	37	This is equivalent to the `text` output format of man:babeltrace(1)
	38	(Babeltrace~1).
	39	+
	40	See man:babeltrace2-sink.text.pretty(7).
	41
	42
	43	include::common-footer.txt[]
	44
	45
	46	== SEE ALSO
	47
	48	man:babeltrace2-intro(7),
	49	man:babeltrace2-source.text.dmesg(7),
	50	man:babeltrace2-sink.text.details(7),
	51	man:babeltrace2-sink.text.pretty(7)