add manpages

5 files changed, 164 insertions, 69 deletions

diff --git a/GNUmakefile b/GNUmakefile
index dfc16d2..2918758 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -40,10 +40,13 @@ LDLIBS += $(shell test "$(pkglst)" != "" && pkg-config --libs   $(pkglst))
 build: $(TARGETS)
 
 install: build
-	$(INSTALL_DIR) $(bindir) $(appdir)
+	$(INSTALL_DIR) $(bindir) $(appdir) $(mandir)/man1 $(mandir)/man7
 	$(INSTALL_BINARY) $(TARGETS) $(bindir)
 	$(INSTALL_SCRIPT) amttool $(bindir)
 	$(INSTALL_DATA) $(DESKTOP) $(appdir)
+	$(INSTALL_DATA) gamt.man $(mandir)/man1/gamt.1
+	$(INSTALL_DATA) amtterm.man $(mandir)/man1/amtterm.1
+	$(INSTALL_DATA) amt-howto.man $(mandir)/man7/amt-howto.7
 
 clean:
 	rm -f *.o *~
diff --git a/amt-howto.txt b/amt-howto.man
index b54ff51..f0aa140 100644
--- a/amt-howto.txt
+++ b/amt-howto.man
@@ -1,10 +1,9 @@
-Intel AMT with linux mini HowTo
-===============================
-
-
-What is AMT and why I should care?
-----------------------------------
+.TH amt-howto 7 "(c) 2007 Gerd Hoffmann"
+.SH SYNOPSIS
+Intel AMT with linux mini howto
+.SH DESCRIPTION
 
+.SS What is AMT and why I should care?
 AMT stands for "Active Management Technology".  It provides some
 remote management facilities.  They are handled by the hardware and
 firmware, thus they work independant from the operation system.
@@ -12,112 +11,109 @@ Means: It works before Linux bootet up to the point where it activated
 the network interface.  It works even when your most recent test
 kernel deadlocked the machine.  Which makes it quite useful for
 development machines ...
-
-
-Enabling AMT
-------------
-
-Look here for verbose documentation:
-  http://www.intel.com/technology/platform-technology/intel-amt/engage.htm
-Most useful to get started:
-  "Intel AMT Deployment and Reference Guide"
-
-Very short HowTo:
-  * Enter BIOS Setup.
-    - Enable AMT
-  * Enter ME (Management Extention) Setup.  Ctrl-P hotkey works for me.
-    - Login, factory default password is "admin".
-    - Change password.  Trivial ones don't work, must include upper-
-      and lowercase letters, digits, special characters.
-    - Enable AMT Managment.
-  * Reboot, Enter ME Setup again with AMT enabled.
-    - Configure AMT (hostname, network config, ...)
-    - Use SMB (Small Business) management mode.  The other one
-      (Enterprise) requires Active Directory Service Infrastructure,
-      you don't want that, at least not for your first steps ...
-
-
-Testing AMT
------------
-
+.P
+Intel AMT is part of the vPro Platform.  Recent intel-chipset based
+business machines should have it.  My fairly new Intel SDV machine has
+it too.
+
+.SS Documentation
+Look here for documentation beyond this mini howto:
+.br
+http://www.intel.com/technology/platform-technology/intel-amt/engage.htm
+.br
+Most useful to get started: "Intel AMT Deployment and Reference Guide"
+
+.SS Very short AMT enabling instructions.
+.TP
+Enter BIOS Setup.
+* Enable AMT
+.TP
+Enter ME (Management Extention) Setup.  Ctrl-P hotkey works for me.
+* Login, factory default password is "admin".
+.br
+* Change password.  Trivial ones don't work, must include upper-
+and lowercase letters, digits, special characters.
+.br
+* Enable AMT Managment.
+.TP
+Reboot, Enter ME Setup again with AMT enabled.
+* Configure AMT (hostname, network config, ...)
+.br
+* Use SMB (Small Business) management mode.  The other one
+(Enterprise) requires Active Directory Service Infrastructure,
+you don't want that, at least not for your first steps ...
+
+.SS Testing AMT
 Take your browser, point it to http://machine:16992/.  If you
 configured AMT to use DHCP (which is the default) the OS and the
 management stack share the same IP address.
-
+.P
 You must do that from a remote host as the NIC intercepts network
 packets for AMT, thus it doesn't work from the local machine as the
 packets never pass the NIC then.  If everything is fine you'll see a
 greeting page with a button for login.
-
+.P
 You can login now, using "admin" as username and the password
 configured during setup.  You'll see some pages with informations
 about the machine.  You can also change AMT settings here.
 
-
-Control Machine
----------------
-
+.SS Control Machine
 You might have noticed already while browing the pages: There is a
 "Remote Control" page.  You can remotely reset and powercycle the
 machine there, thus recover the machine after booting a b0rken kernel,
 without having someone walk over to the machine and hit the reset
 button.
 
-
-Serial-over-LAN (SOL) console
------------------------------
-
+.SS Serial-over-LAN (SOL) console
 AMT also provides a virtual serial port which can be accessed via
 network.  That gives you a serial console without a serial cable to
 another machine.
-
+.P
 If you have activated AMT and SOL the linux kernel should see an
 additional serial port, like this on my machine:
-
+.P
+.nf
   [root@xeni ~]# dmesg | grep ttyS2
   0000:00:03.3: ttyS2 at I/O 0xe000 (irq = 169) is a 16550A
-
+.fi
+.P
 Edit initab, add a line like this:
-
+.P
+.nf
   S2:2345:respawn:/sbin/agetty ttyS2 115200 vt100-nav
-
+.fi
+.P
 You should add the serial port to /etc/securetty too so you are able
 to login as root.  Reload inittab ("init q").  Use amtterm to connect.
 Tap enter.  You should see a login prompt now and be able to login.
-
+.P
 You can also use that device as console for the linux kernel, using
-the usual "console=ttyS0,115200" kernel command line argument, so you
+the usual "console=ttyS2,115200" kernel command line argument, so you
 see the boot messages (and kernel Oopses, if any).
-
+.P
 You can tell grub to use that serial device, so you can pick a working
 kernel for the next boot.  Usual commands from the grub manual, except
 that you need "--port=0xe000" instead of "--unit=0" due to the
 non-standard I/O port for the serial line (my machine, yours might use
 another port, check linux kernel boot messages).
-
+.P
 The magic command for the Xen kernel is "com1=115200,8n1,0xe000,0"
 (again, you might have to replace the I/O port).  The final '0'
 disables the IRQ, otherwise the Xen kernel hangs at boot after
 enabling interrupts.
 
-
-Fun with Xen and AMT
---------------------
-
+.SS Fun with Xen and AMT
 The AMT network stack seems to become slightly confused when running
 on a Xen host in DHCP mode.  Everything works fine as long as only
 Dom0 runs.  But if one starts a guest OS (with bridged networking) AMT
 suddenly changes the IP address to the one the guest aquired via DHCP.
-
+.P
 It is probably a good idea to assign a separate static IP address to
 AMT then.  I didn't manage to switch my machine from DHCP to static IP
 yet though, the BIOS refuses to accept the settings.  The error
 message doesn't indicate why.
 
-
-More fun with AMT
------------------
-
+.SS More fun with AMT
 You might want to download the DTK (Developer Toolkit, source code is
 available too) and play with it.  The .exe is a self-extracting rar
 archive and can be unpacked on linux using the unrar utility.  The
@@ -126,8 +122,9 @@ stuff).  The GUI tools are written in C#.  Trying to make them fly
 with mono didn't work for me though (mono version 1.2.3 as shipped
 with Fedora 7).
 
-enjoy,
-  Gerd
-
---
+.SH SEE ALSO
+amtterm(1), gamt(1)
+.P
+http://www.intel.com/technology/platform-technology/intel-amt/
+.SH WRITTEN BY
 Gerd Hoffmann <kraxel@redhat.com>
diff --git a/amtterm.man b/amtterm.man
new file mode 100644
index 0000000..7974a44
--- /dev/null
+++ b/amtterm.man
@@ -0,0 +1,43 @@
+.TH amtterm 1 "(c) 2007 Gerd Hoffmann"
+.SH NAME
+amtterm - Intel AMT serial-over-lan (sol) client.
+.SH SYNOPSIS
+.B amtterm [ options ] host [ port ]
+.SH DESCRIPTION
+.B amtterm
+provides access to the serial-over-lan port of Intel AMT managed
+machines.
+.B host
+is the hostname or IP address of the machine amtterm should connect
+to.
+.B port
+is the tcp port to use and defaults to 16994 (standard AMT redirection
+port) if unspecified.
+.P
+For more inforamtions on Intel AMT check amt-howto(7).
+.SH OPTIONS
+.TP
+.B -h
+Display help text.
+.TP
+.B -v
+Be verbose (default).
+.TP
+.B -q
+Be quiet.
+.TP
+.B -u <user>
+Specify username, defaults to "admin".
+.TP
+.B -p <pass>
+Specify password.
+.B amtterm
+will prompt on the terminal if unspecified.
+.SH ENVIRONMENT
+.TP
+.B AMT_PASSWORD
+Default value for the password.
+.SH SEE ALSO
+gamt(1), amt-howto(7)
+.SH AUTHOR
+(c) 2007 Gerd Hoffmann <kraxel@redhat.com>
diff --git a/gamt.c b/gamt.c
index d0de501..afa9843 100644
--- a/gamt.c
+++ b/gamt.c
@@ -128,12 +128,15 @@ static void menu_cb_config_font(GtkAction *action, void *data)
     fontname = cfg_get_str(CFG_FONT);
     gtk_font_selection_dialog_set_font_name
 	(GTK_FONT_SELECTION_DIALOG(dialog), fontname);
+
     gtk_widget_show_all(dialog);
-    if (GTK_RESPONSE_OK == gtk_dialog_run(GTK_DIALOG(dialog))) {
+    switch (gtk_dialog_run(GTK_DIALOG(dialog))) {
+    case GTK_RESPONSE_OK:
 	fontname = gtk_font_selection_dialog_get_font_name
 	    (GTK_FONT_SELECTION_DIALOG(dialog));
 	vte_terminal_set_font_from_string(VTE_TERMINAL(gamt->vte), fontname);
 	cfg_set_str(CFG_FONT, fontname);
+	break;
     }
     gtk_widget_destroy(dialog);
 }
@@ -150,7 +153,8 @@ static int pickcolor(char *title, GdkColor *color)
     gtk_color_selection_set_current_color(csel, color);
     
     gtk_widget_show_all(dialog);
-    if (GTK_RESPONSE_OK == gtk_dialog_run(GTK_DIALOG(dialog))) {
+    switch (gtk_dialog_run(GTK_DIALOG(dialog))) {
+    case GTK_RESPONSE_OK:
 	gtk_color_selection_get_current_color(csel, color);
 	rc = 0;
     }
diff --git a/gamt.man b/gamt.man
new file mode 100644
index 0000000..a5f21f3
--- /dev/null
+++ b/gamt.man
@@ -0,0 +1,48 @@
+.TH gamt 1 "(c) 2007 Gerd Hoffmann"
+.SH NAME
+gamt - Intel AMT serial-over-lan (sol) client.
+.SH SYNOPSIS
+.B gamt [ options ] [ host ]
+.SH DESCRIPTION
+.B gamt
+provides access to the serial-over-lan port of Intel AMT managed
+machines.
+.B host
+is the hostname or IP address of the machine gamt should connect
+to.
+.P
+For more inforamtions on Intel AMT check amt-howto(7).
+.SH OPTIONS
+.TP
+.B -h
+Display help text.
+.TP
+.B -u <user>
+Specify username, defaults to "admin".
+.TP
+.B -p <pass>
+Specify password.
+.B gamt
+will prompt you if unspecified.
+.TP
+.B -f <font>
+Specify terminal font, defaults to "monospace 12".
+.TP
+.B -c <color>
+Specify terminal text color, defaults to "gray".
+.TP
+.B -b <color>
+Specify terminal background color, defaults to "black".
+.P
+Font, colors can also be changed using menu options.  These settings
+are also written to the
+.B ~/.gamtrc
+config file, so they persistent.
+.SH ENVIRONMENT
+.TP
+.B AMT_PASSWORD
+Default value for the password.
+.SH SEE ALSO
+amtterm(1), amt-howto(7)
+.SH AUTHOR
+(c) 2007 Gerd Hoffmann <kraxel@redhat.com>