1This is sharutils.info, produced by makeinfo version 4.13 from
2sharutils.texi.
3
4INFO-DIR-SECTION Archiving
5START-INFO-DIR-ENTRY
6* Shar utilities: (sharutils).  Shell archiver, uuencode/uudecode.
7END-INFO-DIR-ENTRY
8INFO-DIR-SECTION Individual utilities
9START-INFO-DIR-ENTRY
10* shar: (sharutils)shar Invocation.             Make a shell archive.
11* unshar: (sharutils)unshar Invocation.         Explode a shell archive.
12* uudecode: (sharutils)uudecode Invocation.     Restore file from 7-bits.
13* uuencode: (sharutils)uuencode Invocation.     Force binary file to 7-bits.
14END-INFO-DIR-ENTRY
15
16   This manual documents version 4.15.2 of the GNU shar utilities.
17
18   Copyright (C) 1994-2015 Free Software Foundation, Inc.
19
20     Permission is granted to copy, distribute and/or modify this
21     document under the terms of the GNU Free Documentation License,
22     Version 1.3 or any later version published by the Free Software
23     Foundation; with no Invariant Sections, with no Front-Cover Texts,
24     and with no Back-Cover Texts.  A copy of the license is included
25     in the section entitled "GNU Free Documentation License".
26
27
28File: sharutils.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)
29
30GNU `shar' utilities
31********************
32
33   GNU `shar' makes so-called shell archives out of many files,
34preparing them for transmission by electronic mail services, while
35`unshar' helps unpacking shell archives after reception.  Other tools
36help using `shar' with the electronic mail system, and even allow
37synchronization of remote directory trees.  This is release 4.15.2.
38
39* Menu:
40
41* Introduction::                Introduction to this toolset
42* Basic::                       The basic `shar' utilities
43* GNU Free Documentation License:: GNU Free Documentation License
44
45 --- The Detailed Node Listing ---
46
47The basic `shar' utilities
48
49* shar Invocation::             Invoking the `shar' program
50* unshar Invocation::           Invoking the `unshar' program
51* uuencode Invocation::         Invoking the `uuencode' program
52* uudecode Invocation::         Invoking the `uudecode' program
53
54
55File: sharutils.info,  Node: Introduction,  Next: Basic,  Prev: Top,  Up: Top
56
571 Introduction to this toolset
58******************************
59
60GNU `uuencode' and `uudecode' have an history which roots are lost in
61ages, and we will not even try to trace it.  The current versions were
62brought into GNU by Ian Lance Taylor, and later modernized by Ulrich
63Drepper.  GNU `shar' surely has a long history, too.  All along this
64long road, numerous users contributed various improvements.  The file
65`THANKS' in the distribution, as far as we know, contain the names of
66all contributors we could identify, and for which email addresses are
67seemingly valid.
68
69   Please help us getting the history straight, for the following
70information is somewhat approximative.  James Gosling wrote the public
71domain `shar 1.x'.  William Davidsen rewrote it as `shar 2.x'.  Warren
72Tucker implemented modifications and called it `shar 3.x'.  Richard
73Gumpertz maintained it until 1990.  Franc,ois Pinard, from the public
74domain `shar 3.49', made `GNU shar 4.x', in 1994.  Some modules and
75other code sections were freely borrowed from other GNU distributions,
76bringing this `shar' under the terms of the GNU General Public License.
77
78   Your feedback helps us to make a better and more portable product.
79Mail suggestions and bug reports (including documentation errors) for
80these programs to `bug-gnu-utils@prep.ai.mit.edu'.
81
82
83File: sharutils.info,  Node: Basic,  Next: GNU Free Documentation License,  Prev: Introduction,  Up: Top
84
852 The basic `shar' utilities
86****************************
87
88GNU `shar' makes so-called shell archives out of many files, preparing
89them for transmission by electronic mail services.  A "shell archive"
90is a collection of files that can be unpacked by `/bin/sh'.  A wide
91range of features provide extensive flexibility in manufacturing shars
92and in specifying shar _smartness_.  For example, `shar' may compress
93files, uuencode binary files, split long files and construct multi-part
94mailings, ensure correct unsharing order, and provide simplistic
95checksums.  *Note shar Invocation::.
96
97   GNU `unshar' scans a set of mail messages looking for the start of
98shell archives.  It will automatically strip off the mail headers and
99other introductory text.  The archive bodies are then unpacked by a
100copy of the shell.  `unshar' may also process files containing
101concatenated shell archives.  *Note unshar Invocation::.
102
103* Menu:
104
105* shar Invocation::             Invoking the `shar' program
106* unshar Invocation::           Invoking the `unshar' program
107* uuencode Invocation::         Invoking the `uuencode' program
108* uudecode Invocation::         Invoking the `uudecode' program
109
110
111File: sharutils.info,  Node: shar Invocation,  Next: unshar Invocation,  Up: Basic
112
1132.1 Invoking shar
114=================
115
116If no `file's are specified, the list of input files is read from
117standard input.  Standard input must not be a terminal.  `shar' creates
118"shell archives" (or shar files) which are in text format and can be
119emailed.  These files may be unpacked later by executing them with
120`/bin/sh'.  The resulting archive is sent to standard out unless the
121`-o' option is given.  A wide range of features provide extensive
122flexibility in manufacturing shars and in specifying `shar'
123"smartness".  Archives may be fairly simple (`--vanilla-operation') or
124essentially a mailable `tar' archive.
125
126   Options may be specified in any order until a `file' argument is
127recognized.  If the `--intermix-type' option has been specified, more
128compression and encoding options will be recognized between the `file'
129arguments.
130
131   Though this program supports `uuencode'-d files, they are
132deprecated.  If you are emailing files, please consider mime-encoded
133files.  If you do `uuencode', base64 is the preferred encoding method.
134
135   This section was generated by *AutoGen*, using the `agtexi-cmd'
136template and the option descriptions for the `shar' program.  This
137software is released under the GNU General Public License, version 3 or
138later.
139
140* Menu:
141
142* shar usage::                  shar help/usage (`--help')
143* shar compression::            compression options
144* shar encoding::               encoding options
145* shar in-out::                 in-out options
146* shar headers::                headers options
147* shar xmit-defenses::          xmit-defenses options
148* shar shar-flavors::           shar-flavors options
149* shar internationalization::   internationalization options
150* shar feedback::               feedback options
151* shar config::                 presetting/configuring shar
152* shar exit status::            exit status
153* shar Authors::                Authors
154* shar Bugs::                   Bugs
155* shar Examples::               Examples
156* shar Warnings::               Warnings
157* shar See Also::               See Also
158
159
160File: sharutils.info,  Node: shar usage,  Next: shar compression,  Up: shar Invocation
161
1622.1.1 shar help/usage (`--help')
163--------------------------------
164
165This is the automatically generated usage text for shar.
166
167   The text printed is the same whether selected with the `help' option
168(`--help') or the `more-help' option (`--more-help').  `more-help' will
169print the usage text by passing it through a pager program.
170`more-help' is disabled on platforms without a working `fork(2)'
171function.  The `PAGER' environment variable is used to select the
172program, defaulting to `more'.  Both will exit with a status code of 0.
173
174shar (GNU sharutils) - create a shell archive
175Usage:  shar [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [<file>...]
176
177Specify compression:
178   -p, --intermix-type        specify compression for input files
179                                - prohibits the option 'vanilla-operation'
180   -C, --compactor=PROG       specify compaction (compression) program PROG
181                                - prohibits the option 'vanilla-operation'
182                                - may appear multiple times
183                                - it must be known to shar: xz gzip bzip2
184   -g, --level-of-compression=LEVEL
185                              pass LEVEL for compression
186                                - it must be in the range: 1 to 9
187
188Specify file encoding methodology:
189   -M, --mixed-uuencode       decide uuencoding for each file
190   -B, --uuencode             treat all files as binary
191                                - an alternate for mixed-uuencode
192   -T, --text-files           treat all files as text
193                                - an alternate for mixed-uuencode
194
195Specifying file selection and output modes:
196   -o, --output-prefix=str    print output to file PREFIX.nn
197   -l, --whole-size-limit=SIZE
198                              split archive, not files, to SIZE
199                                - requires the option 'output-prefix'
200                                - is scalable with a suffix: k/K/m/M/g/G/t/T
201                                - it must lie in one of the ranges:
202                                  8 to 1023, or 8192 to 4194304
203   -L, --split-size-limit=SIZE
204                              split archive or files to SIZE
205                                - requires the option 'output-prefix'
206                                - is scalable with a suffix: k/K/m/M/g/G/t/T
207                                - it must lie in one of the ranges:
208                                  8 to 1023, or 8192 to 4194304
209                                - an alternate for 'whole-size-limit'
210   -I, --input-file-list=FILE read file list from FILE
211
212Controlling the shar headers:
213   -n, --archive-name=NAME    use NAME to document the archive
214   -s, --submitter=NAME       override the submitter name with NAME
215   -a, --net-headers          output Submitted-by: & Archive-name: headers
216                                - requires the option 'archive-name'
217   -c, --cut-mark             start the shar with a cut line
218   -t, --translate            translate messages in the script
219
220Protecting against transmission issues:
221       --no-character-count   do not use `wc -c' to check size
222   -D, --no-md5-digest        do not use md5sum digest to verify
223   -F, --force-prefix         apply the prefix character on every line
224   -d, --here-delimiter=DELIM use DELIM to delimit the files
225
226Producing different kinds of shars:
227   -V, --vanilla-operation    produce very simple shars
228   -P, --no-piping            use temporary files between programs
229   -x, --no-check-existing    blindly overwrite existing files
230   -X, --query-user           ask user before overwriting files
231                                - prohibits the option 'vanilla-operation'
232   -m, --no-timestamp         do not restore modification times
233   -Q, --quiet-unshar         avoid verbose messages at unshar time
234   -f, --basename             restore in one directory, despite hierarchy
235
236Internationalization options:
237       --no-i18n              do not internationalize
238       --print-text-domain-dir  print directory with shar messages
239
240User feedback/entertainment:
241   -q, --quiet                do not output verbose messages
242       --silent               an alias for the 'quiet' option
243
244Version, usage and configuration options:
245   -v, --version[=MODE]       output version information and exit
246   -h, --help                 display extended usage information and exit
247   -!, --more-help            extended usage information passed thru pager
248   -R, --save-opts[=FILE]     save the option state to a config file FILE
249   -r, --load-opts=FILE       load options from the config file FILE
250                                - disabled with '--no-load-opts'
251                                - may appear multiple times
252
253Options are specified by doubled hyphens and their name or by a single
254hyphen and the flag character.
255If no 'file's are specified, the list of input files is read from a
256standard input.  Standard input must not be a terminal.
257
258The following option preset mechanisms are supported:
259 - reading file $HOME/.sharrc
260
261'shar' creates "shell archives" (or shar files) which are in text format
262and can be emailed.  These files may be unpacked later by executing them
263with '/bin/sh'.  The resulting archive is sent to standard out unless the
264'-o' option is given.  A wide range of features provide extensive
265flexibility in manufacturing shars and in specifying 'shar' "smartness".
266Archives may be fairly simple ('--vanilla-operation') or essentially a
267mailable 'tar' archive.
268
269Options may be specified in any order until a 'file' argument is
270recognized.  If the '--intermix-type' option has been specified, more
271compression and encoding options will be recognized between the 'file'
272arguments.
273
274Though this program supports 'uuencode'-d files, they are deprecated.  If
275you are emailing files, please consider mime-encoded files.  If you do
276'uuencode', base64 is the preferred encoding method.
277
278Please send bug reports to:  <bug-gnu-utils@gnu.org>
279
280
281File: sharutils.info,  Node: shar compression,  Next: shar encoding,  Prev: shar usage,  Up: shar Invocation
282
2832.1.2 compression options
284-------------------------
285
286Specifying compression.
287
288intermix-type option (-p).
289..........................
290
291This is the "specify compression for input files" option.
292
293This option has some usage constraints.  It:
294   * must not appear in combination with any of the following options:
295     vanilla-operation.
296
297   Allow positional parameter options.  The compression method and
298encoding method options may be intermixed with file names.  Files named
299after these options will be processed in the specified way.
300
301compactor option (-C).
302......................
303
304This is the "specify compaction (compression) program" option.  This
305option takes a string argument `PROGRAM'.
306
307This option has some usage constraints.  It:
308   * may appear an unlimited number of times.
309
310   * must not appear in combination with any of the following options:
311     vanilla-operation.
312
313   The `gzip', `bzip2' and `compress' compactor commands may be
314specified by the program name as the option name, e.g. `--gzip'.  Those
315options, however, are being deprecated.  There is also the `xz'
316compactor now.  Specify `xz' with `-C xz' or `--compactor=xz'.
317
318   Specifying the compactor "`none'" will disable file compression.
319Compressed files are never processed as plain text.  They are always
320uuencoded and the recipient must have `uudecode' to unpack them.
321
322   Specifying the compactor `compress' is deprecated.
323
324level-of-compression option (-g).
325.................................
326
327This is the "pass `level' for compression" option.  This option takes a
328number argument `LEVEL'.  Some compression programs allow for a level
329of compression.  The default is `9', but this option allows you to
330specify something else.  This value is used by `gzip', `bzip2' and
331`xz', but not `compress'.
332
333bzip2 option (-j).
334..................
335
336This is the "`bzip2' and `uuencode' files" option.
337
338This option has some usage constraints.  It:
339   * may appear an unlimited number of times.
340
341   `bzip2' compress and `uuencode' all files prior to packing.  The
342recipient must have `uudecode' `bzip2' in order to unpack.
343
344   *NOTE**: THIS OPTION IS DEPRECATED*
345
346gzip option (-z).
347.................
348
349This is the "`gzip' and `uuencode' files" option.
350
351This option has some usage constraints.  It:
352   * may appear an unlimited number of times.
353
354   `gzip' compress and `uuencode' all files prior to packing.  The
355recipient must have `uudecode' and `gzip' in order to unpack.
356
357   *NOTE**: THIS OPTION IS DEPRECATED*
358
359compress option (-Z).
360.....................
361
362This is the "`compress' and `uuencode' files" option.
363
364This option has some usage constraints.  It:
365   * may appear an unlimited number of times.
366
367   * must be compiled in by defining `HAVE_COMPRESS' during the
368     compilation.
369
370   `compress' and `uuencode' all files prior to packing.  The recipient
371must have `uudecode' and `compress' in order to unpack.
372
373   *NOTE**: THIS OPTION IS DEPRECATED*
374
375level-for-gzip option.
376......................
377
378This is an alias for the `level-of-compression' option, *note the
379level-of-compression option documentation: shar level-of-compression.
380
381bits-per-code option (-b).
382..........................
383
384This is the "pass `bits' (default 12) to compress" option.  This option
385takes a string argument `BITS'.
386
387This option has some usage constraints.  It:
388   * must be compiled in by defining `HAVE_COMPRESS' during the
389     compilation.
390
391   This is the compression factor used by the `compress' program.
392
393   *NOTE**: THIS OPTION IS DEPRECATED*
394
395
396File: sharutils.info,  Node: shar encoding,  Next: shar in-out,  Prev: shar compression,  Up: shar Invocation
397
3982.1.3 encoding options
399----------------------
400
401Specifying file encoding methodology.  Files may be stored in the shar
402either as plain text or uuencoded.  By default, the program selects
403which by examining the file.  You may force the selection for all
404files.  In intermixed option/file mode, this setting may be changed
405during processing.
406
407mixed-uuencode option (-M).
408...........................
409
410This is the "decide uuencoding for each file" option.
411
412This option has some usage constraints.  It:
413   * is a member of the mixed-uuencode class of options.
414
415   Automatically determine if the files are text or binary and archive
416correctly.  Files found to be binary are uuencoded prior to packing.
417This is the default behavior for `shar'.
418
419   For a file to be considered a text file instead of a binary file,
420all the following should be true:
421  1. The file does not contain any ASCII control character besides <BS>
422     (backspace), <HT> (horizontal tab), <LF> (new line) or <FF> (form
423     feed).
424
425  2. The file contains no character with its eighth-bit set.
426
427  3. The file contains no line beginning with the five letters "`from
428     '", capitalized or not.  (Mail handling programs will often
429     gratuitously insert a `>' character before it.)
430
431  4. The file is either empty or ends with a <LF> (newline) byte.
432
433  5. No line in the file contains more than 200 characters.  For
434     counting purpose, lines are separated by a <LF> (newline).
435
436uuencode option (-B).
437.....................
438
439This is the "treat all files as binary" option.
440
441This option has some usage constraints.  It:
442   * is a member of the mixed-uuencode class of options.
443
444   Use `uuencode' prior to packing all files.  This increases the size
445of the archive.  The recipient must have `uudecode' in order to unpack.
446Compressed files are always encoded.
447
448text-files option (-T).
449.......................
450
451This is the "treat all files as text" option.
452
453This option has some usage constraints.  It:
454   * is a member of the mixed-uuencode class of options.
455
456   If you have files with non-ascii bytes or text that some mail
457handling programs do not like, you may find difficulties.  However, if
458you are using FTP or SSH/SCP, the non-conforming text files should be
459okay.
460
461
462File: sharutils.info,  Node: shar in-out,  Next: shar headers,  Prev: shar encoding,  Up: shar Invocation
463
4642.1.4 in-out options
465--------------------
466
467Specifying file selection and output modes.
468
469output-prefix option (-o).
470..........................
471
472This is the "print output to file prefix.nn" option.  This option takes
473a string argument `PREFIX'.  Save the archive to files `prefix.01' thru
474`prefix.nn' instead of sending all output to standard out.  Must be
475specified when the `--whole-size-limit' or `--split-size-limit' options
476are specified.
477
478   When PREFIX contains a `%' character, PREFIX is then interpreted as
479a `sprintf' format, which should be able to display a single decimal
480number.  When PREFIX does not contain such a `%' character, the string
481`.%02d' is internally appended.
482
483whole-size-limit option (-l).
484.............................
485
486This is the "split archive, not files, to size" option.  This option
487takes a number argument `SIZE'.
488
489This option has some usage constraints.  It:
490   * is a member of the whole-size-limit class of options.
491
492   * must appear in combination with the following options:
493     output-prefix.
494
495   Limit the output file size to `size' bytes, but don't split input
496files.  If `size' is less than 1024, then it will be multiplied by
4971024.  The value may also be specified with a k, K, m or M suffix.  The
498number is then multiplied by 1000, 1024, 1000000, or 1048576,
499respectively.  4M (4194304) is the maximum allowed.
500
501   Unlike the `split-size-limit' option, this allows the recipient of
502the shar files to unpack them in any order.
503
504split-size-limit option (-L).
505.............................
506
507This is the "split archive or files to size" option.  This option takes
508a number argument `SIZE'.
509
510This option has some usage constraints.  It:
511   * is a member of the whole-size-limit class of options.
512
513   * must appear in combination with the following options:
514     output-prefix.
515
516   Limit output file size to `size' bytes, splitting files if
517necessary.  The allowed values are specified as with the
518`--whole-size-limit' option.
519
520   The archive parts created with this option must be unpacked in the
521correct order.  If the recipient of the shell archives wants to put all
522of them in a single email folder (file), they will have to be saved in
523the correct order for `unshar' to unpack them all at once (using one of
524the split archive options).  *Note unshar Invocation::.
525
526input-file-list option (-I).
527............................
528
529This is the "read file list from a file" option.  This option takes a
530string argument `FILE'.  This option causes `file' to be reopened as
531standard input.  If no files are found on the input line, then standard
532input is read for input file names.  Use of this option will prohibit
533input files from being listed on the command line.
534
535   Input must be in a form similar to that generated by `find', one
536filename per line.  This switch is especially useful when the command
537line will not hold the list of files to be archived.
538
539   If the `--intermix-type' option is specified on the command line,
540then the compression options may be included in the standard input on
541lines by themselves and no file name may begin with a hyphen.
542
543   For example:
544    { echo --compact xz
545       find . -type f -print | sort
546    } | shar -S -p -L50K -o /somewhere/big
547
548stdin-file-list option (-S).
549............................
550
551This is the "read file list from standard input" option.  This option
552is actually a no-op.  It is a wrapper for `--input-file-list=-'.
553
554   *NOTE**: THIS OPTION IS DEPRECATED*
555
556
557File: sharutils.info,  Node: shar headers,  Next: shar xmit-defenses,  Prev: shar in-out,  Up: shar Invocation
558
5592.1.5 headers options
560---------------------
561
562Controlling the shar headers.
563
564archive-name option (-n).
565.........................
566
567This is the "use `name' to document the archive" option.  This option
568takes a string argument `NAME'.  Name of archive to be included in the
569subject header of the shar files.  See the `--net-headers' option.
570
571submitter option (-s).
572......................
573
574This is the "override the submitter name" option.  This option takes a
575string argument `WHO@WHERE'.  `shar' will normally determine the
576submitter name by querying the system.  Use this option if it is being
577done on behalf of another.
578
579net-headers option (-a).
580........................
581
582This is the "output submitted-by: & archive-name: headers" option.
583
584This option has some usage constraints.  It:
585   * must appear in combination with the following options:
586     archive-name.
587
588   Adds specialized email headers:
589    Submitted-by: who@where
590    Archive-name: name/part##
591   The who@where is normally derived, but can be specified with the
592`--submitter' option.  The name must be provided with the
593`--archive-name' option.  If the archive name includes a slash (`/')
594character, then the `/part##' is omitted.  Thus `-n xyzzy' produces:
595    xyzzy/part01
596    xyzzy/part02
597
598while `-n xyzzy/patch' produces:
599    xyzzy/patch01
600    xyzzy/patch02
601
602and `-n xyzzy/patch01.' produces:
603    xyzzy/patch01.01
604    xyzzy/patch01.02
605
606cut-mark option (-c).
607.....................
608
609This is the "start the shar with a cut line" option.  A line saying
610'Cut here' is placed at the start of each output file.
611
612translate option (-t).
613......................
614
615This is the "translate messages in the script" option.  Translate
616messages in the script.  If you have set the `LANG' environment
617variable, messages printed by `shar' will be in the specified language.
618The produced script will still be emitted using messages in the lingua
619franca of the computer world: English.  This option will cause the
620script messages to appear in the languages specified by the `LANG'
621environment variable set when the script is produced.
622
623
624File: sharutils.info,  Node: shar xmit-defenses,  Next: shar shar-flavors,  Prev: shar headers,  Up: shar Invocation
625
6262.1.6 xmit-defenses options
627---------------------------
628
629Protecting against transmission issues.
630
631no-character-count option.
632..........................
633
634This is the "do not use `wc -c' to check size" option.  Do NOT check
635each file with 'wc -c' after unpack.  The default is to check.
636
637no-md5-digest option (-D).
638..........................
639
640This is the "do not use `md5sum' digest to verify" option.  Do _not_
641use `md5sum' digest to verify the unpacked files.  The default is to
642check.
643
644force-prefix option (-F).
645.........................
646
647This is the "apply the prefix character on every line" option.  Forces
648the prefix character to be prepended to every line, even if not
649required.  This option may slightly increase the size of the archive,
650especially if `--uuencode' or a compression option is used.
651
652here-delimiter option (-d).
653...........................
654
655This is the "use delim to delimit the files" option.  This option takes
656a string argument `DELIM'.  Use DELIM to delimit the files in the shar
657instead of SHAR_EOF.  This is for those who want to personalize their
658shar files.  The delimiter will always be prefixed and suffixed with
659underscores.
660
661
662File: sharutils.info,  Node: shar shar-flavors,  Next: shar internationalization,  Prev: shar xmit-defenses,  Up: shar Invocation
663
6642.1.7 shar-flavors options
665--------------------------
666
667Producing different kinds of shars.
668
669vanilla-operation option (-V).
670..............................
671
672This is the "produce very simple shars" option.  This option produces
673`vanilla' shars which rely only upon the existence of `echo', `test'
674and `sed' in the unpacking environment.
675
676   It changes the default behavior from mixed mode (`--mixed-uuencode')
677to text mode (`--text-files').  Warnings are produced if options are
678specified that will require decompression or decoding in the unpacking
679environment.
680
681no-piping option (-P).
682......................
683
684This is the "use temporary files between programs" option.  In the
685`shar' file, use a temporary file to hold file contents between
686unpacking stages instead of using pipes.  This option is mandatory when
687you know the unpacking will happen on systems that do not support pipes.
688
689no-check-existing option (-x).
690..............................
691
692This is the "blindly overwrite existing files" option.  Create the
693archive so that when processed it will overwrite existing files without
694checking first.  If neither this option nor the `--query-user' option
695is specified, the unpack will not overwrite pre-existing files.  In all
696cases, however, if `--cut-mark' is passed as a parameter to the script
697when unpacking, then existing files will be overwritten unconditionally.
698
699    sh shar-archive-file -c
700
701query-user option (-X).
702.......................
703
704This is the "ask user before overwriting files" option.
705
706This option has some usage constraints.  It:
707   * must not appear in combination with any of the following options:
708     vanilla-operation.
709
710   When unpacking, interactively ask the user if files should be
711overwritten.  Do not use for shars submitted to the net.
712
713   Use of this option produces shars which _will_ cause problems with
714some unshar-style procedures, particularly when used together with
715vanilla mode (`--vanilla-operation').  Use this feature mainly for
716archives to be passed among agreeable parties.  Certainly, `-X' is
717_not_ for shell archives which are to be submitted to Usenet or other
718public networks.
719
720   The problem is that `unshar' programs or procedures often feed
721`/bin/sh' from its standard input, thus putting `/bin/sh' and the shell
722archive script in competition for input lines.  As an attempt to
723alleviate this problem, `shar' will try to detect if `/dev/tty' exists
724at the receiving site and will use it to read user replies.  But this
725does not work in all cases, it may happen that the receiving user will
726have to avoid using `unshar' programs or procedures, and call `/bin/sh'
727directly.  In vanilla mode, using `/dev/tty' is not even attempted.
728
729no-timestamp option (-m).
730.........................
731
732This is the "do not restore modification times" option.  Avoid
733generating 'touch' commands to restore the file modification dates when
734unpacking files from the archive.
735
736   When file modification times are not preserved, project build
737programs like "make" will see built files older than the files they get
738built from.  This is why, when this option is not used, a special
739effort is made to restore timestamps.
740
741quiet-unshar option (-Q).
742.........................
743
744This is the "avoid verbose messages at unshar time" option.  Verbose
745OFF.  Disables the inclusion of comments to be output when the archive
746is unpacked.
747
748basename option (-f).
749.....................
750
751This is the "restore in one directory, despite hierarchy" option.
752Restore by the base file name only, rather than path.  This option
753causes only file names to be used, which is useful when building a shar
754from several directories, or another directory.  Note that if a
755directory name is passed to shar, the substructure of that directory
756will be restored whether this option is specified or not.
757
758
759File: sharutils.info,  Node: shar internationalization,  Next: shar feedback,  Prev: shar shar-flavors,  Up: shar Invocation
760
7612.1.8 internationalization options
762----------------------------------
763
764Internationalization options.
765
766no-i18n option.
767...............
768
769This is the "do not internationalize" option.  Do not produce
770internationalized shell archives, use default English messages.  By
771default, shar produces archives that will try to output messages in the
772unpackers preferred language (as determined by the LANG/LC_MESSAGES
773environmental variables) when they are unpacked.  If no message file
774for the unpackers language is found at unpack time, messages will be in
775English.
776
777print-text-domain-dir option.
778.............................
779
780This is the "print directory with shar messages" option.  Prints the
781directory shar looks in to find messages files for different languages,
782then immediately exits.
783
784
785File: sharutils.info,  Node: shar feedback,  Next: shar config,  Prev: shar internationalization,  Up: shar Invocation
786
7872.1.9 feedback options
788----------------------
789
790User feedback/entertainment.
791
792quiet option (-q).
793..................
794
795This is the "do not output verbose messages" option.  omit progress
796messages.
797
798silent option.
799..............
800
801This is an alias for the `quiet' option, *note the quiet option
802documentation: shar quiet.
803
804
805File: sharutils.info,  Node: shar config,  Next: shar exit status,  Prev: shar feedback,  Up: shar Invocation
806
8072.1.10 presetting/configuring shar
808----------------------------------
809
810Any option that is not marked as not presettable may be preset by
811loading values from configuration ("rc" or "ini") files.
812
813`libopts' will search in `$HOME' for configuration (option) data.  The
814environment variable `HOME, ' is expanded and replaced when the program
815runs If this is a plain file, it is simply processed.  If it is a
816directory, then a file named `.sharrc' is searched for within that
817directory.
818
819   Configuration files may be in a wide variety of formats.  The basic
820format is an option name followed by a value (argument) on the same
821line.  Values may be separated from the option name with a colon, equal
822sign or simply white space.  Values may be continued across multiple
823lines by escaping the newline with a backslash.
824
825   Multiple programs may also share the same initialization file.
826Common options are collected at the top, followed by program specific
827segments.  The segments are separated by lines like:
828    [SHAR]
829   or by
830    <?program shar>
831   Do not mix these styles within one configuration file.
832
833   Compound values and carefully constructed string values may also be
834specified using XML syntax:
835    <option-name>
836       <sub-opt>...&lt;...&gt;...</sub-opt>
837    </option-name>
838   yielding an `option-name.sub-opt' string value of
839    "...<...>..."
840   `AutoOpts' does not track suboptions.  You simply note that it is a
841hierarchicly valued option.  `AutoOpts' does provide a means for
842searching the associated name/value pair list (see: optionFindValue).
843
844   The command line options relating to configuration and/or usage help
845are:
846
847version (-v)
848............
849
850Print the program version to standard out, optionally with licensing
851information, then exit 0.  The optional argument specifies how much
852licensing detail to provide.  The default is to print the license name
853with the version.  The licensing infomation may be selected with an
854option argument.  Only the first letter of the argument is examined:
855
856`version'
857     Only print the version.
858
859`copyright'
860     Name the copyright usage licensing terms.  This is the default.
861
862`verbose'
863     Print the full copyright usage licensing terms.
864
865
866File: sharutils.info,  Node: shar exit status,  Next: shar Authors,  Prev: shar config,  Up: shar Invocation
867
8682.1.11 shar exit status
869-----------------------
870
871One of the following exit values will be returned:
872`0 (EXIT_SUCCESS)'
873     Successful program execution.
874
875`1 (EXIT_OPTION_ERROR)'
876     The command options were misconfigured.
877
878`2 (EXIT_FILE_NOT_FOUND)'
879     a specified input could not be found
880
881`3 (EXIT_CANNOT_OPENDIR)'
882     open/close of specified directory failed
883
884`4 (EXIT_FAILED)'
885     Resource limit/miscelleaneous shar command failure
886
887`63 (EXIT_BUG)'
888     There is a shar command bug.  Please report it.
889
890`66 (EX_NOINPUT)'
891     A specified configuration file could not be loaded.
892
893`70 (EX_SOFTWARE)'
894     libopts had an internal operational error.  Please report it to
895     autogen-users@lists.sourceforge.net.  Thank you.
896
897
898File: sharutils.info,  Node: shar Authors,  Next: shar Bugs,  Prev: shar exit status,  Up: shar Invocation
899
9002.1.12 shar Authors
901-------------------
902
903The `shar' and `unshar' programs is the collective work of many
904authors.  Many people contributed by reporting problems, suggesting
905various improvements or submitting actual code.  A list of these people
906is in the `THANKS' file in the sharutils distribution.
907
908
909File: sharutils.info,  Node: shar Bugs,  Next: shar Examples,  Prev: shar Authors,  Up: shar Invocation
910
9112.1.13 shar Bugs
912----------------
913
914Please put `sharutils' in the subject line for emailed bug reports.  It
915helps to spot the message.
916
917
918File: sharutils.info,  Node: shar Examples,  Next: shar Warnings,  Prev: shar Bugs,  Up: shar Invocation
919
9202.1.14 shar Examples
921--------------------
922
923The first shows how to make a shell archive out of all C program
924sources.  The second produces a shell archive with all `.c' and `.h'
925files, which unpacks silently.  The third gives a shell archive of all
926uuencoded `.arc' files, into numbered files starting from `arc.sh.01'.
927The last example gives a shell archive which will use only the file
928names at unpack time.
929
930    shar *.c > cprog.shar
931    shar -Q *.[ch] > cprog.shar
932    shar -B -l28 -oarc.sh *.arc
933    shar -f /lcl/src/u*.c > u.sh
934
935
936File: sharutils.info,  Node: shar Warnings,  Next: shar See Also,  Prev: shar Examples,  Up: shar Invocation
937
9382.1.15 shar Warnings
939--------------------
940
941No attempt is made to restore the protection and modification dates for
942directories, even if this is done by default for files.  Thus, if a
943directory is given to `shar', the protection and modification dates of
944corresponding unpacked directory may not match those of the original.
945
946   If a directory is passed to shar, it may be scanned more than once,
947to conserve memory.  Therefore, do not change the directory contents
948while shar is running.
949
950   Be careful that the output file(s) are not included in the inputs or
951shar may loop until the disk fills up.  Be particularly careful when a
952directory is passed to shar that the output files are not in that
953directory or a subdirectory of it.
954
955   Use of the compression and encoding options will slow the archive
956process, perhaps considerably.
957
958   Use of the `--query-user' produces shars which _will_ cause problems
959with many unshar procedures.  Use this feature only for archives to be
960passed among agreeable parties.  Certainly, `query-user' is NOT for
961shell archives which are to be distributed across the net.  The use of
962compression in net shars will cause you to be flamed off the earth.
963Not using the `--no-timestamp' or `--force-prefix' options may also get
964you occasional complaints.  Put these options into your `~/.sharrc'
965file.
966
967
968File: sharutils.info,  Node: shar See Also,  Prev: shar Warnings,  Up: shar Invocation
969
9702.1.16 shar See Also
971--------------------
972
973unshar(1)
974
975
976File: sharutils.info,  Node: unshar Invocation,  Next: uuencode Invocation,  Prev: shar Invocation,  Up: Basic
977
9782.2 Invoking unshar
979===================
980
981Unshar scans the input files (typically email messages) looking for the
982start of a shell archive.  If no files are given, then standard input
983is processed instead.  It then passes each archive discovered through
984an invocation of the shell program to unpack it.
985
986   This section was generated by *AutoGen*, using the `agtexi-cmd'
987template and the option descriptions for the `unshar' program.  This
988software is released under the GNU General Public License, version 3 or
989later.
990
991* Menu:
992
993* unshar usage::                  unshar help/usage (`--help')
994* unshar directory::              directory option (-d)
995* unshar overwrite::              overwrite option (-c)
996* unshar force::                  force option (-f)
997* unshar split-at::               split-at option (-E)
998* unshar exit-0::                 exit-0 option (-e)
999* unshar debug::                  debug option (-D)
1000* unshar config::                 presetting/configuring unshar
1001* unshar exit status::            exit status
1002* unshar Authors::                Authors
1003* unshar Bugs::                   Bugs
1004* unshar See Also::               See Also
1005
1006
1007File: sharutils.info,  Node: unshar usage,  Next: unshar directory,  Up: unshar Invocation
1008
10092.2.1 unshar help/usage (`--help')
1010----------------------------------
1011
1012This is the automatically generated usage text for unshar.
1013
1014   The text printed is the same whether selected with the `help' option
1015(`--help') or the `more-help' option (`--more-help').  `more-help' will
1016print the usage text by passing it through a pager program.
1017`more-help' is disabled on platforms without a working `fork(2)'
1018function.  The `PAGER' environment variable is used to select the
1019program, defaulting to `more'.  Both will exit with a status code of 0.
1020
1021unshar (GNU sharutils) - unpack a shar archive
1022Usage:  unshar [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [<file>...]
1023
1024   -d, --directory=DIR        unpack into the directory DIR
1025   -c, --overwrite            overwrite any pre-existing files
1026   -f, --force                an alias for the 'overwrite' option
1027   -E, --split-at=SPLIT-PAT   split input on SPLIT-PAT lines
1028   -e, --exit-0               split input on "exit 0" lines
1029                                - prohibits the option 'split-at'
1030   -D, --debug                debug the shell code
1031   -v, --version[=MODE]       output version information and exit
1032   -h, --help                 display extended usage information and exit
1033   -!, --more-help            extended usage information passed thru pager
1034   -R, --save-opts[=FILE]     save the option state to the config file FILE
1035   -r, --load-opts=FILE       load options from the config file FILE
1036                                - disabled as '--no-load-opts'
1037                                - may appear multiple times
1038
1039Options are specified by doubled hyphens and their name or by a single
1040hyphen and the flag character.
1041
1042If no arguments are provided, input arguments are read from stdin,
1043one per line; blank and '#'-prefixed lines are comments.
1044'stdin' may not be a terminal (tty).
1045
1046The following option preset mechanisms are supported:
1047 - reading file $HOME/.sharrc
1048
1049'unshar' scans the input files (typically email messages) looking for the
1050start of a shell archive.  If no files are given, then standard input is
1051processed instead.  It then passes each archive discovered through an
1052invocation of the shell program to unpack it.
1053
1054Please send bug reports to:  <bug-gnu-utils@gnu.org>
1055
1056
1057File: sharutils.info,  Node: unshar directory,  Next: unshar overwrite,  Prev: unshar usage,  Up: unshar Invocation
1058
10592.2.2 directory option (-d)
1060---------------------------
1061
1062This is the "unpack into the directory `dir'" option.  This option
1063takes a string argument `dir'.  The input file names are relative to
1064the current directory when the program was started.  This option tells
1065`unshar' to insert a `cd <dir>' commad at the start of the `shar' text
1066written to the shell.
1067
1068
1069File: sharutils.info,  Node: unshar overwrite,  Next: unshar force,  Prev: unshar directory,  Up: unshar Invocation
1070
10712.2.3 overwrite option (-c)
1072---------------------------
1073
1074This is the "overwrite any pre-existing files" option.  This option is
1075passed through as an option to the shar file.  Many shell archive
1076scripts accept a `-c' argument to indicate that existing files should
1077be overwritten.
1078
1079
1080File: sharutils.info,  Node: unshar force,  Next: unshar split-at,  Prev: unshar overwrite,  Up: unshar Invocation
1081
10822.2.4 force option (-f)
1083-----------------------
1084
1085This is an alias for the `overwrite' option, *note the overwrite option
1086documentation: unshar overwrite.
1087
1088
1089File: sharutils.info,  Node: unshar split-at,  Next: unshar exit-0,  Prev: unshar force,  Up: unshar Invocation
1090
10912.2.5 split-at option (-E)
1092--------------------------
1093
1094This is the "split input on SPLIT-MARK lines" option.  This option
1095takes a string argument `split-mark'.  With this option, `unshar'
1096isolates each different shell archive from the others which have been
1097placed in the same file, unpacking each in turn, from the beginning of
1098the file to the end.  Its proper operation relies on the fact that many
1099shar files are terminated by a readily identifiable string at the start
1100of the last line.
1101
1102   For example, noticing that most `.signatures' have a double hyphen
1103("-") on a line right before them, one can then sometimes use
1104`--split-at=--'.  The signature will then be skipped, along with the
1105headers of the following message.
1106
1107
1108File: sharutils.info,  Node: unshar exit-0,  Next: unshar debug,  Prev: unshar split-at,  Up: unshar Invocation
1109
11102.2.6 exit-0 option (-e)
1111------------------------
1112
1113This is the "split input on "exit 0" lines" option.
1114
1115This option has some usage constraints.  It:
1116   * must not appear in combination with any of the following options:
1117     split-at.
1118
1119   Most shell archives end with a line consisting of simply "exit 0".
1120This option is equivalent to (and conflicts with) `--split-at="exit 0"'.
1121
1122
1123File: sharutils.info,  Node: unshar debug,  Next: unshar config,  Prev: unshar exit-0,  Up: unshar Invocation
1124
11252.2.7 debug option (-D)
1126-----------------------
1127
1128This is the "debug the shell code" option.  "set -x" will be emitted
1129into the code the shell interprets.
1130
1131
1132File: sharutils.info,  Node: unshar config,  Next: unshar exit status,  Prev: unshar debug,  Up: unshar Invocation
1133
11342.2.8 presetting/configuring unshar
1135-----------------------------------
1136
1137Any option that is not marked as not presettable may be preset by
1138loading values from configuration ("rc" or "ini") files.
1139
1140`libopts' will search in `$HOME' for configuration (option) data.  The
1141environment variable `HOME, ' is expanded and replaced when the program
1142runs If this is a plain file, it is simply processed.  If it is a
1143directory, then a file named `.sharrc' is searched for within that
1144directory.
1145
1146   Configuration files may be in a wide variety of formats.  The basic
1147format is an option name followed by a value (argument) on the same
1148line.  Values may be separated from the option name with a colon, equal
1149sign or simply white space.  Values may be continued across multiple
1150lines by escaping the newline with a backslash.
1151
1152   Multiple programs may also share the same initialization file.
1153Common options are collected at the top, followed by program specific
1154segments.  The segments are separated by lines like:
1155    [UNSHAR]
1156   or by
1157    <?program unshar>
1158   Do not mix these styles within one configuration file.
1159
1160   Compound values and carefully constructed string values may also be
1161specified using XML syntax:
1162    <option-name>
1163       <sub-opt>...&lt;...&gt;...</sub-opt>
1164    </option-name>
1165   yielding an `option-name.sub-opt' string value of
1166    "...<...>..."
1167   `AutoOpts' does not track suboptions.  You simply note that it is a
1168hierarchicly valued option.  `AutoOpts' does provide a means for
1169searching the associated name/value pair list (see: optionFindValue).
1170
1171   The command line options relating to configuration and/or usage help
1172are:
1173
1174version (-v)
1175............
1176
1177Print the program version to standard out, optionally with licensing
1178information, then exit 0.  The optional argument specifies how much
1179licensing detail to provide.  The default is to print the license name
1180with the version.  The licensing infomation may be selected with an
1181option argument.  Only the first letter of the argument is examined:
1182
1183`version'
1184     Only print the version.
1185
1186`copyright'
1187     Name the copyright usage licensing terms.  This is the default.
1188
1189`verbose'
1190     Print the full copyright usage licensing terms.
1191
1192
1193File: sharutils.info,  Node: unshar exit status,  Next: unshar Authors,  Prev: unshar config,  Up: unshar Invocation
1194
11952.2.9 unshar exit status
1196------------------------
1197
1198One of the following exit values will be returned:
1199`0 (EXIT_SUCCESS)'
1200     Successful program execution.
1201
1202`1 (EXIT_FAILURE)'
1203     There was an error in command usage.
1204
1205`2 (EXIT_POPEN_PROBLEM)'
1206     cannot spawn or write to a shell process
1207
1208`3 (EXIT_CANNOT_CREATE)'
1209     cannot create output file
1210
1211`4 (EXIT_BAD_DIRECTORY)'
1212     the working directory structure is invalid
1213
1214`5 (EXIT_NOMEM)'
1215     memory allocation failure
1216
1217`6 (EXIT_INVALID)'
1218     invalid input, does not contain a shar file
1219
1220`66 (EX_NOINPUT)'
1221     A specified configuration file could not be loaded.
1222
1223`70 (EX_SOFTWARE)'
1224     libopts had an internal operational error.  Please report it to
1225     autogen-users@lists.sourceforge.net.  Thank you.
1226
1227
1228File: sharutils.info,  Node: unshar Authors,  Next: unshar Bugs,  Prev: unshar exit status,  Up: unshar Invocation
1229
12302.2.10 unshar Authors
1231---------------------
1232
1233The `shar' and `unshar' programs is the collective work of many
1234authors.  Many people contributed by reporting problems, suggesting
1235various improvements or submitting actual code.  A list of these people
1236is in the `THANKS' file in the sharutils distribution.
1237
1238
1239File: sharutils.info,  Node: unshar Bugs,  Next: unshar See Also,  Prev: unshar Authors,  Up: unshar Invocation
1240
12412.2.11 unshar Bugs
1242------------------
1243
1244Please put `sharutils' in the subject line for emailed bug reports.  It
1245helps to spot the message.
1246
1247
1248File: sharutils.info,  Node: unshar See Also,  Prev: unshar Bugs,  Up: unshar Invocation
1249
12502.2.12 unshar See Also
1251----------------------
1252
1253shar(1)
1254
1255
1256File: sharutils.info,  Node: uuencode Invocation,  Next: uudecode Invocation,  Prev: unshar Invocation,  Up: Basic
1257
12582.3 Invoking uuencode
1259=====================
1260
1261`uuencode' is used to create an ASCII representation of a file that can
1262be sent over channels that may otherwise corrupt the data.
1263Specifically, email cannot handle binary data and will often even
1264insert a character when the six character sequence "\nFrom " is seen.
1265
1266   `uuencode' will read `in-file' if provided and otherwise read data
1267from standard in and write the encoded form to standard out.  The
1268output will begin with a header line for use by `uudecode' giving it
1269the resulting suggested file `output-name' and access mode.  If the
1270`output-name' is specifically `/dev/stdout', then `uudecode' will emit
1271the decoded file to standard out.
1272
1273   *Note*: `uuencode' uses buffered input and assumes that it is not
1274hand typed from a tty.  The consequence is that at a tty, you may need
1275to hit Ctl-D several times to terminate input.
1276
1277   This section was generated by *AutoGen*, using the `agtexi-cmd'
1278template and the option descriptions for the `uuencode' program.  This
1279software is released under the GNU General Public License, version 3 or
1280later.
1281
1282* Menu:
1283
1284* uuencode usage::                  uuencode help/usage (`--help')
1285* uuencode base64::                 base64 option (-m)
1286* uuencode encode-file-name::       encode-file-name option (-e)
1287* uuencode config::                 presetting/configuring uuencode
1288* uuencode exit status::            exit status
1289* uuencode Bugs::                   Bugs
1290* uuencode Standards::              Standards
1291* uuencode History::                History
1292* uuencode See Also::               See Also
1293
1294
1295File: sharutils.info,  Node: uuencode usage,  Next: uuencode base64,  Up: uuencode Invocation
1296
12972.3.1 uuencode help/usage (`--help')
1298------------------------------------
1299
1300This is the automatically generated usage text for uuencode.
1301
1302   The text printed is the same whether selected with the `help' option
1303(`--help') or the `more-help' option (`--more-help').  `more-help' will
1304print the usage text by passing it through a pager program.
1305`more-help' is disabled on platforms without a working `fork(2)'
1306function.  The `PAGER' environment variable is used to select the
1307program, defaulting to `more'.  Both will exit with a status code of 0.
1308
1309uuencode (GNU sharutils) - encode a file into email friendly text
1310Usage:  uuencode [ -<flag> | --<name> ]... [<in-file>] <output-name>
1311
1312   -m, --base64               convert using base64
1313   -e, --encode-file-name     encode the output file name
1314   -v, --version[=MODE]       output version information and exit
1315   -h, --help                 display extended usage information and exit
1316   -!, --more-help            extended usage information passed thru pager
1317   -R, --save-opts[=FILE]     save the option state to a config file FILE
1318   -r, --load-opts=FILE       load options from the config file FILE
1319                                - disabled with '--no-load-opts'
1320                                - may appear multiple times
1321
1322Options are specified by doubled hyphens and their name or by a single
1323hyphen and the flag character.
1324
1325The following option preset mechanisms are supported:
1326 - reading file $HOME/.sharrc
1327
1328'uuencode' is used to create an ASCII representation of a file that can be
1329sent over channels that may otherwise corrupt the data.  Specifically,
1330email cannot handle binary data and will often even insert a character when
1331the six character sequence "\nFrom " is seen.
1332
1333'uuencode' will read 'in-file' if provided and otherwise read data from
1334standard in and write the encoded form to standard out.  The output will
1335begin with a header line for use by 'uudecode' giving it the resulting
1336suggested file 'output-name' and access mode.  If the 'output-name' is
1337specifically '/dev/stdout', then 'uudecode' will emit the decoded file to
1338standard out.
1339
1340'Note': 'uuencode' uses buffered input and assumes that it is not hand
1341typed from a tty.  The consequence is that at a tty, you may need to hit
1342Ctl-D several times to terminate input.
1343
1344Please send bug reports to:  <bug-gnu-utils@gnu.org>
1345
1346
1347File: sharutils.info,  Node: uuencode base64,  Next: uuencode encode-file-name,  Prev: uuencode usage,  Up: uuencode Invocation
1348
13492.3.2 base64 option (-m)
1350------------------------
1351
1352This is the "convert using base64" option.  By default, `uuencode' will
1353encode using the traditional conversion.  It is slower and less compact
1354than base64.  The encoded form of the file is expanded by 37% for UU
1355encoding and by 35% for base64 encoding (3 bytes become 4 plus control
1356information).
1357
1358
1359File: sharutils.info,  Node: uuencode encode-file-name,  Next: uuencode config,  Prev: uuencode base64,  Up: uuencode Invocation
1360
13612.3.3 encode-file-name option (-e)
1362----------------------------------
1363
1364This is the "encode the output file name" option.  Since output file
1365names may contain characters that are not handled well by various
1366transmission modes, you may specify that the `output-name' be base64
1367encoded as well.  (Traditional uuencoding of the file name is not
1368supported.)
1369
1370
1371File: sharutils.info,  Node: uuencode config,  Next: uuencode exit status,  Prev: uuencode encode-file-name,  Up: uuencode Invocation
1372
13732.3.4 presetting/configuring uuencode
1374-------------------------------------
1375
1376Any option that is not marked as not presettable may be preset by
1377loading values from configuration ("rc" or "ini") files.
1378
1379`libopts' will search in `$HOME' for configuration (option) data.  The
1380environment variable `HOME, ' is expanded and replaced when the program
1381runs If this is a plain file, it is simply processed.  If it is a
1382directory, then a file named `.sharrc' is searched for within that
1383directory.
1384
1385   Configuration files may be in a wide variety of formats.  The basic
1386format is an option name followed by a value (argument) on the same
1387line.  Values may be separated from the option name with a colon, equal
1388sign or simply white space.  Values may be continued across multiple
1389lines by escaping the newline with a backslash.
1390
1391   Multiple programs may also share the same initialization file.
1392Common options are collected at the top, followed by program specific
1393segments.  The segments are separated by lines like:
1394    [UUENCODE]
1395   or by
1396    <?program uuencode>
1397   Do not mix these styles within one configuration file.
1398
1399   Compound values and carefully constructed string values may also be
1400specified using XML syntax:
1401    <option-name>
1402       <sub-opt>...&lt;...&gt;...</sub-opt>
1403    </option-name>
1404   yielding an `option-name.sub-opt' string value of
1405    "...<...>..."
1406   `AutoOpts' does not track suboptions.  You simply note that it is a
1407hierarchicly valued option.  `AutoOpts' does provide a means for
1408searching the associated name/value pair list (see: optionFindValue).
1409
1410   The command line options relating to configuration and/or usage help
1411are:
1412
1413version (-v)
1414............
1415
1416Print the program version to standard out, optionally with licensing
1417information, then exit 0.  The optional argument specifies how much
1418licensing detail to provide.  The default is to print the license name
1419with the version.  The licensing infomation may be selected with an
1420option argument.  Only the first letter of the argument is examined:
1421
1422`version'
1423     Only print the version.
1424
1425`copyright'
1426     Name the copyright usage licensing terms.  This is the default.
1427
1428`verbose'
1429     Print the full copyright usage licensing terms.
1430
1431
1432File: sharutils.info,  Node: uuencode exit status,  Next: uuencode Bugs,  Prev: uuencode config,  Up: uuencode Invocation
1433
14342.3.5 uuencode exit status
1435--------------------------
1436
1437One of the following exit values will be returned:
1438`0 (EXIT_SUCCESS)'
1439     Successful program execution.
1440
1441`1 (EXIT_FAILURE)'
1442     The operation failed or the command syntax was not valid.
1443
1444`66 (EX_NOINPUT)'
1445     A specified configuration file could not be loaded.
1446
1447`70 (EX_SOFTWARE)'
1448     libopts had an internal operational error.  Please report it to
1449     autogen-users@lists.sourceforge.net.  Thank you.
1450
1451
1452File: sharutils.info,  Node: uuencode Bugs,  Next: uuencode Standards,  Prev: uuencode exit status,  Up: uuencode Invocation
1453
14542.3.6 uuencode Bugs
1455-------------------
1456
1457Please put `sharutils' in the subject line for emailed bug reports.  It
1458helps to spot the message.
1459
1460
1461File: sharutils.info,  Node: uuencode Standards,  Next: uuencode History,  Prev: uuencode Bugs,  Up: uuencode Invocation
1462
14632.3.7 uuencode Standards
1464------------------------
1465
1466This implementation is compliant with P1003.2b/D11.
1467
1468
1469File: sharutils.info,  Node: uuencode History,  Next: uuencode See Also,  Prev: uuencode Standards,  Up: uuencode Invocation
1470
14712.3.8 uuencode History
1472----------------------
1473
1474The `uuencode' command first appeared in BSD 4.0.
1475
1476
1477File: sharutils.info,  Node: uuencode See Also,  Prev: uuencode History,  Up: uuencode Invocation
1478
14792.3.9 uuencode See Also
1480-----------------------
1481
1482uudecode(1), uuencode(5)
1483
1484
1485File: sharutils.info,  Node: uudecode Invocation,  Prev: uuencode Invocation,  Up: Basic
1486
14872.4 Invoking uudecode
1488=====================
1489
1490If no `file'(s) are provided, then standard input is decoded.
1491`uudecode' transforms uuencoded files into their original form.
1492
1493   The encoded file(s) may be specified on the command line, or one may
1494be read from standard input.  The output file name is specified in the
1495encoded file, but may be overridden with the `-o' option.  It will have
1496the mode of the original file, except that setuid and execute bits are
1497not retained.  If the output file is specified to be `/dev/stdout' or
1498`-', the result will be written to standard output. If there are
1499multiple input files and the second or subsquent file specifies
1500standard output, the decoded data will be written to the same file as
1501the previous output.  Don't do that.
1502
1503   `uudecode' ignores any leading and trailing lines.  It looks for a
1504line that starts with "`begin'" and proceeds until the end-of-encoding
1505marker is found.  The program determines from the header line of the
1506encoded file which of the two supported encoding schemes was used and
1507whether or not the output file name has been encoded with base64
1508encoding.  See `uuencode(5)'.
1509
1510   This section was generated by *AutoGen*, using the `agtexi-cmd'
1511template and the option descriptions for the `uudecode' program.  This
1512software is released under the GNU General Public License, version 3 or
1513later.
1514
1515* Menu:
1516
1517* uudecode usage::                  uudecode help/usage (`--help')
1518* uudecode output-file::            output-file option (-o)
1519* uudecode ignore-chmod::           ignore-chmod option (-c)
1520* uudecode config::                 presetting/configuring uudecode
1521* uudecode exit status::            exit status
1522* uudecode Bugs::                   Bugs
1523* uudecode Standards::              Standards
1524* uudecode See Also::               See Also
1525
1526
1527File: sharutils.info,  Node: uudecode usage,  Next: uudecode output-file,  Up: uudecode Invocation
1528
15292.4.1 uudecode help/usage (`--help')
1530------------------------------------
1531
1532This is the automatically generated usage text for uudecode.
1533
1534   The text printed is the same whether selected with the `help' option
1535(`--help') or the `more-help' option (`--more-help').  `more-help' will
1536print the usage text by passing it through a pager program.
1537`more-help' is disabled on platforms without a working `fork(2)'
1538function.  The `PAGER' environment variable is used to select the
1539program, defaulting to `more'.  Both will exit with a status code of 0.
1540
1541uudecode (GNU sharutils) - decode an encoded file
1542Usage:  uudecode [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [<file>...]
1543
1544   -o, --output-file=str      direct output to file
1545   -c, --ignore-chmod         ignore fchmod(3P) errors
1546   -v, --version[=MODE]       output version information and exit
1547   -h, --help                 display extended usage information and exit
1548   -!, --more-help            extended usage information passed thru pager
1549   -R, --save-opts[=FILE]     save the option state to a config file FILE
1550   -r, --load-opts=FILE       load options from the config file FILE
1551                                - disabled with '--no-load-opts'
1552                                - may appear multiple times
1553
1554Options are specified by doubled hyphens and their name or by a single
1555hyphen and the flag character.
1556If no 'file'(s) are provided, then standard input is decoded.
1557
1558The following option preset mechanisms are supported:
1559 - reading file $HOME/.sharrc
1560
1561'uudecode' transforms uuencoded files into their original form.
1562
1563The encoded file(s) may be specified on the command line, or one may be
1564read from standard input.  The output file name is specified in the encoded
1565file, but may be overridden with the '-o' option.  It will have the mode of
1566the original file, except that setuid and execute bits are not retained.  If
1567the output file is specified to be '/dev/stdout' or '-', the result will be
1568written to standard output.  If there are multiple input files and the
1569second or subsquent file specifies standard output, the decoded data will
1570be written to the same file as the previous output.  Don't do that.
1571
1572'uudecode' ignores any leading and trailing lines.  It looks for a line
1573that starts with "'begin'" and proceeds until the end-of-encoding marker is
1574found.  The program determines from the header line of the encoded file
1575which of the two supported encoding schemes was used and whether or not the
1576output file name has been encoded with base64 encoding.  See 'uuencode(5)'.
1577
1578Please send bug reports to:  <bug-gnu-utils@gnu.org>
1579
1580
1581File: sharutils.info,  Node: uudecode output-file,  Next: uudecode ignore-chmod,  Prev: uudecode usage,  Up: uudecode Invocation
1582
15832.4.2 output-file option (-o)
1584-----------------------------
1585
1586This is the "direct output to `file'" option.  This option takes a
1587string argument `file'.  If specified, decoded data are written to this
1588file.  When multiple inputs are specified on the command line, this
1589option cannot be specified.  All decoded data must be written to the
1590file name encoded in the data.
1591
1592
1593File: sharutils.info,  Node: uudecode ignore-chmod,  Next: uudecode config,  Prev: uudecode output-file,  Up: uudecode Invocation
1594
15952.4.3 ignore-chmod option (-c)
1596------------------------------
1597
1598This is the "ignore `fchmod(3p)' errors" option.  By default, if the
1599output file permissions cannot be changed to the permissions specified
1600in the encoded data, the file will not be written out and execution
1601stops.  This option will cause that error to be ignored.  The resulting
1602file will have all the data, but the incorrect mode settings.
1603
1604   `fchmod()' errors are also ignored if `POSIXLY_CORRECT' is set in
1605the environment.  RE: <http://austingroupbugs.net/view.php?id=635>
1606
1607   A warning is always emitted when `fchmod()' fails.
1608
1609
1610File: sharutils.info,  Node: uudecode config,  Next: uudecode exit status,  Prev: uudecode ignore-chmod,  Up: uudecode Invocation
1611
16122.4.4 presetting/configuring uudecode
1613-------------------------------------
1614
1615Any option that is not marked as not presettable may be preset by
1616loading values from configuration ("rc" or "ini") files.
1617
1618`libopts' will search in `$HOME' for configuration (option) data.  The
1619environment variable `HOME, ' is expanded and replaced when the program
1620runs If this is a plain file, it is simply processed.  If it is a
1621directory, then a file named `.sharrc' is searched for within that
1622directory.
1623
1624   Configuration files may be in a wide variety of formats.  The basic
1625format is an option name followed by a value (argument) on the same
1626line.  Values may be separated from the option name with a colon, equal
1627sign or simply white space.  Values may be continued across multiple
1628lines by escaping the newline with a backslash.
1629
1630   Multiple programs may also share the same initialization file.
1631Common options are collected at the top, followed by program specific
1632segments.  The segments are separated by lines like:
1633    [UUDECODE]
1634   or by
1635    <?program uudecode>
1636   Do not mix these styles within one configuration file.
1637
1638   Compound values and carefully constructed string values may also be
1639specified using XML syntax:
1640    <option-name>
1641       <sub-opt>...&lt;...&gt;...</sub-opt>
1642    </option-name>
1643   yielding an `option-name.sub-opt' string value of
1644    "...<...>..."
1645   `AutoOpts' does not track suboptions.  You simply note that it is a
1646hierarchicly valued option.  `AutoOpts' does provide a means for
1647searching the associated name/value pair list (see: optionFindValue).
1648
1649   The command line options relating to configuration and/or usage help
1650are:
1651
1652version (-v)
1653............
1654
1655Print the program version to standard out, optionally with licensing
1656information, then exit 0.  The optional argument specifies how much
1657licensing detail to provide.  The default is to print the license name
1658with the version.  The licensing infomation may be selected with an
1659option argument.  Only the first letter of the argument is examined:
1660
1661`version'
1662     Only print the version.
1663
1664`copyright'
1665     Name the copyright usage licensing terms.  This is the default.
1666
1667`verbose'
1668     Print the full copyright usage licensing terms.
1669
1670
1671File: sharutils.info,  Node: uudecode exit status,  Next: uudecode Bugs,  Prev: uudecode config,  Up: uudecode Invocation
1672
16732.4.5 uudecode exit status
1674--------------------------
1675
1676One of the following exit values will be returned:
1677`0 (EXIT_SUCCESS)'
1678     Successful program execution.
1679
1680`1 (EXIT_OPTION_ERROR)'
1681     The command options were misconfigured.
1682
1683`2 (EXIT_INVALID)'
1684     (warning) One or more input files contained no valid data
1685
1686`4 (EXIT_NO_INPUT)'
1687     (warning) The specified input file was not found
1688
1689`8 (EXIT_NO_OUTPUT)'
1690     The specified output file could not be created (error); or else
1691     one of the output files could not be written or its access mode
1692     could not be changed (warnings).  The accompanying message(s) will
1693     distinguish.
1694
1695`9 (EXIT_NO_MEM)'
1696     No process memory available
1697
1698`66 (EX_NOINPUT)'
1699     A specified configuration file could not be loaded.
1700
1701`70 (EX_SOFTWARE)'
1702     libopts had an internal operational error.  Please report it to
1703     autogen-users@lists.sourceforge.net.  Thank you.
1704
1705
1706File: sharutils.info,  Node: uudecode Bugs,  Next: uudecode Standards,  Prev: uudecode exit status,  Up: uudecode Invocation
1707
17082.4.6 uudecode Bugs
1709-------------------
1710
1711Please put `sharutils' in the subject line for emailed bug reports.  It
1712helps to spot the message.
1713
1714   If more than one `name' in the encoded files are the same, or if the
1715second or following input files specifies standard output for the
1716output file, then the result is probably not what is expected.
1717Specifically, standard output will be appended to and named output
1718files will be replaced.
1719
1720
1721File: sharutils.info,  Node: uudecode Standards,  Next: uudecode See Also,  Prev: uudecode Bugs,  Up: uudecode Invocation
1722
17232.4.7 uudecode Standards
1724------------------------
1725
1726This implementation is compliant with P1003.2b/D11.
1727
1728
1729File: sharutils.info,  Node: uudecode See Also,  Prev: uudecode Standards,  Up: uudecode Invocation
1730
17312.4.8 uudecode See Also
1732-----------------------
1733
1734uuencode(1), uuencode(5)
1735
1736
1737File: sharutils.info,  Node: GNU Free Documentation License,  Prev: Basic,  Up: Top
1738
1739Appendix A GNU Free Documentation License
1740*****************************************
1741
1742                     Version 1.3, 3 November 2008
1743
1744    Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
1745    `http://fsf.org/'
1746
1747    Everyone is permitted to copy and distribute verbatim copies
1748    of this license document, but changing it is not allowed.
1749
1750  0. PREAMBLE
1751
1752     The purpose of this License is to make a manual, textbook, or other
1753     functional and useful document "free" in the sense of freedom: to
1754     assure everyone the effective freedom to copy and redistribute it,
1755     with or without modifying it, either commercially or
1756     noncommercially.  Secondarily, this License preserves for the
1757     author and publisher a way to get credit for their work, while not
1758     being considered responsible for modifications made by others.
1759
1760     This License is a kind of "copyleft", which means that derivative
1761     works of the document must themselves be free in the same sense.
1762     It complements the GNU General Public License, which is a copyleft
1763     license designed for free software.
1764
1765     We have designed this License in order to use it for manuals for
1766     free software, because free software needs free documentation: a
1767     free program should come with manuals providing the same freedoms
1768     that the software does.  But this License is not limited to
1769     software manuals; it can be used for any textual work, regardless
1770     of subject matter or whether it is published as a printed book.
1771     We recommend this License principally for works whose purpose is
1772     instruction or reference.
1773
1774  1. APPLICABILITY AND DEFINITIONS
1775
1776     This License applies to any manual or other work, in any medium,
1777     that contains a notice placed by the copyright holder saying it
1778     can be distributed under the terms of this License.  Such a notice
1779     grants a world-wide, royalty-free license, unlimited in duration,
1780     to use that work under the conditions stated herein.  The
1781     "Document", below, refers to any such manual or work.  Any member
1782     of the public is a licensee, and is addressed as "you".  You
1783     accept the license if you copy, modify or distribute the work in a
1784     way requiring permission under copyright law.
1785
1786     A "Modified Version" of the Document means any work containing the
1787     Document or a portion of it, either copied verbatim, or with
1788     modifications and/or translated into another language.
1789
1790     A "Secondary Section" is a named appendix or a front-matter section
1791     of the Document that deals exclusively with the relationship of the
1792     publishers or authors of the Document to the Document's overall
1793     subject (or to related matters) and contains nothing that could
1794     fall directly within that overall subject.  (Thus, if the Document
1795     is in part a textbook of mathematics, a Secondary Section may not
1796     explain any mathematics.)  The relationship could be a matter of
1797     historical connection with the subject or with related matters, or
1798     of legal, commercial, philosophical, ethical or political position
1799     regarding them.
1800
1801     The "Invariant Sections" are certain Secondary Sections whose
1802     titles are designated, as being those of Invariant Sections, in
1803     the notice that says that the Document is released under this
1804     License.  If a section does not fit the above definition of
1805     Secondary then it is not allowed to be designated as Invariant.
1806     The Document may contain zero Invariant Sections.  If the Document
1807     does not identify any Invariant Sections then there are none.
1808
1809     The "Cover Texts" are certain short passages of text that are
1810     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
1811     that says that the Document is released under this License.  A
1812     Front-Cover Text may be at most 5 words, and a Back-Cover Text may
1813     be at most 25 words.
1814
1815     A "Transparent" copy of the Document means a machine-readable copy,
1816     represented in a format whose specification is available to the
1817     general public, that is suitable for revising the document
1818     straightforwardly with generic text editors or (for images
1819     composed of pixels) generic paint programs or (for drawings) some
1820     widely available drawing editor, and that is suitable for input to
1821     text formatters or for automatic translation to a variety of
1822     formats suitable for input to text formatters.  A copy made in an
1823     otherwise Transparent file format whose markup, or absence of
1824     markup, has been arranged to thwart or discourage subsequent
1825     modification by readers is not Transparent.  An image format is
1826     not Transparent if used for any substantial amount of text.  A
1827     copy that is not "Transparent" is called "Opaque".
1828
1829     Examples of suitable formats for Transparent copies include plain
1830     ASCII without markup, Texinfo input format, LaTeX input format,
1831     SGML or XML using a publicly available DTD, and
1832     standard-conforming simple HTML, PostScript or PDF designed for
1833     human modification.  Examples of transparent image formats include
1834     PNG, XCF and JPG.  Opaque formats include proprietary formats that
1835     can be read and edited only by proprietary word processors, SGML or
1836     XML for which the DTD and/or processing tools are not generally
1837     available, and the machine-generated HTML, PostScript or PDF
1838     produced by some word processors for output purposes only.
1839
1840     The "Title Page" means, for a printed book, the title page itself,
1841     plus such following pages as are needed to hold, legibly, the
1842     material this License requires to appear in the title page.  For
1843     works in formats which do not have any title page as such, "Title
1844     Page" means the text near the most prominent appearance of the
1845     work's title, preceding the beginning of the body of the text.
1846
1847     The "publisher" means any person or entity that distributes copies
1848     of the Document to the public.
1849
1850     A section "Entitled XYZ" means a named subunit of the Document
1851     whose title either is precisely XYZ or contains XYZ in parentheses
1852     following text that translates XYZ in another language.  (Here XYZ
1853     stands for a specific section name mentioned below, such as
1854     "Acknowledgements", "Dedications", "Endorsements", or "History".)
1855     To "Preserve the Title" of such a section when you modify the
1856     Document means that it remains a section "Entitled XYZ" according
1857     to this definition.
1858
1859     The Document may include Warranty Disclaimers next to the notice
1860     which states that this License applies to the Document.  These
1861     Warranty Disclaimers are considered to be included by reference in
1862     this License, but only as regards disclaiming warranties: any other
1863     implication that these Warranty Disclaimers may have is void and
1864     has no effect on the meaning of this License.
1865
1866  2. VERBATIM COPYING
1867
1868     You may copy and distribute the Document in any medium, either
1869     commercially or noncommercially, provided that this License, the
1870     copyright notices, and the license notice saying this License
1871     applies to the Document are reproduced in all copies, and that you
1872     add no other conditions whatsoever to those of this License.  You
1873     may not use technical measures to obstruct or control the reading
1874     or further copying of the copies you make or distribute.  However,
1875     you may accept compensation in exchange for copies.  If you
1876     distribute a large enough number of copies you must also follow
1877     the conditions in section 3.
1878
1879     You may also lend copies, under the same conditions stated above,
1880     and you may publicly display copies.
1881
1882  3. COPYING IN QUANTITY
1883
1884     If you publish printed copies (or copies in media that commonly
1885     have printed covers) of the Document, numbering more than 100, and
1886     the Document's license notice requires Cover Texts, you must
1887     enclose the copies in covers that carry, clearly and legibly, all
1888     these Cover Texts: Front-Cover Texts on the front cover, and
1889     Back-Cover Texts on the back cover.  Both covers must also clearly
1890     and legibly identify you as the publisher of these copies.  The
1891     front cover must present the full title with all words of the
1892     title equally prominent and visible.  You may add other material
1893     on the covers in addition.  Copying with changes limited to the
1894     covers, as long as they preserve the title of the Document and
1895     satisfy these conditions, can be treated as verbatim copying in
1896     other respects.
1897
1898     If the required texts for either cover are too voluminous to fit
1899     legibly, you should put the first ones listed (as many as fit
1900     reasonably) on the actual cover, and continue the rest onto
1901     adjacent pages.
1902
1903     If you publish or distribute Opaque copies of the Document
1904     numbering more than 100, you must either include a
1905     machine-readable Transparent copy along with each Opaque copy, or
1906     state in or with each Opaque copy a computer-network location from
1907     which the general network-using public has access to download
1908     using public-standard network protocols a complete Transparent
1909     copy of the Document, free of added material.  If you use the
1910     latter option, you must take reasonably prudent steps, when you
1911     begin distribution of Opaque copies in quantity, to ensure that
1912     this Transparent copy will remain thus accessible at the stated
1913     location until at least one year after the last time you
1914     distribute an Opaque copy (directly or through your agents or
1915     retailers) of that edition to the public.
1916
1917     It is requested, but not required, that you contact the authors of
1918     the Document well before redistributing any large number of
1919     copies, to give them a chance to provide you with an updated
1920     version of the Document.
1921
1922  4. MODIFICATIONS
1923
1924     You may copy and distribute a Modified Version of the Document
1925     under the conditions of sections 2 and 3 above, provided that you
1926     release the Modified Version under precisely this License, with
1927     the Modified Version filling the role of the Document, thus
1928     licensing distribution and modification of the Modified Version to
1929     whoever possesses a copy of it.  In addition, you must do these
1930     things in the Modified Version:
1931
1932       A. Use in the Title Page (and on the covers, if any) a title
1933          distinct from that of the Document, and from those of
1934          previous versions (which should, if there were any, be listed
1935          in the History section of the Document).  You may use the
1936          same title as a previous version if the original publisher of
1937          that version gives permission.
1938
1939       B. List on the Title Page, as authors, one or more persons or
1940          entities responsible for authorship of the modifications in
1941          the Modified Version, together with at least five of the
1942          principal authors of the Document (all of its principal
1943          authors, if it has fewer than five), unless they release you
1944          from this requirement.
1945
1946       C. State on the Title page the name of the publisher of the
1947          Modified Version, as the publisher.
1948
1949       D. Preserve all the copyright notices of the Document.
1950
1951       E. Add an appropriate copyright notice for your modifications
1952          adjacent to the other copyright notices.
1953
1954       F. Include, immediately after the copyright notices, a license
1955          notice giving the public permission to use the Modified
1956          Version under the terms of this License, in the form shown in
1957          the Addendum below.
1958
1959       G. Preserve in that license notice the full lists of Invariant
1960          Sections and required Cover Texts given in the Document's
1961          license notice.
1962
1963       H. Include an unaltered copy of this License.
1964
1965       I. Preserve the section Entitled "History", Preserve its Title,
1966          and add to it an item stating at least the title, year, new
1967          authors, and publisher of the Modified Version as given on
1968          the Title Page.  If there is no section Entitled "History" in
1969          the Document, create one stating the title, year, authors,
1970          and publisher of the Document as given on its Title Page,
1971          then add an item describing the Modified Version as stated in
1972          the previous sentence.
1973
1974       J. Preserve the network location, if any, given in the Document
1975          for public access to a Transparent copy of the Document, and
1976          likewise the network locations given in the Document for
1977          previous versions it was based on.  These may be placed in
1978          the "History" section.  You may omit a network location for a
1979          work that was published at least four years before the
1980          Document itself, or if the original publisher of the version
1981          it refers to gives permission.
1982
1983       K. For any section Entitled "Acknowledgements" or "Dedications",
1984          Preserve the Title of the section, and preserve in the
1985          section all the substance and tone of each of the contributor
1986          acknowledgements and/or dedications given therein.
1987
1988       L. Preserve all the Invariant Sections of the Document,
1989          unaltered in their text and in their titles.  Section numbers
1990          or the equivalent are not considered part of the section
1991          titles.
1992
1993       M. Delete any section Entitled "Endorsements".  Such a section
1994          may not be included in the Modified Version.
1995
1996       N. Do not retitle any existing section to be Entitled
1997          "Endorsements" or to conflict in title with any Invariant
1998          Section.
1999
2000       O. Preserve any Warranty Disclaimers.
2001
2002     If the Modified Version includes new front-matter sections or
2003     appendices that qualify as Secondary Sections and contain no
2004     material copied from the Document, you may at your option
2005     designate some or all of these sections as invariant.  To do this,
2006     add their titles to the list of Invariant Sections in the Modified
2007     Version's license notice.  These titles must be distinct from any
2008     other section titles.
2009
2010     You may add a section Entitled "Endorsements", provided it contains
2011     nothing but endorsements of your Modified Version by various
2012     parties--for example, statements of peer review or that the text
2013     has been approved by an organization as the authoritative
2014     definition of a standard.
2015
2016     You may add a passage of up to five words as a Front-Cover Text,
2017     and a passage of up to 25 words as a Back-Cover Text, to the end
2018     of the list of Cover Texts in the Modified Version.  Only one
2019     passage of Front-Cover Text and one of Back-Cover Text may be
2020     added by (or through arrangements made by) any one entity.  If the
2021     Document already includes a cover text for the same cover,
2022     previously added by you or by arrangement made by the same entity
2023     you are acting on behalf of, you may not add another; but you may
2024     replace the old one, on explicit permission from the previous
2025     publisher that added the old one.
2026
2027     The author(s) and publisher(s) of the Document do not by this
2028     License give permission to use their names for publicity for or to
2029     assert or imply endorsement of any Modified Version.
2030
2031  5. COMBINING DOCUMENTS
2032
2033     You may combine the Document with other documents released under
2034     this License, under the terms defined in section 4 above for
2035     modified versions, provided that you include in the combination
2036     all of the Invariant Sections of all of the original documents,
2037     unmodified, and list them all as Invariant Sections of your
2038     combined work in its license notice, and that you preserve all
2039     their Warranty Disclaimers.
2040
2041     The combined work need only contain one copy of this License, and
2042     multiple identical Invariant Sections may be replaced with a single
2043     copy.  If there are multiple Invariant Sections with the same name
2044     but different contents, make the title of each such section unique
2045     by adding at the end of it, in parentheses, the name of the
2046     original author or publisher of that section if known, or else a
2047     unique number.  Make the same adjustment to the section titles in
2048     the list of Invariant Sections in the license notice of the
2049     combined work.
2050
2051     In the combination, you must combine any sections Entitled
2052     "History" in the various original documents, forming one section
2053     Entitled "History"; likewise combine any sections Entitled
2054     "Acknowledgements", and any sections Entitled "Dedications".  You
2055     must delete all sections Entitled "Endorsements."
2056
2057  6. COLLECTIONS OF DOCUMENTS
2058
2059     You may make a collection consisting of the Document and other
2060     documents released under this License, and replace the individual
2061     copies of this License in the various documents with a single copy
2062     that is included in the collection, provided that you follow the
2063     rules of this License for verbatim copying of each of the
2064     documents in all other respects.
2065
2066     You may extract a single document from such a collection, and
2067     distribute it individually under this License, provided you insert
2068     a copy of this License into the extracted document, and follow
2069     this License in all other respects regarding verbatim copying of
2070     that document.
2071
2072  7. AGGREGATION WITH INDEPENDENT WORKS
2073
2074     A compilation of the Document or its derivatives with other
2075     separate and independent documents or works, in or on a volume of
2076     a storage or distribution medium, is called an "aggregate" if the
2077     copyright resulting from the compilation is not used to limit the
2078     legal rights of the compilation's users beyond what the individual
2079     works permit.  When the Document is included in an aggregate, this
2080     License does not apply to the other works in the aggregate which
2081     are not themselves derivative works of the Document.
2082
2083     If the Cover Text requirement of section 3 is applicable to these
2084     copies of the Document, then if the Document is less than one half
2085     of the entire aggregate, the Document's Cover Texts may be placed
2086     on covers that bracket the Document within the aggregate, or the
2087     electronic equivalent of covers if the Document is in electronic
2088     form.  Otherwise they must appear on printed covers that bracket
2089     the whole aggregate.
2090
2091  8. TRANSLATION
2092
2093     Translation is considered a kind of modification, so you may
2094     distribute translations of the Document under the terms of section
2095     4.  Replacing Invariant Sections with translations requires special
2096     permission from their copyright holders, but you may include
2097     translations of some or all Invariant Sections in addition to the
2098     original versions of these Invariant Sections.  You may include a
2099     translation of this License, and all the license notices in the
2100     Document, and any Warranty Disclaimers, provided that you also
2101     include the original English version of this License and the
2102     original versions of those notices and disclaimers.  In case of a
2103     disagreement between the translation and the original version of
2104     this License or a notice or disclaimer, the original version will
2105     prevail.
2106
2107     If a section in the Document is Entitled "Acknowledgements",
2108     "Dedications", or "History", the requirement (section 4) to
2109     Preserve its Title (section 1) will typically require changing the
2110     actual title.
2111
2112  9. TERMINATION
2113
2114     You may not copy, modify, sublicense, or distribute the Document
2115     except as expressly provided under this License.  Any attempt
2116     otherwise to copy, modify, sublicense, or distribute it is void,
2117     and will automatically terminate your rights under this License.
2118
2119     However, if you cease all violation of this License, then your
2120     license from a particular copyright holder is reinstated (a)
2121     provisionally, unless and until the copyright holder explicitly
2122     and finally terminates your license, and (b) permanently, if the
2123     copyright holder fails to notify you of the violation by some
2124     reasonable means prior to 60 days after the cessation.
2125
2126     Moreover, your license from a particular copyright holder is
2127     reinstated permanently if the copyright holder notifies you of the
2128     violation by some reasonable means, this is the first time you have
2129     received notice of violation of this License (for any work) from
2130     that copyright holder, and you cure the violation prior to 30 days
2131     after your receipt of the notice.
2132
2133     Termination of your rights under this section does not terminate
2134     the licenses of parties who have received copies or rights from
2135     you under this License.  If your rights have been terminated and
2136     not permanently reinstated, receipt of a copy of some or all of
2137     the same material does not give you any rights to use it.
2138
2139 10. FUTURE REVISIONS OF THIS LICENSE
2140
2141     The Free Software Foundation may publish new, revised versions of
2142     the GNU Free Documentation License from time to time.  Such new
2143     versions will be similar in spirit to the present version, but may
2144     differ in detail to address new problems or concerns.  See
2145     `http://www.gnu.org/copyleft/'.
2146
2147     Each version of the License is given a distinguishing version
2148     number.  If the Document specifies that a particular numbered
2149     version of this License "or any later version" applies to it, you
2150     have the option of following the terms and conditions either of
2151     that specified version or of any later version that has been
2152     published (not as a draft) by the Free Software Foundation.  If
2153     the Document does not specify a version number of this License,
2154     you may choose any version ever published (not as a draft) by the
2155     Free Software Foundation.  If the Document specifies that a proxy
2156     can decide which future versions of this License can be used, that
2157     proxy's public statement of acceptance of a version permanently
2158     authorizes you to choose that version for the Document.
2159
2160 11. RELICENSING
2161
2162     "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
2163     World Wide Web server that publishes copyrightable works and also
2164     provides prominent facilities for anybody to edit those works.  A
2165     public wiki that anybody can edit is an example of such a server.
2166     A "Massive Multiauthor Collaboration" (or "MMC") contained in the
2167     site means any set of copyrightable works thus published on the MMC
2168     site.
2169
2170     "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
2171     license published by Creative Commons Corporation, a not-for-profit
2172     corporation with a principal place of business in San Francisco,
2173     California, as well as future copyleft versions of that license
2174     published by that same organization.
2175
2176     "Incorporate" means to publish or republish a Document, in whole or
2177     in part, as part of another Document.
2178
2179     An MMC is "eligible for relicensing" if it is licensed under this
2180     License, and if all works that were first published under this
2181     License somewhere other than this MMC, and subsequently
2182     incorporated in whole or in part into the MMC, (1) had no cover
2183     texts or invariant sections, and (2) were thus incorporated prior
2184     to November 1, 2008.
2185
2186     The operator of an MMC Site may republish an MMC contained in the
2187     site under CC-BY-SA on the same site at any time before August 1,
2188     2009, provided the MMC is eligible for relicensing.
2189
2190
2191ADDENDUM: How to use this License for your documents
2192====================================================
2193
2194To use this License in a document you have written, include a copy of
2195the License in the document and put the following copyright and license
2196notices just after the title page:
2197
2198      Copyright (C)  YEAR  YOUR NAME.
2199      Permission is granted to copy, distribute and/or modify this document
2200      under the terms of the GNU Free Documentation License, Version 1.3
2201      or any later version published by the Free Software Foundation;
2202      with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
2203      Texts.  A copy of the license is included in the section entitled ``GNU
2204      Free Documentation License''.
2205
2206   If you have Invariant Sections, Front-Cover Texts and Back-Cover
2207Texts, replace the "with...Texts." line with this:
2208
2209        with the Invariant Sections being LIST THEIR TITLES, with
2210        the Front-Cover Texts being LIST, and with the Back-Cover Texts
2211        being LIST.
2212
2213   If you have Invariant Sections without Cover Texts, or some other
2214combination of the three, merge those two alternatives to suit the
2215situation.
2216
2217   If your document contains nontrivial examples of program code, we
2218recommend releasing these examples in parallel under your choice of
2219free software license, such as the GNU General Public License, to
2220permit their use in free software.
2221
2222
2223
2224Tag Table:
2225Node: Top1124
2226Node: Introduction2097
2227Node: Basic3498
2228Node: shar Invocation4779
2229Node: shar usage6904
2230Node: shar compression12936
2231Ref: shar intermix-type13181
2232Ref: shar compactor13628
2233Ref: shar level-of-compression14519
2234Ref: shar bzip214861
2235Ref: shar gzip15210
2236Ref: shar compress15568
2237Ref: shar level-for-gzip16014
2238Ref: shar bits-per-code16206
2239Node: shar encoding16546
2240Ref: shar mixed-uuencode17056
2241Ref: shar uuencode18148
2242Ref: shar text-files18530
2243Node: shar in-out18893
2244Ref: shar output-prefix19145
2245Ref: shar whole-size-limit19750
2246Ref: shar split-size-limit20537
2247Ref: shar input-file-list21372
2248Ref: shar stdin-file-list22278
2249Node: shar headers22454
2250Ref: shar archive-name22697
2251Ref: shar submitter22953
2252Ref: shar net-headers23239
2253Ref: shar cut-mark24016
2254Ref: shar translate24187
2255Node: shar xmit-defenses24649
2256Ref: shar no-character-count24922
2257Ref: shar no-md5-digest25110
2258Ref: shar force-prefix25309
2259Ref: shar here-delimiter25632
2260Node: shar shar-flavors25928
2261Ref: shar vanilla-operation26216
2262Ref: shar no-piping26669
2263Ref: shar no-check-existing27009
2264Ref: shar query-user27513
2265Ref: shar no-timestamp28802
2266Ref: shar quiet-unshar29267
2267Ref: shar basename29466
2268Node: shar internationalization29863
2269Ref: shar no-i18n30126
2270Ref: shar print-text-domain-dir30608
2271Node: shar feedback30774
2272Ref: shar quiet31012
2273Ref: shar silent31122
2274Node: shar config31214
2275Node: shar exit status33522
2276Node: shar Authors34365
2277Node: shar Bugs34776
2278Node: shar Examples35018
2279Node: shar Warnings35660
2280Node: shar See Also37104
2281Node: unshar Invocation37248
2282Node: unshar usage38512
2283Node: unshar directory40845
2284Node: unshar overwrite41322
2285Node: unshar force41722
2286Node: unshar split-at41995
2287Node: unshar exit-042838
2288Node: unshar debug43333
2289Node: unshar config43601
2290Node: unshar exit status45920
2291Node: unshar Authors46799
2292Node: unshar Bugs47222
2293Node: unshar See Also47476
2294Node: uuencode Invocation47624
2295Node: uuencode usage49329
2296Node: uuencode base6451772
2297Node: uuencode encode-file-name52253
2298Node: uuencode config52739
2299Node: uuencode exit status55085
2300Node: uuencode Bugs55673
2301Node: uuencode Standards55942
2302Node: uuencode History56170
2303Node: uuencode See Also56396
2304Node: uudecode Invocation56572
2305Node: uudecode usage58469
2306Node: uudecode output-file61166
2307Node: uudecode ignore-chmod61667
2308Node: uudecode config62398
2309Node: uudecode exit status64740
2310Node: uudecode Bugs65775
2311Node: uudecode Standards66337
2312Node: uudecode See Also66566
2313Node: GNU Free Documentation License66744
2314
2315End Tag Table
2316