summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNathan Scott <nathans@redhat.com>2020-08-20 13:16:31 +1000
committerNathan Scott <nathans@redhat.com>2020-08-20 13:16:31 +1000
commita7a5e356c2990e7288cb70ebe0b9991b8e4136ba (patch)
treea82b21346f0416d828cbd28953702fc5f084c9af
parentdab4144f4adcb1e2abd30a844a3a11c14ca78ed3 (diff)
Documentation updates to reflect community maintainership
Document the htop.dev site, #htop and htop@groups.io for contacting the community maintainers, and the upcoming 3.0.0 release.
-rw-r--r--README51
-rw-r--r--configure.ac7
-rw-r--r--htop.1.in84
3 files changed, 67 insertions, 75 deletions
diff --git a/README b/README
index 112da1c7..5e657546 100644
--- a/README
+++ b/README
@@ -1,47 +1,28 @@
-[![Build Status](https://travis-ci.org/hishamhm/htop.svg?branch=master)](https://travis-ci.org/hishamhm/htop)
-[![PayPal donate](https://img.shields.io/badge/paypal-donate-green.svg)](http://hisham.hm/htop/index.php?page=donate)
+![htop](https://htop.dev)
-[htop](http://hisham.hm/htop/)
-====
-
-by Hisham Muhammad <hisham@gobolinux.org> (2004 - 2016)
+[![CI](https://github.com/htop-dev/htop/workflows/CI/badge.svg)](https://github.com/htop-dev/htop/actions)
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/21617/badge.svg)](https://scan.coverity.com/projects/21617)
+[![Mailing List](https://img.shields.io/badge/Mailing%20List-htop-blue.svg)](https://groups.io/g/htop)
+[![IRC #htop](https://img.shields.io/badge/IRC-htop-blue.svg)](https://webchat.freenode.net/#htop)
+[![Github Release](https://img.shields.io/github/release/htop-dev/htop.svg)](https://github.com/htop-dev/htop/releases/latest)
Introduction
------------
-This is `htop`, an interactive process viewer.
-It requires `ncurses`. It is developed primarily on Linux,
-but we also have code for running under FreeBSD and Mac OS X
-(help and testing are wanted for these platforms!)
-
-This software has evolved considerably over the years,
-and is reasonably complete, but there is always room for improvement.
-
-Comparison between `htop` and classic `top`
--------------------------------------------
-
-* In `htop` you can scroll the list vertically and horizontally
- to see all processes and full command lines.
-* In `top` you are subject to a delay for each unassigned
- key you press (especially annoying when multi-key escape
- sequences are triggered by accident).
-* `htop` starts faster (`top` seems to collect data for a while
- before displaying anything).
-* In `htop` you don't need to type the process number to
- kill a process, in `top` you do.
-* In `htop` you don't need to type the process number or
- the priority value to renice a process, in `top` you do.
-* In `htop` you can kill multiple processes at once.
-* `top` is older, hence, more tested.
-
-Compilation instructions
-------------------------
+`htop` is a cross-platform interactive process viewer.
+It requires `ncurses`.
+
+For more information and details on how to contribute to `htop`
+visit [htop.dev](https://htop.dev).
+
+Build instructions
+------------------
This program is distributed as a standard autotools-based package.
For detailed instructions see the [INSTALL](/INSTALL) file, which
is created after `./autogen.sh` is run.
-When compiling from a [release tarball](https://hisham.hm/htop/releases/), run:
+When compiling from a [release tarball](https://github.com/htop-dev/htop/releases/), run:
./configure && make
@@ -55,8 +36,6 @@ the path use `./configure --prefix=/some/path`.
See the manual page (`man htop`) or the on-line help ('F1' or 'h'
inside `htop`) for a list of supported key commands.
-If not all keys work check your curses configuration.
-
## License
GNU General Public License, version 2 (GPL-2.0)
diff --git a/configure.ac b/configure.ac
index 4c7360e6..71a4f799 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2,10 +2,7 @@
# Process this file with autoconf to produce a configure script.
AC_PREREQ(2.65)
-AC_INIT([htop],[2.2.0],[hisham@gobolinux.org])
-
-SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-$(date +%s)}"
-year=$(date -u -d "@$SOURCE_DATE_EPOCH" "+%Y" 2>/dev/null || date -u -r "$SOURCE_DATE_EPOCH" "+%Y" 2>/dev/null || date -u "+%Y")
+AC_INIT([htop],[3.0.0],[htop@groups.io])
AC_CONFIG_SRCDIR([htop.c])
AC_CONFIG_AUX_DIR([.])
@@ -308,7 +305,7 @@ if test ! -z "$missing_headers"; then
AC_MSG_ERROR([missing headers: $missing_headers])
fi
-AC_DEFINE_UNQUOTED(COPYRIGHT, "(C) 2004-$year Hisham Muhammad", [Copyright message.])
+AC_DEFINE_UNQUOTED(COPYRIGHT, "(C) 2004-2018 Hisham Muhammad", [Copyright message.])
# We're done, let's go!
# ----------------------------------------------------------------------
diff --git a/htop.1.in b/htop.1.in
index 149b1465..faac2036 100644
--- a/htop.1.in
+++ b/htop.1.in
@@ -1,4 +1,4 @@
-.TH "HTOP" "1" "2015" "@PACKAGE_STRING@" "Utils"
+.TH "HTOP" "1" "2020" "@PACKAGE_STRING@" "User Commands"
.SH "NAME"
htop \- interactive process viewer
.SH "SYNOPSIS"
@@ -6,12 +6,16 @@ htop \- interactive process viewer
.B htop [\fI\-dChustv\fR]
.SH "DESCRIPTION"
.LP
-Htop is a free (GPL) ncurses-based process viewer for Linux.
+.B htop
+is a cross-platform ncurses-based process viewer.
.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 multiple
-processes and acting on them all at once.
+It is similar to
+.BR top ,
+but allows you to scroll vertically and horizontally, and interact using
+a pointing device (mouse).
+You can observe all processes running on the system, along with their
+command line arguments, as well as view them in a tree format, select
+multiple processes and acting on them all at once.
.LP
Tasks related to processes (killing, renicing) can be done without
entering their PIDs.
@@ -25,7 +29,9 @@ Mandatory arguments to long options are mandatory for short options too.
Delay between updates, in tenths of seconds
.TP
\fB\-C \-\-no-color \-\-no-colour\fR
-Start htop in monochrome mode
+Start
+.B htop
+in monochrome mode
.TP
\fB\-h \-\-help
Display a help message and exit
@@ -44,11 +50,10 @@ Output version information and exit
.TP
\fB\-t \-\-tree
Show processes in tree view
-.PP
-.br
.SH "INTERACTIVE COMMANDS"
.LP
-The following commands are supported while in htop:
+The following commands are supported while in
+.BR htop :
.LP
.TP 5
.B Up, Alt-k
@@ -194,14 +199,17 @@ Refresh: redraw screen and recalculate values.
.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
+currently unimplemented in
+.BR 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.
+shown in
+.BR htop 's
+main screen, it is shown below in parenthesis.
.LP
.TP 5
.B Command
@@ -389,36 +397,44 @@ The percentage of time spent swapping in pages. Requires CAP_NET_ADMIN.
.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. If no
-user configuration exists htop tries to read the system-wide configuration
-from @sysconfdir@/htoprc and as a last resort, falls back to its
-hard coded defaults.
+By default
+.B htop
+reads its configuration from the XDG-compliant path
+.IR ~/.config/htop/htoprc .
+The configuration file is overwritten by
+.BR htop 's
+in-program Setup configuration, so it should not be hand-edited.
+If no user configuration exists
+.B htop
+tries to read the system-wide configuration from
+.I @sysconfdir@/htoprc
+and as a last resort, falls back to its hard coded defaults.
.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 "MEMORY SIZES"
.LP
-Memory sizes in htop are displayed as they are in tools from the GNU Coreutils
-(when ran with the --human-readable option). This means that sizes are printed
-in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
+Memory sizes in
+.B htop
+are displayed in a human-readable form.
+Sizes are printed in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
.LP
-The decision to use this convention was made in order to conserve screen space
-and make memory size representations consistent throughout htop.
-
+The decision to use this convention was made in order to conserve screen
+space and make memory size representations consistent throughout
+.BR htop .
.SH "SEE ALSO"
-proc(5), top(1), free(1), ps(1), uptime(1), limits.conf(5)
-
+.BR proc (5),
+.BR top (1),
+.BR free (1),
+.BR ps (1),
+.BR uptime (1)
+and
+.BR limits.conf (5).
.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.
+.B htop
+was originally developed by Hisham Muhammad.
+Nowadays it is maintained by the community at <htop@groups.io>.

© 2014-2024 Faster IT GmbH | imprint | privacy policy