meta

README.md

@@ -1,7 +1,47 @@
-multitail
-=========
-
+What is it?
+-----------
 MultiTail allows you to monitor logfiles and command output in multiple windows in a terminal, colorize, filter and merge. http://vanheusden.com/multitail/
 
+Check http://www.vanheusden.com/multitail/ for new(er) versions.
+
+
+Help?
+-----
+For help at any time, press F1.
+
+
+How to compile
+--------------
+By default multitail requires the ncursesw library (ncursesW!) to compile and run.
+You can choose to use the non-wide char version (ncurses) by setting UTF8_SUPPORT to "no"
+in the makefile. Note that this disables UTF8 support.
+
+
+Tips
+----
+You can also use MultiTail to view logfiles on other hosts!
+How?
+Like this:
+multitail -l "ssh username@host tail -f file"
+Q: but then I cannot enter the password!
+A1: use authentication via keys
+A2: or use "ssh-agent": then you only once have to enter your passphrase (so login once
+    to that host manually, and then start MultiTail)
+
+
+Q & A
+-----
+Q: the program fails then resizing the terminal-window
+A: solution: upgrade ncursesw to version 5.3 (or more recent)
+
+Q: when I use the -l option on some program, I get nothing in the window
+A: now that is strange! please tell me what program you're trying to interface to MultiTail.
+   please do: any help is appreciated!
+
+
+License
+-------
+See the LICENSE file.
+
 
-[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=flok&url=https://github.com/flok99/multitail&title=multitail&language=&tags=github&category=software)
+For suggestions, write to: mail@vanheusden.com