Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
btm(1)			    General Commands Manual			btm(1)

NAME
       btm  -  A  customizable cross-platform graphical	process/system monitor
       for the terminal. Supports Linux, macOS,	and Windows.

SYNOPSIS
       btm  [--autohide_time]  [-b|--basic]  [-C|--config_location]  [-t|--de-
       fault_time_value]    [--default_widget_count]   [--default_widget_type]
       [--disable_click] [-m|--dot_marker] [-e|--expanded]  [--hide_table_gap]
       [--hide_time]  [-r|--rate] [--retention]	[--show_table_scroll_position]
       [-d|--time_delta]  [-S|--case_sensitive]	 [-u|--current_usage]  [--dis-
       able_advanced_kill]  [-g|--group_processes] [--process_memory_as_value]
       [--process_command]  [-R|--regex]  [-T|--tree]  [-n|--unnormalized_cpu]
       [-W|--whole_word]    [-c|--celsius]   [-f|--fahrenheit]	 [-k|--kelvin]
       [-l|--cpu_left_legend]	 [--default_cpu_entry]	   [-a|--hide_avg_cpu]
       [--memory_legend]  [--enable_cache_memory]  [--network_legend]  [--net-
       work_use_bytes]	  [--network_use_binary_prefix]	   [--network_use_log]
       [--use_old_network_legend]    [--battery]    [--enable_gpu]   [--theme]
       [-h|--help] [-V|--version]

DESCRIPTION
       A customizable cross-platform graphical process/system monitor for  the
       terminal. Supports Linux, macOS,	and Windows.

OPTIONS
       --autohide_time
	      Automatically  hides  the	time scale in graphs after being shown
	      for a brief moment when zoomed in/out. If	time is	disabled using
	      --hide_time then this will have no effect.

       -b, --basic
	      Hides graphs and uses a more basic  look,	 largely  inspired  by
	      htop's design.

       -C, --config_location=PATH
	      Sets  the	 location of the config	file. Expects a	config file in
	      the TOML format. If it doesn't exist, a default config  file  is
	      created  at the path. If no path is provided, the	default	config
	      location will be used.

       -t, --default_time_value=TIME
	      Default time value for graphs. Either a number  in  milliseconds
	      or  a 'human duration' (e.g. 60s,	10m). Defaults to 60s, must be
	      at least 30s.

       --default_widget_count=N
	      Sets the N'th selected widget type to use	as the default widget.
	      Requires 'default_widget_type' to	also be	set, and  defaults  to
	      1.

	      This  reads from left to right, top to bottom. For example, sup-
	      pose    we    have     a	   layout     that     looks	 like:
	      +-------------------+-----------------------+   |	      CPU  (1)
	      |			    CPU		     (2)		     |
	      +---------+---------+-------------+---------+  |	Process	 | CPU
	      (3)      |       Temperature	 |	 CPU	   (4)	     |
	      +---------+---------+-------------+---------+

	      And  we  set  our	default	widget type to 'CPU'. If we set	'--de-
	      fault_widget_count 1', then it would use the CPU (1) as the  de-
	      fault widget. If we set '--default_widget_count 3', it would use
	      CPU (3) as the default instead.

       --default_widget_type=WIDGET
	      Sets which widget	type to	use as the default widget. For the de-
	      fault  layout, this defaults to the 'process' widget. For	a cus-
	      tom layout, it defaults to the first widget it sees.

	      For  example,  suppose  we  have	a  layout  that	 looks	 like:
	      +-------------------+-----------------------+   |	      CPU  (1)
	      |			    CPU		     (2)		     |
	      +---------+---------+-------------+---------+  |	Process	 | CPU
	      (3)      |       Temperature	 |	 CPU	   (4)	     |
	      +---------+---------+-------------+---------+

	      Then,  setting '--default_widget_type temperature' will make the
	      temperature widget selected by default.

	      [possible	 values:  cpu,	mem,  net,  network,  proc,   process,
	      processes, temp, temperature, disk, batt,	battery]

       --disable_click
	      Disables mouse clicks from interacting with bottom.

       -m, --dot_marker
	      Uses  a  dot marker for graphs as	opposed	to the default braille
	      marker.

       -e, --expanded
	      Expand the default widget	upon starting the app. This  flag  has
	      no effect	in basic mode (--basic).

       --hide_table_gap
	      Hides spacing between table headers and entries.

       --hide_time
	      Hides the	time scale from	being shown.

       -r, --rate=TIME
	      Sets  how	 often data is refreshed. Either a number in millisec-
	      onds or a	'human duration' (e.g. 1s, 1m).	Defaults to  1s,  must
	      be  at  least  250ms. Smaller values may result in higher	system
	      resource usage.

       --retention=TIME
	      How far back data	will be	stored up to. Either a number in  mil-
	      liseconds	 or  a 'human duration'	(e.g. 10m, 1h).	Defaults to 10
	      minutes, and must	be at least  1 minute. Larger values  may  re-
	      sult in higher memory usage.

       --show_table_scroll_position
	      Shows  the  list scroll position tracker in the widget title for
	      table widgets.

       -d, --time_delta=TIME
	      The amount of time changed when zooming in/out. Takes  a	number
	      in  milliseconds	or a human duration (e.g. 30s).	The minimum is
	      1s, and defaults to 15s.

       -S, --case_sensitive
	      Enables  case  sensitivity  by  default  when  searching	for  a
	      process.

       -u, --current_usage
	      Calculates  process  CPU	usage as a percentage of current usage
	      rather than total	usage.

       --disable_advanced_kill
	      Hides additional stopping	options	Unix-like systems.  Signal  15
	      (TERM) will be sent when stopping	a process.

       -g, --group_processes
	      Groups processes with the	same name by default.

       --process_memory_as_value
	      Defaults to showing process memory usage by value. Otherwise, it
	      defaults to showing it by	percentage.

       --process_command
	      Shows  the  full command name instead of the process name	by de-
	      fault.

       -R, --regex
	      Enables regex by default while searching.

       -T, --tree
	      Makes the	process	widget use tree	mode by	default.

       -n, --unnormalized_cpu
	      Show process CPU%	usage without averaging	over the number	of CPU
	      cores.

       -W, --whole_word
	      Enables whole-word matching by default while searching.

       -c, --celsius
	      Use Celsius as the temperature unit. This	is the default option.

       -f, --fahrenheit
	      Use Fahrenheit as	the temperature	unit.

       -k, --kelvin
	      Use Kelvin as the	temperature unit.

       -l, --cpu_left_legend
	      Puts the CPU chart legend	on the left side.

       --default_cpu_entry=ENTRY
	      Sets which CPU entry type	is selected by default.

	      [possible	values:	all, avg]

       -a, --hide_avg_cpu
	      Hides the	average	CPU usage entry.

       --memory_legend=POSITION
	      Where to place the legend	for the	memory chart widget.

	      [possible	values:	none, top-left,	top, top-right,	 left,	right,
	      bottom-left, bottom, bottom-right]

       --enable_cache_memory
	      Enables collecting and displaying	cache and buffer memory.

       --network_legend=POSITION
	      Where to place the legend	for the	network	chart widget.

	      [possible	 values:  none,	top-left, top, top-right, left,	right,
	      bottom-left, bottom, bottom-right]

       --network_use_bytes
	      Displays the network widget using	bytes. Defaults	to bits.

       --network_use_binary_prefix
	      Displays the network widget with binary prefixes (e.g. kibibits,
	      mebibits)	 rather	 than  a  decimal  prefixes  (e.g.   kilobits,
	      megabits). Defaults to decimal prefixes.

       --network_use_log
	      Displays	the  network  widget  with  a log scale. Defaults to a
	      non-log scale.

       --use_old_network_legend
	      (DEPRECATED) Uses	separate network widget	legend.	 This  display
	      is not tested and	may be broken.

       --battery
	      Shows  the  battery widget in default or basic mode, if there is
	      as battery available. This has no	effect on custom  layouts;  if
	      the  battery  widget  is desired for a custom layout, explicitly
	      specify it.

       --enable_gpu
	      Enable collecting	and displaying GPU usage.

       --theme=SCHEME
	      Use a pre-defined	color theme. Currently supported themes	are: -
	      default -	default-light (default but adjusted for	lighter	 back-
	      grounds)	-  gruvbox	  (a  bright theme with	'retro groove'
	      colors) -	gruvbox-light (gruvbox but adjusted for	lighter	 back-
	      grounds) - nord	       (an arctic, north-bluish	color palette)
	      -	nord-light    (nord but	adjusted for lighter backgrounds)

       -h, --help
	      Prints help info (for more details use '--help'.

       -V, --version
	      Prints version information.

VERSION
       v0.10.2

AUTHORS
       Clement Tsang <cjhtsang@uwaterloo.ca>

				  btm 0.10.2				btm(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=btm&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help