File: arc.1

package info (click to toggle)
arc 5.21q-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 412 kB
  • ctags: 311
  • sloc: ansic: 4,124; makefile: 86
file content (213 lines) | stat: -rw-r--r-- 7,282 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
.TH ARC 1 "11 Nov 1991" "Howard Chu@JPL" "LOCAL COMMANDS"
.SH NAME
arc \- pc archive utility
.SH SYNOPSIS
.B arc
a|m|u|f|d|x|e|r|p|l|v|t|c [ biswnoq ] [ g\fIpassword\fR ]
.I archive 
[ \fIfilename\fR ...]
.SH DESCRIPTION
.I Arc
is a general archive and file compression utility, used to maintain
a compressed archive of files.
An
.I archive
is a single file that combines many files, reducing storage space
and allowing multiple files to be handled as one.
.I Arc
uses one of several compression methods for each file within the
.IR archive ,
based on whichever method yields the smallest result.
.SH INSTRUCTIONS
Execute
.I arc
with no arguments for fairly verbose, usable instructions.
.SH COMMAND SWITCHES
.TP 3
a
add files to archive.  Copies the indicated files to the archive.
.TP
m
move files to archive.  Same as 'a' switch except
that the files are deleted from the directory as
they are moved to the archive.
.TP
u
update files in archive.  This switch will replace archived
files when the named file is newer than the archived copy.
New files will be added automatically.
.TP
f
freshen files in archive.  Same as 'u' except that
new files will not be added.
.TP
d
delete files in archive.  The named files are removed from the archive.
.TP
x,e
extract files from archive.  The named files are extracted
from the archive and created in the current directory
in an uncompressed state.
.TP
r
run one file with arguments from archive.  Any
program may be executed directly from the archive.
The parameters given after the program name are passed to
the program without modification.
.TP
p
copy files from archive to standard output.  Useful
with I/O redirection. A form-feed is appended after each file,
to ease use with printers.
.TP
l
list files in archive.  Limited information listing
of files contained in an archive.  Displays the
filename, original length, and date last modified.
If the 'n' option (see below) is used, only the
filename is displayed.
.TP
v
verbose listing of files in archive.  Complete
information listing of files contained in an archive.
Displays the filename, original length, storage method,
storage factor (% savings), compressed size, date, time,
and CRC.
.TP
t
test archive integrity.  Computes CRC values for each member of
the archive and compares against the previously saved value.
.TP
c
convert entry to new packing method.  Convert files
stored with older methods to newer methods that are
more efficient. Also useful for files previously
archived with the 's' option.
.SH OPTIONS
.TP 3
b
retain backup copy of archive.  Keep the original
archive file and rename to .BAK.
This switch may be used with the
following commands:  a, m, u, f, d, c.
.TP
i
suppress image mode.  This switch causes files to
be treated as text files, and will translate their
end-of-line sequence. (Unix's '\\n' vs. '\\r\\n' used
on many other systems.)  The default is to perform
no translation when compressing or extracting files.
This option makes dealing with text files much nicer,
though the 'tr' command can also be used. ('\\r' in
makefiles and C source code is such a nuisance...)
.TP
s
suppress compression.  This forces new files to be
saved using Method 2 (no compression).  This switch
may be used with the following commands:  a, m, u, f, c.
.TP
w
suppress warning messages.  This switch will keep
warning messages from being displayed which is the default.
Most warnings concern the deletion or existence of
files with the same name.
.TP
n
suppress notes and comments.  This switch will keep
useful notes from being displayed which is the default.
Most notes indicate what stage of compression is
being run (analyze, compaction, storage).
.TP
o
overwrite existing files when extracting.  This switch
will make existing files silently get overwritten, instead
of asking for confirmation, which is the default.
.TP
q
force Squash compression method.  This switch causes
the Squash compression method to be used, instead of
Crunch, which is the default.
.TP
g
encrypt/decrypt archive entry.  This is used to encode
files so that others may not read them.  BE CAREFUL!
This must be the last parameter in the switches because
everything following is part of the password.
.SH PROGRAMMING NOTES
.I Arc
Version 2 differs from version 1 in that archive entries
are automatically compressed when they are added to the archive,
making a separate compression step unnecessary.  The nature of the
compression is indicated by the header version number placed in
each archive entry, as follows:
.nf
         1 = Old style, no compression
         2 = New style, no compression
         3 = Compression of repeated characters only
         4 = Compression of repeated characters plus Huffman SQueezing
         5 = Lempel-Zev packing of repeated strings (old style)
         6 = Lempel-Zev packing of repeated strings (new style)
         7 = Lempel-Zev Williams packing with improved hash function
         8 = Dynamic Lempel-Zev packing with adaptive reset
         9 = Squashing
.fi

Type 5, Lempel-Zev packing, was added as of version 4.0

Type 6 is Lempel-Zev packing where runs of repeated characters
have been collapsed, and was added as of version 4.1

Type 7 is a variation of Lempel-Zev using a different hash
function which yields speed improvements of 20-25%, and was
added as of version 4.6

Type 8 is a different implementation of Lempel-Zev, using a
variable code size and an adaptive block reset, and was added
as of version 5.0

Type 9 is another variation of Lempel-Zev, using a larger
hash table. This method was developed by Phil Katz, and is
not supported by the "official" \fBARC\fP programs.

.I Arc
will look for environment variables named \fIARCTEMP\fP or
\fITMPDIR\fP, which, if present, indicates the pathname
where temporary files should be created. This is typically
the location of a RAMdisk on a microcomputer, "/tmp/" or
left unset.

See the included documentation file for more details.
.SH HISTORY
\fIArc\fP has been in use in the CP/M and MSDOS world for many years.
Thom Henderson developed the original version, but it is important to note that
\fIarc\fP is based on the file compression theories developed by Huffman, Welch,
Knott, Knuth, and many other scientists. This implementation is based on
version 5.21 of the MSDOS program.
.SH BUGS
\fIArc\fP behaves just like the PC version of the program; all functions
of the "usage" display are working.
Full compatibility with PC ARC files is maintained, the price for which is
that \fIarc\fP doesn't like long filenames, and can only archive files with
names of up to 12 characters.
It will *sometimes* do The Right Thing with them, but I suggest
you put long-winded filenames in a "shar" before
.IR arc ing
them.

There shouldn't be any problems, (hah!) but if you find any, please
send them to me at:

	hyc@hanauma.jpl.nasa.gov

.SH AUTHORS
Original MSDOS program by Thom Henderson
.br
COPYRIGHT(C) 1985-87 by System Enhancement Associates.
You may copy and distribute this program freely,
under the terms of the General Public License.

Original Lempel-Zev code derived from compress 4.0.
Modified to support Squashing by Dan Lanciani (ddl@harvard.edu)
Ported from MSDOS by Howard Chu,
with help from John Gilmore (hoptoad!gnu), James Turner (daisy!turner)
and others.