Add missing break
[debian-nspark.git] / man / nspark.1
blob58bca878d87d34f4bb4b58e37d465844536a1867
1 .TH NSPARK 1 "\*(V)" "USER COMMANDS"
2 .SH NAME
3 nspark \- unpack Archimedes archives
4 .SH SYNOPSIS
5 .B nspark
7 .B options
9 archive
11 .B file ...
13 .SH DESCRIPTION
14 The current version of
15 .B nspark
16 is 1.7.8
18 .B Nspark
19 can unpack the specified Archimedes-format
20 .B archive,
21 list its contents or tests its integrity.
23 Nspark's main features are:
25 o Supports all archive methods used by !Spark 1 and 2. The old
26 version didn't support "Squashing" and used to handle "Compressed"
27 archives by using the UNIX uncompress program. The new version
28 supports both these and has them built-in, allowing easier
29 porting to other OS's.
31 o Supports ArcFS format archives.
33 o Supports Cyclic Redundancy Checking (CRC). The integrity of an
34 archive can now be checked without having to unarchive it.
36 o Supports verbose option to allow archive file details to be
37 displayed (time/date or exec/load address, size, type).
39 o Supports selective file unarchiving, so the whole archive needn't
40 be unarchived if not all the files are wanted).
42 o Supports user-prompting before overwriting a file, allowing the
43 user to either (1) overwrite the file, (2) overwrite all the
44 files, (3) unarchive the file to a different name, or (4) not to
45 unarchive the file at all.
47 o Supports file-stamping so the date and time of the file, when
48 unarchived, matches the date and time it was archived (not 4.2BSD
49 or SysV.2 as these systems lack vital library functions).
51 I have not included support for creating !Spark archives, and I am not
52 really sure if I need to as: (1) !Spark for RISC OS is cheap (#5.99
53 from David Pilling), (2) !SparkPlug can unpack archives created with
54 zip (which is available in source form for UNIX, VMS and MSDOS), and
55 (3) it's a lot of work. Let me know what you think.
57 .I Options:
58 .IP "-x" 10
59 Extract the given
60 .B file,
61 or all files if none are specified.
62 .IP "-u" 10
63 Equivalent to -x.
64 .IP "-t" 10
65 Test archive integrity by simulating extraction and checking the CRCs (Cyclic
66 Redundancy Checks).
67 .IP "-l" 10
68 List archive contents.
69 .IP "-q" 10
70 Quiet.  Displays less information when listing, testing or extracting.
71 .IP "-f" 10
72 Force file overwrite if a file already exists with the same name as the one
73 being extracted. If not using -f then you are prompted whether you want to
74 overwrite the original, skip this file, give it a different name, or overwrite
75 this and all others that already exist.
76 .IP "-s" 10
77 No filestamp. Does not set the timestamp when extracting files.
78 .IP "-v" 10
79 Verbose.  Gives full details when listing or extracting archives.
80 .IP "-p<pass>" 10
81 Password.  Specifies the password used to garble the archive.
82 .IP "-R" 10
83 Retry if archive is corrupt.  If a bad header is found then nspark will
84 search the archive until another header if found, rather than giving up.
85 .IP "-L<name>" 10
86 Set name of log file to
87 .B name.
88 .IP "-T" 10
89 Append file type to name, in the same way as Tar or NFS.  For example
90 Text files (filetype &FFF) have ,fff appended when extracted.
91 .IP "-C" 10
92 Create lowercase filenames.  Useful on machines where the case of filenames
93 is significant (eg. UNIX), this option forces all extracted filenames to be
94 lowercase.
95 .IP "-V" 10
96 Display version number.
97 .SH BUGS
98 The DOS version does not time/date stamp directories.
99 .SH NOTES
100 .B Nspark
101 is in the public domain.
102 It is currently being maintained by James Woodcock (james_woodcock@yahoo.co.uk).
103 .SH SEE ALSO
104 arcfs(5), spark(5).
105 .SH AUTHOR
106 Andy Duplain, BT Customer Systems, Brighton, UK.  (duplain@btcs.bt.co.uk)
107 .SH CONTRIBUTORS
108 Improvements from version 1.5, including ArcFS support, by Andrew Brooks (arb@compl.ancs.ac.uk).
110 Manual pages originally supplied by Duncan (m91dps@ecs.oxford.ac.uk).
112 Suggestions for improvement by Tom Tromey (tromey@busco.lanl.gov).
114 Windows NT support by Alun Jones (auj@aber.ac.uk).
116 Previously maintained by arb (arb@comp.lancs.ac.uk).