]> granicus.if.org Git - psmisc/commitdiff
misc: Update README.md
authorCraig Small <csmall@enc.com.au>
Mon, 25 Apr 2016 11:04:00 +0000 (21:04 +1000)
committerCraig Small <csmall@enc.com.au>
Mon, 25 Apr 2016 11:04:00 +0000 (21:04 +1000)
The README appears a little odd on gitlab, this should make things
clearer.

README.md

index e9da6fc918bca9664c0a943832fe2ca5892fc2e6..efe94bca5a7b7e1f6a3334ffc54d73eb52b3c8e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,43 +1,36 @@
-psmisc
-======
+# psmisc
 
-This package contains five little utilities that use the proc FS:
+A package of small utilities that use the proc file-system.
 
-  fuser     identifies processes using files or sockets (similar to Sun's
-           or SGI's fuser)
-  killall   kills processes by name, e.g. killall -HUP named
-  pstree    shows the currently running processes as a tree
-  peekfd    shows the data travelling over a file descriptor
+* *fuser* - Identifies processes using files or sockets
+* *killall* - kills processes by name, e.g. killall -HUP named
+* *prtstat* - print statistics of a process
+* *pstree* - shows the currently running processes as a tree
+* *peekfd* - shows the data travelling over a file descriptor
 
-They should work with most recent kernels. Man pages are included.
+psmisc is now hosted on gitlab at https://gitlab.com/psmisc/psmisc
+for bugs or issues please use the issue tracker at
+https://gitlab.com/psmisc/psmisc/issues
 
-- Werner Almesberger <Werner.Almesberger@epfl.ch>
-
-src/loop.h was stolen from util-linux package which in turn stole it from
-the Linux kernel.
-
-fuser on network fs
--------------------
-On network filesystems, fuser can hang because its trying to stat files
+## fuser on network fs
+On network file-systems, fuser can hang because its trying to stat files
 that may go away.  If you use the --with-timeout-stat option during
 the configure step then fuser will fork a process to run stat. This means
 fuser doesn't hang, but it is much slower.
 
-Translations
-------------
+## Credits
+
+### Translations
 My thanks for the various translators who have cheerfully given me the po
 files to make psmisc speak different languages.  If your language is not
 supported then let me know, all it takes is translating one file in 
 a certain manner.
 
-Icons
------
+### Icons
 The pstree icons were drawn by Tatlin at Coresis who has given permission
 for them to be used for psmisc.
 
-Copyright Change
-----------------
-
+## Copyright Change
 The license has changed to GPL for version 20 onwards with permission
 of the original authors.  People who want to use these programs under
 the previous license will have to look at psmisc 19 or below.