diff options
author | Petter Rodhelind <petter.rodhelind@gmail.com> | 2020-02-11 13:40:11 +0100 |
---|---|---|
committer | Petter Rodhelind <petter.rodhelind@gmail.com> | 2020-02-11 13:40:11 +0100 |
commit | 9c79e48c93c0c4d14aabcb490fab048d68934cb2 (patch) | |
tree | 1d57d3fd193621a2357473bb65b92190914c5736 /man | |
parent | 02d7aa8915f9c3a3288dab01f321eb94ba219e3b (diff) | |
parent | 0237dec768a4ee36ae9e18ce8566d2c999d78410 (diff) | |
download | plan9port-9c79e48c93c0c4d14aabcb490fab048d68934cb2.tar.gz plan9port-9c79e48c93c0c4d14aabcb490fab048d68934cb2.tar.bz2 plan9port-9c79e48c93c0c4d14aabcb490fab048d68934cb2.zip |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'man')
-rw-r--r-- | man/man1/9c.1 | 12 | ||||
-rw-r--r-- | man/man1/compress.1 | 237 | ||||
-rw-r--r-- | man/man1/install.1 | 23 | ||||
-rwxr-xr-x | man/man1/soelim.1 | 29 | ||||
-rw-r--r-- | man/man1/tar.1 | 1 | ||||
-rw-r--r-- | man/man1/winwatch.1 | 57 |
6 files changed, 334 insertions, 25 deletions
diff --git a/man/man1/9c.1 b/man/man1/9c.1 index fb04a296..8d24d67d 100644 --- a/man/man1/9c.1 +++ b/man/man1/9c.1 @@ -79,9 +79,7 @@ to the include path. .I 9c also defines .B __sun__ -on SunOS systems and -.B __Linux26__ -on Linux systems with 2.6-series kernels. +on SunOS systems. .PP .I 9a assembles the named files into object files for the current system. @@ -136,13 +134,13 @@ but always provides the following key characters: .TP .B d -Delete -.I files +Delete +.I files from the archive file. .TP .B r Replace -.I files +.I files in the archive file, or add them if missing. .TP .B t @@ -181,7 +179,7 @@ Normally will create a new archive when .I afile does not exist, and give a warning. -Option +Option .B c discards any old contents and suppresses the warning. .PD diff --git a/man/man1/compress.1 b/man/man1/compress.1 new file mode 100644 index 00000000..7dda3e18 --- /dev/null +++ b/man/man1/compress.1 @@ -0,0 +1,237 @@ +.TH COMPRESS 1 +.SH NAME +compress, uncompress, zcat \- compress and expand data +.SH SYNOPSIS +.B compress +[ +.B \-f +] [ +.B \-v +] [ +.B \-c +] [ +.B \-V +] [ +.B \-b +.I bits +] [ +.I "name \&..." +] +.PP +.B uncompress +[ +.B \-f +] [ +.B \-v +] [ +.B \-c +] [ +.B \-V +] [ +.I "name \&..." +] +.PP +.B zcat +[ +.B \-V +] [ +.I "name \&..." +] +.SH DESCRIPTION +.I Compress +reduces the size of the named files using adaptive Lempel-Ziv coding. +Whenever possible, +each file is replaced by one with the extension +.B "\&.Z," +while keeping the same ownership modes, access and modification times. +If no files are specified, the standard input is compressed to the +standard output. +Compressed files can be restored to their original form using +.I uncompress +or +.I zcat. +.PP +The +.B \-f +option will force compression of +.I name. +This is useful for compressing an entire directory, +even if some of the files do not actually shrink. +If +.B \-f +is not given and +.I compress +is run in the foreground, +the user is prompted as to whether an existing file should be overwritten. +.PP +The +.B \-c +option makes +.I compress/uncompress +write to the standard output; no files are changed. +The nondestructive behavior of +.I zcat +is identical to that of +.I uncompress +.B \-c. +.PP +.I Compress +uses the modified Lempel-Ziv algorithm popularized in +"A Technique for High Performance Data Compression", +Terry A. Welch, +.I "IEEE Computer," +vol. 17, no. 6 (June 1984), pp. 8-19. +Common substrings in the file are first replaced by 9-bit codes 257 and up. +When code 512 is reached, the algorithm switches to 10-bit codes and +continues to use more bits until the +limit specified by the +.B \-b +flag is reached (default 16). +.I Bits +must be between 9 and 16. The default can be changed in the source to allow +.I compress +to be run on a smaller machine. +.PP +After the +.I bits +limit is attained, +.I compress +periodically checks the compression ratio. If it is increasing, +.I compress +continues to use the existing code dictionary. However, +if the compression ratio decreases, +.I compress +discards the table of substrings and rebuilds it from scratch. This allows +the algorithm to adapt to the next "block" of the file. +.PP +Note that the +.B \-b +flag is omitted for +.I uncompress, +since the +.I bits +parameter specified during compression +is encoded within the output, along with +a magic number to ensure that neither decompression of random data nor +recompression of compressed data is attempted. +.PP +.ne 8 +The amount of compression obtained depends on the size of the +input, the number of +.I bits +per code, and the distribution of common substrings. +Typically, text such as source code or English +is reduced by 50\-60%. +Compression is generally much better than that achieved by +Huffman coding (as used in +.IR pack ), +or adaptive Huffman coding +.RI ( compact ), +and takes less time to compute. +.PP +Under the +.B \-v +option, +a message is printed yielding the percentage of +reduction for each file compressed. +.PP +If the +.B \-V +option is specified, the current version and compile options are printed on +stderr. +.PP +Exit status is normally 0; +if the last file is larger after (attempted) compression, the status is 2; +if an error occurs, exit status is 1. +.SH "SEE ALSO" +pack(1), compact(1) +.SH "DIAGNOSTICS" +Usage: compress [\-dfvcV] [\-b maxbits] [file ...] +.in +8 +Invalid options were specified on the command line. +.in -8 +Missing maxbits +.in +8 +Maxbits must follow +.BR \-b \. +.in -8 +.IR file : +not in compressed format +.in +8 +The file specified to +.I uncompress +has not been compressed. +.in -8 +.IR file : +compressed with +.I xx +bits, can only handle +.I yy +bits +.in +8 +.I File +was compressed by a program that could deal with +more +.I bits +than the compress code on this machine. +Recompress the file with smaller +.IR bits \. +.in -8 +.IR file : +already has .Z suffix -- no change +.in +8 +The file is assumed to be already compressed. +Rename the file and try again. +.in -8 +.IR file : +filename too long to tack on .Z +.in +8 +The file cannot be compressed because its name is longer than +12 characters. +Rename and try again. +This message does not occur on BSD systems. +.in -8 +.I file +already exists; do you wish to overwrite (y or n)? +.in +8 +Respond "y" if you want the output file to be replaced; "n" if not. +.in -8 +uncompress: corrupt input +.in +8 +A SIGSEGV violation was detected which usually means that the input file has +been corrupted. +.in -8 +Compression: +.I "xx.xx%" +.in +8 +Percentage of the input saved by compression. +(Relevant only for +.BR \-v \.) +.in -8 +-- not a regular file: unchanged +.in +8 +When the input file is not a regular file, +(e.g. a directory), it is +left unaltered. +.in -8 +-- has +.I xx +other links: unchanged +.in +8 +The input file has links; it is left unchanged. See +.IR ln "(1)" +for more information. +.in -8 +-- file unchanged +.in +8 +No savings is achieved by +compression. The input remains virgin. +.in -8 +.SH SOURCE +.B \*9/src/cmd/compress/compress.c +.SH "BUGS" +Although compressed files are compatible between machines with large memory, +.BR \-b \12 +should be used for file transfer to architectures with +a small process data space (64KB or less, as exhibited by the DEC PDP +series, the Intel 80286, etc.) diff --git a/man/man1/install.1 b/man/man1/install.1 index be35bd35..8fcc9e41 100644 --- a/man/man1/install.1 +++ b/man/man1/install.1 @@ -32,7 +32,7 @@ rebuilds and installs everything, and then cleans up. .PP There are a few files in tree which have the root hard-coded in them. -After the build, +After the build, .I INSTALL edits these files to replace the string .B /usr/local/plan9 @@ -71,31 +71,20 @@ expectations of certain package management systems. .PP At the end of the installation, .I INSTALL -prints suggested settings for the environment variables +prints suggested settings for the environment variables .B $PLAN9 and .BR $PATH . .PP -Plan 9 from User Space uses different threading implementations on Linux 2.6 and -later kernels than on 2.4 and earlier; -and on FreeBSD 5 and later kernels than on FreeBSD 4 and earlier. -Running binaries from one class on another will not work. -.PP -Some Linux 2.6 systems (e.g., Gentoo) do not use the new NPTL pthread library -even though the kernel supports them. On these systems, plan9port must -fall back on the threading code intended for Linux 2.4. To accomplish this, .I INSTALL -checks whether the running system uses NPTL and sets -.B SYSVERSION -in -.B \*9/config -accordingly. +writes various autodetected settings to +.BR \*9/config . The file .B \*9/LOCAL.config is appended to .B config after this auto-detection and can be used to override the choices. -If +If .B LOCAL.config contains a line .B WSYSTYPE=nowsys @@ -110,7 +99,7 @@ On Ubuntu, it suffices to install xorg-dev. can safely be repeated to rebuild the system from scratch. .PP Once the system is built for the first time, -it can be maintained and rebuilt using +it can be maintained and rebuilt using .IR mk (1). To rebuild individual commands or libraries, run diff --git a/man/man1/soelim.1 b/man/man1/soelim.1 new file mode 100755 index 00000000..6378d414 --- /dev/null +++ b/man/man1/soelim.1 @@ -0,0 +1,29 @@ +.TH SOELIM 1 +.\" .so in the NAME line confuses the ptx machinery; sorry +.SH NAME +soelim \- preprocess so inclusion commands in troff input +.SH SYNOPSIS +.B soelim +[ +.I files ... +] +.SH DESCRIPTION +.I Soelim +reads the specified files or the standard input and performs +the textual inclusion implied by +.IR troff (1) +directives of the form +.TP +.B "\&.so some_file +.PP +when they appear at the beginning of input lines. This is useful when +using programs such as +.IR tbl (1) +that do not normally do this, allowing +placement of individual tables or other text objects in separate files +to be run as a part of a large document. +.SH SOURCE +.B \*9/bin/soelim +.SH "SEE ALSO" +.IR deroff (1), +.IR troff (1) diff --git a/man/man1/tar.1 b/man/man1/tar.1 index 4a18d6c8..80e3f40b 100644 --- a/man/man1/tar.1 +++ b/man/man1/tar.1 @@ -127,7 +127,6 @@ for and .BR .tbz2 ; .I compress -(not distributed) for .B .tar.Z and diff --git a/man/man1/winwatch.1 b/man/man1/winwatch.1 new file mode 100644 index 00000000..afbf541d --- /dev/null +++ b/man/man1/winwatch.1 @@ -0,0 +1,57 @@ +.TH WINWATCH 1 +.SH NAME +winwatch \- monitor rio windows +.SH SYNOPSIS +.B winwatch +[ +.B -e +.I exclude +] [ +.B -f +.I font +] [ +.B -n +] [ +.B -s +] +.SH DESCRIPTION +.I Winwatch +displays the labels of all current +.IR rio (1) +windows, refreshing the display every second. +Right clicking a window's label unhides, raises and gives focus to that window. +Typing +.B q +or +DEL +quits +.IR winwatch . +.PP +If the +.B -e +flag +is given, +windows matching the regular expression +.I exclude +are not shown. +With the +.B -n +option, +the +label is defined as the window’s name instead of its class, +and with +.B -s +the labels are sorted by alphabet (case insensitive) +instead of by order of appearance. +Winwatch is unicode aware. +.SH EXAMPLE +Excluding winwatch and stats from being shown. +.IP +.EX +% winwatch -e '^(winwatch|stats)$' +.EE +.SH SOURCE +.B \*9/src/cmd/winwatch.c +.SH SEE ALSO +.IR rio (1), +.IR regexp (7). |