Add missing break
[debian-nspark.git] / man / nspark1.txt
blobbe1730f6da34824f3074994c8f66e3fa236d96f8
1 NSPARK(1)                                                            NSPARK(1)
5 N\bNA\bAM\bME\bE
6        nspark - unpack Archimedes archives
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        n\bns\bsp\bpa\bar\brk\bk [ o\bop\bpt\bti\bio\bon\bns\bs ] archive [ f\bfi\bil\ble\be .\b..\b..\b.  ]
11 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
12        The current version of n\bns\bsp\bpa\bar\brk\bk is 1.7.8
14        N\bNs\bsp\bpa\bar\brk\bk  can  unpack  the  specified Archimedes-format a\bar\brc\bch\bhi\biv\bve\be,\b, list its
15        contents or tests its integrity.
17        Nspark's main features are:
19        o Supports all archive methods used by !Spark 1 and 2. The old  version
20        didn't  support "Squashing" and used to handle "Compressed" archives by
21        using the UNIX uncompress program. The new version supports both  these
22        and has them built-in, allowing easier porting to other OS's.
24        o Supports ArcFS format archives.
26        o  Supports  Cyclic  Redundancy  Checking  (CRC).  The  integrity of an
27        archive can now be checked without having to unarchive it.
29        o Supports verbose option to allow archive file details to be displayed
30        (time/date or exec/load address, size, type).
32        o  Supports selective file unarchiving, so the whole archive needn't be
33        unarchived if not all the files are wanted).
35        o Supports user-prompting before overwriting a file, allowing the  user
36        to  either  (1)  overwrite  the  file, (2) overwrite all the files, (3)
37        unarchive the file to a different name, or (4)  not  to  unarchive  the
38        file at all.
40        o  Supports  file-stamping so the date and time of the file, when unar-
41        chived, matches the date and time it was archived (not 4.2BSD or SysV.2
42        as these systems lack vital library functions).
44        I  have not included support for creating !Spark archives, and I am not
45        really sure if I need to as: (1) !Spark for RISC  OS  is  cheap  (#5.99
46        from  David  Pilling),  (2) !SparkPlug can unpack archives created with
47        zip (which is available in source form for UNIX, VMS  and  MSDOS),  and
48        (3) it's a lot of work. Let me know what you think.
50        _\bO_\bp_\bt_\bi_\bo_\bn_\bs_\b:
52        -x        Extract the given f\bfi\bil\ble\be,\b, or all files if none are specified.
54        -u        Equivalent to -x.
56        -t        Test  archive integrity by simulating extraction and checking
57                  the CRCs (Cyclic Redundancy Checks).
59        -l        List archive contents.
61        -q        Quiet.  Displays less information when  listing,  testing  or
62                  extracting.
64        -f        Force  file  overwrite if a file already exists with the same
65                  name as the one being extracted. If not using -f then you are
66                  prompted  whether  you  want  to overwrite the original, skip
67                  this file, give it a different name, or  overwrite  this  and
68                  all others that already exist.
70        -s        No  filestamp.  Does  not  set  the timestamp when extracting
71                  files.
73        -v        Verbose.  Gives  full  details  when  listing  or  extracting
74                  archives.
76        -p<pass>  Password.  Specifies the password used to garble the archive.
78        -R        Retry if archive is corrupt.  If a bad header is  found  then
79                  nspark will search the archive until another header if found,
80                  rather than giving up.
82        -L<name>  Set name of log file to n\bna\bam\bme\be.\b.
84        -T        Append file type to name, in the same way as Tar or NFS.  For
85                  example  Text  files  (filetype &FFF) have ,fff appended when
86                  extracted.
88        -C        Create lowercase filenames.  Useful  on  machines  where  the
89                  case  of  filenames  is  significant  (eg. UNIX), this option
90                  forces all extracted filenames to be lowercase.
92        -V        Display version number.
94 B\bBU\bUG\bGS\bS
95        The DOS version does not time/date stamp directories.
97 N\bNO\bOT\bTE\bES\bS
98        N\bNs\bsp\bpa\bar\brk\bk is in the public domain.  It is currently  being  maintained  by
99        James Woodcock (james_woodcock@yahoo.co.uk).
101 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
102        arcfs(5), spark(5).
104 A\bAU\bUT\bTH\bHO\bOR\bR
105        Andy     Duplain,     BT     Customer     Systems,     Brighton,    UK.
106        (duplain@btcs.bt.co.uk)
108 C\bCO\bON\bNT\bTR\bRI\bIB\bBU\bUT\bTO\bOR\bRS\bS
109        Improvements from version  1.5,  including  ArcFS  support,  by  Andrew
110        Brooks (arb@compl.ancs.ac.uk).
112        Manual pages originally supplied by Duncan (m91dps@ecs.oxford.ac.uk).
114        Suggestions for improvement by Tom Tromey (tromey@busco.lanl.gov).
116        Windows NT support by Alun Jones (auj@aber.ac.uk).
118        Previously maintained by arb (arb@comp.lancs.ac.uk).
122 USER COMMANDS                                                        NSPARK(1)