gnustep/tools-make
0
0
Fork 0
mirror of https://github.com/gnustep/tools-make.git synced 2025-04-23 22:33:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/tools/make/trunk@17472 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Adam Fedor 2003-08-13 03:45:58 +00:00
parent 8f6fec84e2
commit c4c66812d1
5 changed files with 262 additions and 153 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
2003-08-05 Martin Brecher <martin@mb-itconsulting.com>
* Documentation/openapp.1: New file.
* Documentation/GNUstep.7: Updated. File is now unprocessed.
2003-08-07 Richard Frith-Macdonald <rfm@gnu.org>
* Instance/Documentation/autogsdoc.make: Rewrite dependency rules

11
Documentation/GNUmakefile.in
View file

@ -107,6 +107,7 @@ ANNOUNCE_TEXT_MAIN = announce.texi
ANNOUNCE_DOC_INSTALL_DIR = Developer/Make/ReleaseNotes/$(GNUSTEP_MAKE_VERSION)
# Manual pages to install
MAN1_PAGES = openapp.1
MAN7_PAGES = GNUstep.7
include makerules.make
@ -125,6 +126,16 @@ after-install:: $(GNUSTEP_DOCUMENTATION)/Developer/Make/Manual
if [ ! -f $(GNUSTEP_DOCUMENTATION_MAN) ]; then \
$(MKDIRS) $(GNUSTEP_DOCUMENTATION_MAN); \
fi; \
if [ ! -f $(GNUSTEP_DOCUMENTATION_MAN)/man1 ]; then \
$(MKDIRS) $(GNUSTEP_DOCUMENTATION_MAN)/man1; \
fi; \
for file in $(MAN1_PAGES) __done; do \
if [ $$file != __done ]; then \
$(INSTALL_DATA) $$file $(GNUSTEP_DOCUMENTATION_MAN)/man1/$$file; \
which gzip && rm -f $(GNUSTEP_DOCUMENTATION_MAN)/man1/$$file.gz \
&& gzip -9 $(GNUSTEP_DOCUMENTATION_MAN)/man1/$$file; \
fi; \
done;
if [ ! -f $(GNUSTEP_DOCUMENTATION_MAN)/man7 ]; then \
$(MKDIRS) $(GNUSTEP_DOCUMENTATION_MAN)/man7; \
fi; \

292
Documentation/GNUstep.7
View file

@ -1,159 +1,147 @@
GNUSTEP(7) System Manuals GNUSTEP(7)
.\"GNUstep(7) man page
.\"put together by Martin Brecher <martin@gnustep.de>
.\"
.\"Process this file with
.\"groff -man -Tascii GNUstep.7
.\"
.TH GNUSTEP 7 "August 2003" GNUstep "GNUstep System Manual"
.SH NAME
GNUstep \- A free implementation of the OpenStep standard
.SH DESCRIPTION
GNUstep provides an Object-Oriented application development framework
and toolset for use on a wide variety of computer platforms.
GNUstep is based on the original OpenStep specification provided by
NeXT, Inc. (now Apple).
.P
GNUstep is written in Objective-C, an object-oriented superset of the C
programming language, similar to SmallTalk. However there exist a number
of brigdes and interfaces to develop GNUstep programs using other languages
like JAVA or Ruby.
.P
.B The GNUstep Core System
.P
The GNUstep core system consists of the following parts:
.IP gnustep-make
A set of scripts and makefiles that heavily ease the
creation and maintenance of software projects.
.IP gnustep-base
The FoundationKit libraries for non-GUI tools providing
everything from string
and array classes, filemanager classes to distributed objects.
.IP gnustep-gui
The ApplicationKit containing widgets, workspace classes and
means for
applications to interact with the user. This is the frontend of
GNUstep's GUI part.
.IP gnustep-back
This is the backend of GNUstep's GUI part which does the actual
rendering and event handling. It acts as a layer between
gnustep-gui and the operating/drawing system. Backends exist
for X11 (one using libart, one using xlib drawing) and win32.
Apart from the above, there exist a number of addon libraries, like Renaissance
which allows developers to specify an application's user interface in xml.
For database access, there is gdl2 - the GNUstep Database Library.
Please refer to the GNUstep website for more information.
GNUstep is self-containing. That means that all GNUstep applications, tools,
libraries and add-ons are installed into the GNUstep directory hierarchy.
There are four domains which are searched for files: the System domain, which
should only contain the core system files, the Local domain which stores all
that has later been installed on the system, the Network domain which should
be used for importing data from a remote system, and the User domain which resides in the user's home directory (mostly ~/GNUstep).
See the filesystem.texi document for more information.
NNAAMMEE
GNUstep - A free implementation of the OpenStep standard
.P
.B Some Basic Terms:
.P
.B Tools and Applications
.P
In the world of GNUstep the term
.I tool
refers to command line programs whereas
.I applications
are fully fledged GUI programs.
Naturally,
.I tools
reside in the domains' Tools folder,
.I applications
can be
found in the domains' Applications folder.
Applications are either launched using the openapp command or from the
Workspace.
DDEESSCCRRIIPPTTIIOONN
GNUstep provides an Object-Oriented application develop-
ment framework and tool set for use on a wide variety of
computer platforms. GNUstep is based on the original
OpenStep specification provided by NeXT, Inc. (now Apple).
.P
.B Services
.P
In GNUstep applications globally offer functionality to other applications
through
.I services
. They can be reached through the Services menu entry in an
application's main menu.
Apart from
.I services
offered by applications, there may
be programs whose sole purpose is the offering of services. They can be found
in the domains' Libary/Services folders.
GNUstep is written in Objective-C, a object-oriented
superset of the C programming language, similar to
SmallTalk. However there exist a number of brigdes and
interfaces to develop GNUstep programs using other lan-
guages like JAVA or Ruby.
.P
.B The Workspace
.P
The central place of the user interface is the
.I Workspace
or
.I Workspace Manager
which acts as an interface between the user and parts of the system like
files, processes, etc. The GWorkspace application provides this functionality
in GNUstep. See the GWorkspace website for more details.
TThhee GGNNUUsstteepp CCoorree SSyysstteemm
The GNUstep core system consists of the following parts:
gnustep-make
A set of scripts and makefiles that heavily
ease the creation and maintenance of software
projects.
gnustep-base
The FoundationKit libraries for non-GUI tools
providing everything from string and
array classes, filemanager classes to distributed
objects.
gnustep-gui
The AppKit containing widgets, workspace
classes and means for applications to interact
with the user. This is the frontend of
GNUstep's GUI part.
gnustep-back
This is the backend of GNUstep's GUI part
which does the actual rendering and event han-
dling. It acts as a layer between gnustep-gui
and the operating/drawing system. Backends exist
for X11 (one using libart, one using xlib
drawing) and win32.
Apart from the above, there exist a number of addon
libraries, like Renaissance which allows developers
to specify an application's user interface in xml.
For database access, there is gdl2 - the GNUstep
Database Library. Please refer to the GNUstep web-
site for more information.
GNUstep is self-containing. That means that all
GNUstep applications, tools, libraries and add-ons
are installed into the GNUstep directory hierarchy.
There are four domains which are searched for
files: the System domain, which should only contain
the core system files, the Local domain which
stores all that has later been installed on the
system, the Network domain which should be used for
importing data from a remote system, and the User
domain which resides in the user's home directory
(mostly ~/GNUstep). See the filesystem.texi docu-
ment for more information.
SSoommee BBaassiicc TTeerrmmss::
TToooollss aanndd AApppplliiccaattiioonnss
In the world of GNUstep the term _t_o_o_l refers to command
line programs whereas _A_p_p_l_i_c_a_t_i_o_n_s are fully fledged GUI
programs. Naturally, _t_o_o_l_s reside in the domains' Tools
folder, _A_p_p_l_i_c_a_t_i_o_n_s can be found in the domains' Applica-
tions folder.
Applications are either launched using the openapp command
or from the Workspace.
SSeerrvviicceess
In GNUstep, applications globally offer functionality to
other applications through _s_e_r_v_i_c_e_s applications main
menu. Apart from _s_e_r_v_i_c_e_s offered by applications, there
may be programs whose sole purpose is the offering of ser-
vices. They can be found in the domains' Libary/Services
folders.
TThhee WWoorrkkssppaaccee
The central place of the user interface is the _W_o_r_k_s_p_a_c_e
or _W_o_r_k_s_p_a_c_e _M_a_n_a_g_e_r which acts as an interface between
the user and parts of the system like files, processes,
etc. The GWorkspace application provides this functional-
ity in GNUstep. See the GWorkspace website for more
details.
GGeettttiinngg MMoorree HHeellpp
Most discussion and support is taking place on the GNUstep
mailinglists <http://www.gnustep.org/information/geth-
elp.html>. Additionally, most larger projects have their
own mailing lists. Consult the appropriate websites for
details.
Alternatively you are invited to join the #GNUstep IRC
channel on FreeNode (irc.freenode.net).
SSEEEE AALLSSOO
gcc(1), gdnc(1), gdomap(8), gpbs(1), make(1)
GGNNUUsstteepp WWeebbssiitteess::
Official GNUstep website <http://www.gnustep.org/> -
GNUstep Wiki (lots of useful information)
<http://wiki.gnustep.org/> - GNUstep Project Page
<http://savannah.gnu.org/projects/gnustep/> - GNUstep
Community Page <http://www.gnustep.net/> - GNUstep Build
Guide <http://documents.made-it.com/GNUstep/Build/>
Collaboration World <http://www.collaboration-world.com/>
- GNUstep.de <http://www.gnustep.de/> - GNUstep.it
<http://www.gnustep.it/> - GNUstep.us
<http://www.gnustep.us/> - GWorkspace Website
<http://www.gnustep.it/enrico/gworkspace/>
MMaaiilliinngglliissttss::
AAUUTTHHOORRSS
GNUstep is developed and maintained by a large number of
people. Please see <http://www.gnustep.org/develop-
ers/whoiswho.html> for a list.
GWorkspace is developed by Enrico Sersale. Please see the
GWorkspace Website for details.
This man page was written by Martin Brecher <martin@mb-
itconsulting.com>.
GNUstep June 2003 GNUSTEP(7)
.P
.P
.B Getting More Help
.P
Most discussion and support is taking place on the GNUstep mailinglists
<http://www.gnustep.org/information/gethelp.html>. Additionally, most larger
projects have their own mailing lists. Consult the appropriate websites for
details.
.P
Alternatively you are invited to join the #GNUstep IRC channel on
FreeNode (irc.freenode.net).
.P
.SH SEE ALSO
gcc(1), gdnc(1), gdomap(8), gopen(1), gpbs(1), make(1), openapp(1)
.PP
.B GNUstep Websites:
.PP
Official GNUstep website <http://www.gnustep.org/> -
GNUstep Wiki (lots of useful information) <http://wiki.gnustep.org/> -
GNUstep Project Page <http://savannah.gnu.org/projects/gnustep/> -
GNUstep Community Page <http://www.gnustep.net/> -
GNUstep Documentation Library <http://gnustep.made-it.com/> -
GNUstep Build Guide <http://gnustep.made-it.com/BuildGuide/>
.PP
Collaboration World <http://www.collaboration-world.com/> -
GNUstep.de <http://www.gnustep.de/> -
GNUstep.it <http://www.gnustep.it/> -
GNUstep.us <http://www.gnustep.us/> -
GWorkspace Website <http://www.gnustep.it/enrico/gworkspace/>
.PP
.B Mailinglists:
.PP
<http://www.gnu.org/software/gnustep/information/gethelp.html> -
Archives can be found at <http://mail.gnu.org/archive/html/>
.P
.SH AUTHORS
GNUstep is developed and maintained by a large number of people. Please
see <http://www.gnustep.org/developers/whoiswho.html> for a list.
.PP
GWorkspace is developed by Enrico Sersale. Please see the GWorkspace Website
for details.
.PP
This man page was written by Martin Brecher <martin@mb-itconsulting.com>.

2
Documentation/news.texi
View file

@ -9,7 +9,7 @@
The currently released version is @samp{@value{GNUSTEP-MAKE-VERSION}}.
@end ifclear
@section Changes in version @samp{1.7.1}
@section Changes in version @samp{1.7.2}
--enable-flattened (Flat directory structure) is on by default.

106
Documentation/openapp.1 Normal file
View file

@ -0,0 +1,106 @@
.\"openapp(1) man page
.\"put together by Martin Brecher <martin@gnustep.de>
.\"
.\"Process this file with
.\"groff -man -Tascii openpp.1
.\"
.TH OPENAPP 1 "August 2003" GNUstep "GNUstep System Manual"
.SH NAME
openapp \- launch applications from the command line
.SH SYNOPSIS
.B openapp
.RB [ --find ]
.IR application
.RB [ "\fIarguments..." ]
.P
.SH DESCRIPTION
The
.B openapp
command allows you launch graphical GNUstep applications from the command
line.a
.PP
.I application
is the complete or relative name of the application program with or
without the .app extension, like Ink.app.
.PP
.I arguments
are the arguments passed to the application.
.PP
.B openapp
first checks whether the application is in the current working directory.
If not then searches the GNUstep domains' Applications folders in the
following order:
User (i.e. ~/GNUstep/Applications), Local, Network, System. First match wins.
.PP
If
.I application
is given without extension (i.e. Ink instead of Ink.app),
.B openapp
searches for
.I application.app
,
.I application.debug
,
.I application.profile
(in that order).
.PP
If
.I --find
is used as first argument,
.B openapp
prints out
the full path of the application executable which would be
executed, without actually executing it as it would normally do.
.PP
.SH OPTIONS
.IP "\fB--find"
print complete path of the executable which would be launched.
.IP "\fB--help"
print above usage description.
.PP
.SH EXAMPLES
Start Ink.app without additional parameters:
.PP
.I openapp Ink.app
.PP
Launch Ink.app and pass it the --GNU-Debug argument:
.PP
.I openapp Ink.app --GNU-Debug=NSTextView
.PP
To determine which executable is launched by openapp, type:
.PP
.I openapp --find Ink.app
.PP
The output of the abovecommand might be something like:
.I /usr/GNUstep/Local/Applications/Ink.app/Ink
.PP
.SH BUGS
.B openapp
does currently not handle library combos.
.PP
.SH ENVIRONMENT
.IP "\fBGNUSTEP_PATHLIST"
This variable contains the paths of the domains in which
.B gopen
tries to find applications to open the files with. Entries are
separated by a colon.
.IP
.IP Example:
.I /home/foo/GNUstep:/usr/GNUstep/Local:/usr/GNUstep/Network:/usr/GNUstep/System
.PP
.SH SEE ALSO
GNUstep(7), gopen(1)
.P
.SH HISTORY
Work on
.B openapp
started October 1997.
.P
This manual page was first written July 2003.
.P
.SH AUTHORS
openapp was originally written by Ovidiu Predescu <ovidiu@net-community.com>
and is now maintained by Nicola Pero <n.pero@mi.flashnet.it>.
.P
This man page was written by Martin Brecher <martin@mb-itconsulting.com>.