htop/htop.1.in at wip · hishamhm/htop

This repository was archived by the owner on Sep 8, 2020. It is now read-only.

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

.TH "HTOP" "1" "2015" "@PACKAGE_STRING@" "Utils"

.SH "NAME"

htop \- interactive process viewer

.SH "SYNOPSIS"

.LP

.B htop [\fI\-dChusv\fR]

.SH "DESCRIPTION"

.LP

Htop is a free (GPL) ncurses-based process viewer for Linux.

.LP

It is similar to top, but allows you to scroll vertically and horizontally,

so you can see all the processes running on the system, along with their full

command lines, as well as viewing them as a process tree, selecting mutiple

processes and acting on them all at once.

.LP

Tasks related to processes (killing, renicing) can be done without

entering their PIDs.

.br

.SH "COMMAND-LINE OPTIONS"

.LP

Mandatory arguments to long options are mandatory for short options too.

.LP

.TP

\fB\-d \-\-delay=DELAY\fR

Delay between updates, in tenths of seconds

.TP

\fB\-C \-\-no-color \-\-no-colour\fR

Start htop in monochrome mode

.TP

\fB\-h \-\-help

Display a help message and exit

.TP

\fB\-p \-\-pid=PID,PID...\fR

Show only the given PIDs

.TP

\fB\-s \-\-sort\-key COLUMN\fR

Sort by this column (use \-\-sort\-key help for a column list)

.TP

\fB\-u \-\-user=USERNAME\fR

Show only the processes of a given user

.TP

\fB\-v \-\-version

Output version information and exit

.PP

.br

.SH "INTERACTIVE COMMANDS"

.LP

The following commands are supported while in htop:

.LP

.TP 5

.B Arrows, PgUP, PgDn, Home, End

Scroll the process list.

.TP

.B Space

Tag or untag a process. Commands that can operate on multiple processes,

like "kill", will then apply over the list of tagged processes, instead

of the currently highlighted one.

.TP

.B U

Untag all processes (remove all tags added with the Space key).

.TP

.B s

Trace process system calls: if strace(1) is installed, pressing this key

will attach it to the currently selected process, presenting a live

update of system calls issued by the process.

.TP

.B l

Display open files for a process: if lsof(1) is installed, pressing this key

will display the list of file descriptors opened by the process.

.TP

.B F1, h, ?

Go to the help screen

.TP

.B F2, S

Go to the setup screen, where you can configure the meters displayed at the top

of the screen, set various display options, choose among color schemes, and

select which columns are displayed, in which order.

.TP

.B F3, /

Incrementally search the command lines of all the displayed processes. The

currently selected (highlighted) command will update as you type. While in

search mode, pressing F3 will cycle through matching occurrences.

.TP

.B F4, \\\\

Incremental process filtering: type in part of a process command line and

only processes whose names match will be shown. To cancel filtering,

enter the Filter option again and press Esc.

.TP

.B F5, t

Tree view: organize processes by parenthood, and layout the relations

between them as a tree. Toggling the key will switch between tree and

your previously selected sort view. Selecting a sort view will exit

tree view.

.TP

.B F6

On sorted view, select a field for sorting, also accessible through < and >.

The current sort field is indicated by a highlight in the header.

On tree view, expand or collapse the current subtree. A "+" indicator in the

tree node indicates that it is collapsed.

.TP

.B F7, ]

Increase the selected process's priority (subtract from 'nice' value).

This can only be done by the superuser.

.TP

.B F8, [

Decrease the selected process's priority (add to 'nice' value)

.TP

.B F9, k

"Kill" process: sends a signal which is selected in a menu, to one or a group

of processes. If processes were tagged, sends the signal to all tagged processes.

If none is tagged, sends to the currently selected process.

.TP

.B F10, q

Quit

.TP

.B I

Invert the sort order: if sort order is increasing, switch to decreasing, and

vice-versa.

.TP

.B +, \-

When in tree view mode, expand or collapse subtree. When a subtree is collapsed

a "+" sign shows to the left of the process name.

.TP

.B a (on multiprocessor machines)

Set CPU affinity: mark which CPUs a process is allowed to use.

.TP

.B u

Show only processes owned by a specified user.

.TP

.B M

Sort by memory usage (top compatibility key).

.TP

.B P

Sort by processor usage (top compatibility key).

.TP

.B T

Sort by time (top compatibility key).

.TP

.B F

"Follow" process: if the sort order causes the currently selected process

to move in the list, make the selection bar follow it. This is useful for

monitoring a process: this way, you can keep a process always visible on

screen. When a movement key is used, "follow" loses effect.

.TP

.B K

Hide kernel threads: prevent the threads belonging the kernel to be

displayed in the process list. (This is a toggle key.)

.TP

.B H

Hide user threads: on systems that represent them differently than ordinary

processes (such as recent NPTL-based systems), this can hide threads from

userspace processes in the process list. (This is a toggle key.)

.TP

.B Ctrl-L

Refresh: redraw screen and recalculate values.

.TP

.B Numbers

PID search: type in process ID and the selection highlight will be moved to it.

.PD

.SH "COLUMNS"

.LP

The following columns can display data about each process. A value of '\-' in

all the rows indicates that a column is unsupported on your system, or

currently unimplemented in htop. The names below are the ones used in the

"Available Columns" section of the setup screen. If a different name is

shown in htop's main screen, it is shown below in parenthesis.

.LP

.TP 5

.B Command

The full command line of the process (i.e program name and arguments).

.TP

.B PID

The process ID.

.TP

.B STATE (S)

The state of the process:

\fBS\fR for sleeping (idle)

\fBR\fR for running

\fBD\fR for disk sleep (uninterruptible)

\fBZ\fR for zombie (waiting for parent to read its exit status)

\fBT\fR for traced or suspended (e.g by SIGTSTP)

\fBW\fR for paging

.TP

.B PPID

The parent process ID.

.TP

.B PGRP

The process's group ID.

.TP

.B SESSION (SESN)

The process's session ID.

.TP

.B TTY_NR (TTY)

The controlling terminal of the process.

.TP

.B TPGID

The process ID of the foreground process group of the controlling terminal.

.TP

.B MINFLT

The number of page faults happening in the main memory.

.TP

.B CMINFLT

The number of minor faults for the process's waited-for children (see MINFLT above).

.TP

.B MAJFLT

The number of page faults happening out of the main memory.

.TP

.B CMAJFLT

The number of major faults for the process's waited-for children (see MAJFLT above).

.TP

.B UTIME (UTIME+)

The user CPU time, which is the amount of time the process has spent executing

on the CPU in user mode (i.e everything but system calls), measured in clock

ticks.

.TP

.B STIME (STIME+)

The system CPU time, which is the amount of time the kernel has spent

executing system calls on behalf of the process, measured in clock ticks.

.TP

.B CUTIME (CUTIME+)

The children's user CPU time, which is the amount of time the process's

waited-for children have spent executing in user mode (see UTIME above).

.TP

.B CSTIME (CSTIME+)

The children's system CPU time, which is the amount of time the kernel has spent

executing system calls on behalf of all the process's waited-for children (see

STIME above).

.TP

.B PRIORITY (PRI)

The kernel's internal priority for the process, usually just its nice value

plus twenty. Different for real-time processes.

.TP

.B NICE (NI)

The nice value of a process, from 19 (low priority) to -20 (high priority). A

high value means the process is being nice, letting others have a higher

relative priority. Only root can lower the value.

.TP

.B STARTTIME (START)

The time the process was started.

.TP

.B PROCESSOR (CPU)

The ID of the CPU the process last executed on.

.TP

.B M_SIZE (VIRT)

Size in memory of the total program size.

.TP

.B M_RESIDENT (RES)

The resident set size, i.e the size of the text and data sections, plus stack

usage.

.TP

.B M_SHARE (SHR)

The size of the process's shared pages.

.TP

.B M_TRS (CODE)

The size of the text segment of the process (i.e the size of the processes

executable instructions).

.TP

.B M_DRS (DATA)

The size of the data segment plus stack usage of the process.

.TP

.B M_LRS (LIB)

The library size of the process.

.TP

.B M_DT (DIRTY)

The size of the dirty pages of the process.

.TP

.B ST_UID (UID)

The user ID of the process owner.

.TP

.B PERCENT_CPU (CPU%)

The percentage of the CPU time that the process is currently using.

.TP

.B PERCENT_MEM (MEM%)

The percentage of memory the process is currently using (based on the process's

resident memory size, see M_RESIDENT above).

.TP

.B USER

The username of the process owner, or the user ID if the name can't be

determined.

.TP

.B TIME (TIME+)

The time, measured in clock ticks that the process has spent in user and system

time (see UTIME, STIME above).

.TP

.B NLWP

The number of threads in the process.

.TP

.B TGID

The thread group ID.

.TP

.B CTID

OpenVZ container ID, a.k.a virtual environment ID.

.TP

.B VPID

OpenVZ process ID.

.TP

.B VXID

VServer process ID.

.TP

.B RCHAR (RD_CHAR)

The number of bytes the process has read.

.TP

.B WCHAR (WR_CHAR)

The number of bytes the process has written.

.TP

.B SYSCR (RD_SYSC)

The number of read(2) syscalls for the process.

.TP

.B SYSCW (WR_SYSC)

The number of write(2) syscalls for the process.

.TP

.B RBYTES (IO_RBYTES)

Bytes of read(2) I/O for the process.

.TP

.B WBYTES (IO_WBYTES)

Bytes of write(2) I/O for the process.

.TP

.B CNCLWB (IO_CANCEL)

Bytes of cancelled write(2) I/O.

.TP

.B IO_READ_RATE (DISK READ)

The I/O rate of read(2) in bytes per second, for the process.

.TP

.B IO_WRITE_RATE (DISK WRIT 55C9 E)

The I/O rate of write(2) in bytes per second, for the process.

.TP

.B IO_RATE (DISK R/W)

The I/O rate, IO_READ_RATE + IO_WRITE_RATE (see above).

.TP

.B CGROUP

Which cgroup the process is in.

.TP

.B OOM

OOM killer score.

.TP

.B IO_PRIORITY (IO)

The I/O scheduling class followed by the priority if the class supports it:

\fBR\fR for Realtime

\fBB\fR for Best-effort

\fBid\fR for Idle

.TP

.B All other flags

Currently unsupported (always displays '-').

.SH "CONFIG FILE"

.LP

By default htop reads its configuration from the XDG-compliant path

~/.config/htop/htoprc -- the configuration file is overwritten by htop's

in-program Setup configuration, so it should not be hand-edited.

.LP

You may override the location of the configuration file using the $HTOPRC

environment variable (so you can have multiple configurations for different

machines that share the same home directory, for example).

.SH "SEE ALSO"

proc(5), top(1), free(1), ps(1), uptime(1)

.SH "AUTHORS"

.LP

htop is developed by Hisham Muhammad <hisham@gobolinux.org>.

.LP

This man page was written by Bartosz Fenski <fenio@o2.pl> for the Debian

GNU/Linux distribution (but it may be used by others). It was updated by Hisham

Muhammad, and later by Vincent Launchbury, who wrote the 'Columns' section.

FilesExpand file tree

htop.1.in

Latest commit

History

htop.1.in

File metadata and controls