1NULIB2(1L) NULIB2(1L)
2
6 nulib2 - package and compress (archive) files
7
9 nulib2 -command[modifiers] archive [ filenames ]
10
12 nulib2 is a disk and file archiver for NuFX (ShrinkIt) files. It can
13 add files to and extract files from .SHK, .BXY, .SEA (as created by
14 GS/ShrinkIt), and .BSE files. In addition, it can extract files from
15 .BNY and .BQY Binary II archives.
16 When extracting, testing, or listing the contents of an archive, you
18 can specify "-" for the archive name. The archive will be read from
19 stdin. (If the archive is Binary II, you must specify the "-b" flag.)
20 Filenames are considered case-sensitive.
22 This man page contains a summary of available options. For full docu‐
24 mentation and the latest versions, visit http://www.nulib.com/.
25
27 -h Get verbose help output.
28 -a Add files to an archive. If the archive does not exist, a new
30 one will be created. The list of files to add must be given.
31 -d Delete files from an archive. The set of files to delete must
33 be provided.
34 -i Integrity test. If no files are listed, all files in the ar‐
36 chive are tested.
37 -p Pipe extraction. All extracted files are written to stdout
39 instead of a file on disk. Normal archive progress messages are
40 suppressed.
41 -t Table of contents. Provides a simple list of files in the ar‐
43 chive, one per line.
44 -v Verbose table of contents. Output similar to what ShrinkIt dis‐
46 plays is shown.
47 -x Extract files from an archive. If no files are listed, all
49 files in the archive are extracted.
50
52 -c Comments. When extracting, comments will be displayed. When
53 adding, you will be prompted to enter a one-line comment for
54 every file.
55 -e Preserve ProDOS file types. See the ProDOS File Type Preserva‐
57 tion document on http://www.nulib.com/ for details on how this
58 works.
59 -ee Preserve file types, using extended names. A file extension is
61 appended to extracted files. Useful on operating systems like
62 Windows, where filename extensions are important. When adding
63 files, nulib2 will try to guess at correct file types by examin‐
64 ing the filename extension.
65 -f Freshen files. When adding, files in the archive that are older
67 than files on disk are "freshened", meaning that no new files
68 are added, and files that are the same age or newer aren't
69 touched. Works similarly when extracting.
70 -j Junk directory names. Only the filename is kept; the rest of
72 the pathname is thrown away. Empty directories aren't stored.
73 Works when adding or extracting.
74 -k Store files as disk images. Files that are a multiple of 512
76 bytes will be added as disk images rather than normal files.
77 This does not override the "-e" flag.
78 -l Auto-convert text files. A reasonably smart algorithm is used
80 to identify which files are text and which aren't during extrac‐
81 tion. It then converts whatever EOL indicator is being used by
82 the text file into something appropriate for the current system.
83 -ll Auto-convert all files. All files being extracted are consid‐
85 ered text, and will be converted. Don't use this unless you're
86 sure you need it.
87 -r Recurse into subdirectories. When adding, this causes nulib2 to
89 descend into subdirectories and store all of the files found.
90 When extracting, testing, or deleting, this causes the files
91 listed to match against all records whose prefix matches, allow‐
92 ing you to extract, test, or delete entire subdirectories from
93 the archive.
94 -u Update files. When adding, files in the archive that are older
96 than files on disk are updated. Files in the archive that are
97 the same age or newer aren't touched. New files will be added.
98 Works similarly when extracting.
99 -b Binary II. Forces NuLib2 to treat the archive as Binary II.
101 Useful for opening NuFX-in-BNY archives (.BXY) if you want to
102 strip the wrapper off. You must specify this for Binary II ar‐
103 chives on stdin.
104 -0 Don't use compression. Files added will be stored without com‐
106 pression. (Note that's dash-zero, not dash-oh.)
107 -z Use "deflate" compression. This option is only available if
109 libz was linked against. Archives created with this algorithm
110 will not be usable on an Apple II.
111 -zz Use "bzip2" compression. This option is only available if
113 libbz2 was linked against. Archives created with this algorithm
114 will not be usable on an Apple II.
115
117 A simple example:
118 nulib2 a foo.shk *
120 creates the archive foo.shk (assuming it doesn't exist) and stores all
122 of the files in the current directory in it, in compressed form.
123 If you wanted to add all the files in the current directory, as well as
125 all files in all subdirectories, you could use:
126 nulib2 ar foo.shk *
128 to recursively descend into the directory tree.
130 Using the command:
132 nulib2 xe foo.shk
134 would extract all files from foo.shk, preserving ProDOS file types. If
136 you then used the command:
137 nulib2 aer foo.shk *
139 you would add the files, preserving the file types of anything that was
141 extracted with the "-e" flag set.
142 A handy way to look at text documents is to use:
144 nulib2 xeel foo.shk
146 to convert end-of-line terminators (e.g. CRLF to LF) as the files are
148 being extracted. The "-ee" flag adds ".TXT" to all files with a ProDOS
149 file type of TXT ($04).
150
152 compress(1), tar(1), zip(1L), unzip(1L), nulib(1L)
153
155 Nah.
156
158 Copyright (C) 2007 by Andy McFadden. All Rights Reserved.
159 08 Feb 2003 NULIB2(1L)