X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Fustctl.1.md;h=c8ad1f1722fc907bb03a31e0f88a2cfb59b44b55;hb=9dc7b7ff797a5cbb1e9ffd59e053a04562f306c4;hp=eefd89f114873a5c99d6e03ad341490948c2ca0b;hpb=3af38436ac4098c3b388963444ba690ff3b32885;p=lttng-ust.git diff --git a/doc/man/ustctl.1.md b/doc/man/ustctl.1.md index eefd89f1..c8ad1f17 100644 --- a/doc/man/ustctl.1.md +++ b/doc/man/ustctl.1.md @@ -60,6 +60,9 @@ starting with two dashes(`-'). A summary of options is included below. * `--list-markers`: List the markers of the process, their state and format string. + * `--force-switch`: + Force a subbuffer switch. This will flush all the data currently held. + ## LIFE CYCLE OF A TRACE Typically, the first step is to enable markers with `--enable-marker`. An @@ -83,11 +86,14 @@ being recorded in the buffer. The daemon automatically collects these events. The trace may be stopped with `--stop-trace`, either definitely after all the wanted information is collected, or temporarily, before being started again -with `--start-trace`. This results in effectively "pausing" the recording. +with `--start-trace`. This results in effectively 'pausing' the recording. +After using `--stop-trace`, if a daemon is collecting the trace, it may not +have flushed to the disk the full contents of the buffer yet. Finally, when `--destroy-trace` is used, the trace buffers are unallocated. However, the memory may not be effectively freed until the daemon finishes to -collect them. +collect them. When the trace is being collected by `ust-consumerd`, this command +guarantees its full contents is flushed to the disk. ## STRUCTURE OF A TRACE @@ -112,7 +118,7 @@ count is set with `--set-subbuf-num`. ## SEE ALSO -usttrace(1), ustd(1) +usttrace(1), ust-consumerd(1) ## AUTHOR