~ubuntu-branches/ubuntu/maverick/hello/maverick

« back to all changes in this revision

Viewing changes to doc/hello.texi

  • Committer: Bazaar Package Importer
  • Author(s): Santiago Vila
  • Date: 2004-01-05 16:42:30 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040105164230-ze0yqbimyx4sx1gs
Tags: 2.1.1-4
Updated config.guess and config.sub for GNU/K*BSD.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\input texinfo @c -*-texinfo-*-
 
2
@c %**start of header
 
3
@setfilename hello.info
 
4
@settitle Printing a Greeting
 
5
@finalout
 
6
@setchapternewpage odd
 
7
@c %**end of header
 
8
 
 
9
@include version.texi
 
10
 
 
11
@copying
 
12
This file documents the GNU @code{hello} command for printing a
 
13
greeting message.
 
14
 
 
15
Copyright (C) 1992, 1993, 1996, 2002 Free Software Foundation, Inc.
 
16
 
 
17
Permission is granted to make and distribute verbatim copies of
 
18
this manual provided the copyright notice and this permission notice
 
19
are preserved on all copies.
 
20
 
 
21
@ignore
 
22
Permission is granted to process this file through TeX and print the
 
23
results, provided the printed document carries copying permission
 
24
notice identical to this one except for the removal of this paragraph
 
25
(this paragraph not being relevant to the printed manual).
 
26
@end ignore
 
27
 
 
28
Permission is granted to copy and distribute modified versions of this
 
29
manual under the conditions for verbatim copying, provided that the entire
 
30
resulting derived work is distributed under the terms of a permission
 
31
notice identical to this one.
 
32
 
 
33
Permission is granted to copy and distribute translations of this manual
 
34
into another language, under the above conditions for modified versions,
 
35
except that this permission notice may be stated in a translation approved
 
36
by the Foundation.
 
37
@end copying
 
38
 
 
39
@ifinfo
 
40
 
 
41
@dircategory Greeting Printing Program
 
42
@dircategory Mail Reader
 
43
@dircategory Programming
 
44
 
 
45
@direntry
 
46
* Hello, world!: (hello).       GNU `Hello, world'.
 
47
@end direntry
 
48
 
 
49
@c old settings:
 
50
@c INFO-DIR-CATEGORY Greeting Program
 
51
@c INFO-DIR-CATEGORY Mail Reader
 
52
@c INFO-DIR-CATEGORY Programming
 
53
@c 
 
54
@c START-INFO-DIR-ENTRY
 
55
@c * Hello, world!: (hello).       GNU `Hello, world'.
 
56
@c END-INFO-DIR-ENTRY
 
57
@end ifinfo
 
58
 
 
59
 
 
60
@titlepage
 
61
@title GNU Hello
 
62
@subtitle The Greeting Printing Program
 
63
@subtitle Edition @value{EDITION}, for Hello Version @value{VERSION}
 
64
@subtitle @value{UPDATED}
 
65
@author by David MacKenzie and the GNU Hello Development Team
 
66
 
 
67
@page
 
68
@vskip 0pt plus 1filll
 
69
@insertcopying
 
70
 
 
71
@end titlepage
 
72
 
 
73
@node Top, , , (dir)
 
74
 
 
75
@ifinfo
 
76
This file documents the the GNU @code{hello} command to print a
 
77
greeting message.
 
78
@end ifinfo
 
79
 
 
80
@menu
 
81
* Instructions::        How to read this manual. 
 
82
* Copying::             How you can copy and share @code{hello}.
 
83
* Overview::            Preliminary information.
 
84
* Sample::              Sample output from @code{hello}.
 
85
* Invoking hello::      How to run @code{hello}.
 
86
* Problems::            Reporting bugs.
 
87
* Concept Index::       Index of concepts.
 
88
@end menu
 
89
 
 
90
@node Instructions, Copying, , Top
 
91
@chapter How to Read This Manual
 
92
 
 
93
@cindex reading
 
94
@cindex manual, how to read
 
95
@cindex how to read
 
96
To read this manual, begin at the beginning, reading from left to right
 
97
and top to bottom, until you get to the end.  Then stop.  You may pause
 
98
for a beer anywhere in the middle as well, if you wish.  (Please note,
 
99
however, that The King strongly advises against heavy use of
 
100
prescription pharmaceuticals, based on his extensive personal and
 
101
professional experience.)
 
102
 
 
103
@node Copying, Overview, Instructions, Top
 
104
@include gpl.texi
 
105
 
 
106
@node Overview, Sample, Copying, Top
 
107
@chapter Overview
 
108
@cindex greetings
 
109
@cindex overview
 
110
 
 
111
The GNU @code{hello} program produces a familiar, friendly greeting.
 
112
It allows nonprogrammers to use a classic computer science tool which
 
113
would otherwise be unavailable to them.  Because it is protected by the
 
114
GNU General Public License, users are free to share and change it.
 
115
 
 
116
GNU @code{hello} was written by Mike Haertel, David MacKenzie, Jan
 
117
Brittenson, Charles Hannum, Roland McGrath, Noah Friedman, Karl
 
118
Eichwalder, and @w{The King}.
 
119
 
 
120
@node Sample, Invoking hello, Overview, Top
 
121
@chapter Sample Output
 
122
@cindex sample
 
123
 
 
124
Here are some realistic examples of running GNU @code{hello}.
 
125
 
 
126
This is the output of the command @samp{hello}:
 
127
 
 
128
@example
 
129
Hello, world!
 
130
@end example
 
131
 
 
132
This is the output of the command @samp{hello --help}:
 
133
 
 
134
@example
 
135
This is GNU Hello, THE greeting printing program.
 
136
Usage: hello [OPTION]
 
137
  -h, --help          display this help and exit
 
138
  -v, --version       display version information and exit
 
139
  -t, --traditional   use traditional greeting format
 
140
  -m, --mail          print your mail
 
141
 
 
142
Report bugs to bug-gnu-hello@@gnu.org.
 
143
@end example
 
144
 
 
145
This is the output of the command @samp{hello --traditional}:
 
146
 
 
147
@example
 
148
hello, world
 
149
@end example
 
150
 
 
151
@node Invoking hello, Problems, Sample, Top
 
152
@chapter Invoking @code{hello}
 
153
@cindex invoking
 
154
@cindex version
 
155
@cindex options
 
156
@cindex usage
 
157
@cindex help
 
158
@cindex getting help
 
159
 
 
160
The format for running the @code{hello} program is:
 
161
 
 
162
@example
 
163
hello @var{option} @dots{}
 
164
@end example
 
165
 
 
166
@code{hello} supports the following options:
 
167
 
 
168
@table @samp
 
169
@item --help
 
170
@itemx -h
 
171
Print an informative help message describing the options and then exit.
 
172
 
 
173
@item --version
 
174
@itemx -v
 
175
Print the version number of @code{hello} on the standard error output
 
176
and then exit.
 
177
 
 
178
@item --traditional
 
179
@itemx -t
 
180
@cindex traditional
 
181
@cindex modern
 
182
Use the traditional greeting message @samp{hello, world} rather 
 
183
than the more modern @samp{Hello, world!}.
 
184
 
 
185
@item --mail
 
186
@itemx -m
 
187
@cindex mail
 
188
@cindex creeping feature
 
189
@cindex feature, creeping
 
190
@cindex feeping creature
 
191
@cindex creature, feeping
 
192
Print your mail on the standard output.
 
193
@end table
 
194
 
 
195
@node Problems, Concept Index, Invoking hello, Top
 
196
@chapter Reporting Bugs
 
197
@cindex bugs
 
198
@cindex problems
 
199
 
 
200
If you find a bug in GNU @code{hello}, please send electronic mail
 
201
to @email{bug-gnu-hello@@gnu.org}.  Include the version
 
202
number, which you can find by running @w{@samp{hello --version}}.  Also
 
203
include in your message the output that the program produced and the
 
204
output you expected.@refill
 
205
 
 
206
If you have other questions, comments or suggestions about GNU
 
207
@code{hello}, contact @w{The King} via electronic mail to
 
208
@email{elvis@@graceland.gnu.ai.mit.edu}.  @w{The King} will try to help
 
209
you out, although he may not have time to fix your problems.
 
210
 
 
211
@node Concept Index, , Problems, Top
 
212
@unnumbered Concept Index
 
213
 
 
214
@cindex tail recursion
 
215
@printindex cp
 
216
 
 
217
@shortcontents
 
218
@contents
 
219
@bye
 
220
 
 
221
@c hello.texi ends here