Man-pages

[Dennis Leeuw]

Hi all,

I created a set of preliminary man-pages for the GNUstep tools. Comments 
suggestions and additions highly appreciated.

One little thing I noticed is that the set_show_service command does the 
enable and disable, but is doesn't do the show. Is this a bug or 
intentional?

Happy Stepping,

Dennis

.\"debugapp(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii debugapp.1
.\"
.TH DEBUGAPP 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
debugapp \- A wrapper for openapp. 
.SH SYNOPSIS
.B debugapp [--find] application [arguments...]
.P
.SH DESCRIPTION
.B debugapp
is a tool that helps you start or find applications by name in debugging mode. 
By default gdb, but this can be changed with the \fB--gdb=\fR argument.
.SH OPTIONS
.TP
\fB\--find\fR \fB<application>\fR
will print out the full path of the application 
executable which would be executed, without actually executing it.  It
will also list all paths that are attempted.

.TP
\fB\--library-combo=...\fR \fB<application>\fR
Starts the application with the specified library combo. This is a rarely used 
option.

.SH BUGS
None known

.P
.SH SEE ALSO
openapp(1), opentool(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B debugapp
started in October 2006.
.P
.SH AUTHORS
debugapp was written by Nicola Pero <n.pero@mi.flashnet.it>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"gclose(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii gclose.1
.\"
.TH GCLOSE 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
gclose \- This tool terminates an application
.SH SYNOPSIS
.B gclose <application>
.P
.SH DESCRIPTION
.B gclose
terminates an application from the command line
.SH OPTIONS
.SH BUGS
None known

.P
.SH SEE ALSO
gcloseall(1), gopen(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B gclose
started in November 2001.
.P
.SH AUTHORS
gclose was written by Gregory Casamento <greg_casamento@yahoo.com>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"gcloseall(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii closeall.1
.\"
.TH GCLOSEALL 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
gcloseall \- This tool terminates all applications 
.SH SYNOPSIS
.B gcloseall
.P
.SH DESCRIPTION
.B gcloseall
terminates all applications. It does this by not asking any questions. It just 
terminates all applications. You have been warned!
.SH OPTIONS
.SH BUGS
None known

.P
.SH SEE ALSO
gclose(1), gopen(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B gcloseall 
started in January 2006.
.P
.SH AUTHORS
gcloseall was written by Richard Frith-Macdoanld <rfm@gnu.org>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"gnustep-config(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii gnustep-config.1
.\"
.TH GNUSTEP-CONFIG 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
gnustep-config \- prints information on the current gnustep installation. 
.SH SYNOPSIS
.B gnustep-config [option]
.P
.SH DESCRIPTION
.B gnustep-config
can print information about the currently installed GNUstep system.
.SH OPTIONS

.TP
\fB\--variable=\fR <variable>
prints the value of the specified variable. Possible variables are:
.IP
GNUSTEP_MAKEFILES
.IP
GNUSTEP_USER_DIR
.IP
GNUSTEP_USER_DEFAULTS_DIR
.IP
GNUSTEP_HOST
.IP
GNUSTEP_HOST_CPU
.IP
GNUSTEP_HOST_VENDOR
.IP
GNUSTEP_HOST_OS
.IP
GNUSTEP_IS_FLATTENED
.IP
GNUSTEP_xxx_APPS
.IP
GNUSTEP_xxx_TOOLS
.IP
GNUSTEP_xxx_LIBRARY
.IP
GNUSTEP_xxx_HEADERS
.IP
GNUSTEP_xxx_LIBRARIES
.IP
GNUSTEP_xxx_DOC
.IP
GNUSTEP_xxx_DOC_MAN
.IP
GNUSTEP_xxx_DOC_INFO
.IP
where 'xxx' could be any of 'SYSTEM', 'NETWORK', 'LOCAL' and 'USER'.

.TP
\fB\--objc-flags\fR
prints all the flags required to compile an ObjC file

.TP
\fB\--objc-libs\fR
 prints all the flags required to link a pure ObjC program (no foundation/gui)

.TP
\fB\--base-libs\fR
prints all the flags required to link a command-line ObjC program (no gui)

.TP
\fB\--gui-libs\fR
prints all the flags required to link a GUI ObjC program

.SH BUGS
None known

.P
.SH SEE ALSO
GNUstep(7)
.P
.SH HISTORY
Work on
.B gnustep-config
started in 2007.
.P
.SH AUTHORS
gnustep-config was written by Nicola Pero <n.pero@mi.flashnet.it>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"gopen(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii open.1
.\"
.TH GOPEN 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
gopen \- opens the appropriate application from the command line based on what 
type of file is being accessed.
.SH SYNOPSIS
.B gopen <document>
.P
.SH DESCRIPTION
.B gopen
associates a document with an application and starts the application with the 
file.
.SH OPTIONS
.SH BUGS
None known

.P
.SH SEE ALSO
gclose(1), gcloseall(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B gopen
started in November 2001.
.P
.SH AUTHORS
gopen was written by Gregory Casamento <greg_casamento@yahoo.com>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"make_services(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii make_services.1
.\"
.TH MAKE_SERVICES 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
make_services \- builds a cache of service specifications
.SH SYNOPSIS
.B make_services [--test <filename>] [--verbose] [--quiet]
.P
.SH DESCRIPTION
.B make_services
builds a validated cache of service information for use by programs that want 
to use the OpenStep services facility. It is like the NeXTstep/ OPENSTEP 
'make_services' tool. In addition it builds a list of applications and 
services-bundles found in the standard directories and stores it in the users 
GNUstep directory.
.SH OPTIONS
.TP
\fB\--test\fR \fB\<filename>\fR
Makes sure that the property list in <filename> contains a valid services 
definition.

.TP
\fB\--verbose\fR
produce descriptive output.

.TP
\fB\--quiet\fR
suppress any output (not recommended)

.SH BUGS
None known

.P
.SH SEE ALSO
set_show_service(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B make_services
started in November 1998.
.P
.SH AUTHORS
make_services was written by Richard Frith-Macdonald <richard@brainstorm.co.uk>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"openapp(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii openapp.1
.\"
.TH OPENAPP 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
openapp \- Command line tool for starting applications 
.SH SYNOPSIS
.B openapp [--find] [--debug] application [arguments...]
.P
.SH DESCRIPTION
.B openapp
is a tool that helps you start or find applications by name.
.SH OPTIONS
.TP
\fB\--find\fR \fB<application>\fR
will print out the full path of the application 
executable which would be executed, without actually executing it.  It
will also list all paths that are attempted.

.TP
\fB\--debug\fR \fB<application>\fR
starts the application in the debugger. By default gdb, but this can be changed 
with the \fB--gdb=\fR argument.

.TP
\fB\--library-combo=...\fR \fB<application>\fR
Starts the application with the specified library combo. This is a rarely used 
option.

.SH BUGS
None known

.P
.SH SEE ALSO
opentool(1), debugapp(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B openapp 
started in October 1997.
.P
.SH AUTHORS
openapp was written by Ovidiu Predescu <ovidiu@net-community.com> and Nicola 
Pero <n.pero@mi.flashnet.it>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"opentool(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii opentool.1
.\"
.TH OPENTOOL 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
opentool \- Command line tool for starting tools 
.SH SYNOPSIS
.B opentool [--library-combo=...] tool [arguments...]
.P
.SH DESCRIPTION
.B opentool
is a tool that helps you start other tools by name.
.SH OPTIONS
.TP
\fB\--library-combo=...\fR \fB<application>\fR
Starts the application with the specified library combo. This is a rarely used 
option.

.SH BUGS
None known

.P
.SH SEE ALSO
openapp(1), debugapp(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B opentool 
started in 1997.
.P
.SH AUTHORS
opentool was written by Scott Predescu <ovidiu@net-community.com>, Ovidiu 
Predescu <ovidiu@net-community.com> and Nicola Pero <n.pero@mi.flashnet.it>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.

.\"set_show_service(1) man page
.\"put together by Dennis Leeuw <dleeuw@made-it.com>
.\"Copyright (C) 2003 Free Software Foundation, Inc.
.\"
.\"Process this file with
.\"groff -man -Tascii set_show_service.1
.\"
.TH SET_SHOW_SERVICE 1 "December 2007" GNUstep "GNUstep System Manual"
.SH NAME
set_show_service \- enable or disable a service for the current user
.SH SYNOPSIS
.B set_show_service [--enable <service>] [--disable <service>]
.P
.SH DESCRIPTION
.B set_show_service
enables or disables the display of a specified service item.
.SH OPTIONS
.TP
\fB\--enable\fR \fB\<service>\fR
enable the given service for the user running this command.

.TP
\fB\--disable\fR
disables the given service for the user running this command.

.SH BUGS
None known

.P
.SH SEE ALSO
make_services(1), GNUstep(7)
.P
.SH HISTORY
Work on
.B set_show_service
started in November 1998.
.P
.SH AUTHORS
set_show_service was written by Richard Frith-Macdonald 
<richard@brainstorm.co.uk>
.P
This man page was written by Dennis Leeuw <dleeuw@made-it.com>.