TFPROF(1)

πŸ’– TFPROF(1) πŸ’–

okay bestie, welcome to the General Commands Manual section, we're talking about tfprof and honestly? she's iconic.


✨ NAME ✨

tfprof β€” profile a Taskflow program 🫢


✨ SYNOPSIS ✨

tfprof [options]

✨ DESCRIPTION ✨

so tfprof is literally the program that visualises and profiles programs you compiled with Taskflow. no cap.

the way you do it is: compile your program with cmake using the option -D TF_BUILD_PROFILER=ON, then run it with an environment variable that says where the profile data output file should go. for example, from inside the build directory:

$ cmake ../ -D TF_BUILD_PROFILER=ON
$ make
$ TF_ENABLE_PROFILER=my_taskflow.tfp ./my_taskflow

then you run the profiler to visualise the output, like:

$ tfprof --input my_taskflow.tfp

and the results can be seen at http://localhost:8080/ ✨ main character URL honestly.


✨ OPTIONS ✨

  • -h, --help β€” show summary of options. the little "hey what does this do" moment πŸ’…
  • -i, --input β€” the profiling data file. this option is required, so don't be skipping it fr fr.
  • -m, --mount β€” the location of the static Taskflow profiler server files. in the Debian version of tfprof, this is optional; it defaults to /usr/share/taskflow. she has a default, she's low maintenance πŸŽ€
  • -p, --port β€” the port the server should listen on; this defaults to 8080. πŸ¦‹

✨ SEE ALSO ✨

the Taskflow system is documented fully in the documentation, available in the taskflow-doc package on Debian systems, or online at https://taskflow.github.io/taskflow/index.html 🌈


okay that's the whole page, go profile something and slay πŸ’…

mwah πŸ’– that was the TFPROF(1) page, dated February 22 2024 β€” general commands manual energy, periodt. πŸŽ€βœ¨

πŸ“¦ where this page comes from