Add man page

svn path=/trunk/mono/; revision=42605

diff --git a/man/Makefile.am b/man/Makefile.am
index 8d3101b4532403ee7b4a53fd56a5f0eb7b3b03c4..6ebc1603658a5ca5286d6f0c7225a0462c21e324 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,6 +1,6 @@
 man_MANS = mcs.1 mono.1 monostyle.1 mono-config.5 sqlsharp.1 oldmono.1 ilasm.1 \
           cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 makecert.1 \
           chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1 xsd.1 gacutil.1 \
-          macpack.1 mkbundle.1 dtd2xsd.1 permview.1 prj2make.1
+          macpack.1 mkbundle.1 dtd2xsd.1 permview.1 prj2make.1 mono-service.1
 
 EXTRA_DIST = $(man_MANS)

diff --git a/man/mono-service.1 b/man/mono-service.1
new file mode 100644 (file)
index 0000000..07abeab
--- /dev/null
+++ b/man/mono-service.1
@@ -0,0 +1,79 @@
+.\" 
+.\" mono-service manual page.
+.\" (C) 2005 Novell, Inc. 
+.\" Author:
+.\"   Miguel de Icaza (miguel@gnu.org)
+.\"
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.TH Mono "Mono 1.0"
+.SH NAME
+mono-service \- Mono ServiceProcess host
+.SH SYNOPSIS
+.PP
+.B mono-service [options] program.exe
+.SH DESCRIPTION
+The \fImono-service\fP is a host to run services built with the
+ServiceProcess assembly.
+.PP
+Services can be paused by sending the SIGUSR1 signal to the process,
+and execution can be resumed by sending the SIGUSR2 signal.   The
+service can be cleanly shutdown by sending the SIGTERM signal to the
+process. 
+.PP
+The following options can be used to control the service:
+.TP
+.I "-d:DIRECTORY"
+Use this option to specify the working directory for the service.  The
+default is the current directory. 
+.TP
+.I "-l:LOCKFILE"
+Specifies the file to use for locking, the default is a filename
+constructed in /tmp based on the name of the program that hosts the
+service. 
+.TP
+.I "-m:MESSAGE"
+Name to show in the syslog.
+.TP
+.I "-n:NAME"
+Use this to specify the service to be launched (if the program
+contains more than one service).   The default is to run the first
+defined service.
+.SH CONTROL
+You can control the service by sending signals to the process, you can
+use the following commands:
+.TP
+Pausing service:
+.nf
+       kill -USR1 `cat <lock file>`
+.fi
+.TP
+Resuming service:
+.nf
+       kill -USR2 `cat <lock file>`
+.fi
+.TP
+Stopping the service:
+.nf
+       kill `cat <lock file>`
+.fi
+.SH EXAMPLES
+Start the MyService.exe assembly, with a lock in /root/service-lock:
+.nf
+
+       mono-service -l:/root/service-lock MyService.exe
+
+.fi
+.SH DEBUGGING
+Messages produced by the service are logged on syslog.
+.SH MAILING LISTS
+Visit http://lists.ximian.com/mailman/listinfo/mono-list for details.
+.SH WEB SITE
+Visit: http://www.mono-project.com for details
+.SH SEE ALSO
+.BR mono(1)
+.PP
+.BR N:System.ServiceProcess
+

diff --git a/man/mono.1 b/man/mono.1
index 0401a7b5c3b7040347d516727126ad486ff468a4..c6f6e088857d145463885726fbff30ac30968429 100644 (file)
--- a/man/mono.1
+++ b/man/mono.1
@@ -1,6 +1,7 @@
 .\" 
 .\" mono manual page.
 .\" (C) 2003 Ximian, Inc. 
+.\" (C) 2004-2005 Novell, Inc. 
 .\" Author:
 .\"   Miguel de Icaza (miguel@gnu.org)
 .\"