diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile | 21 | ||||
| -rw-r--r-- | man/cvflist.1 | 24 | ||||
| -rw-r--r-- | man/cvftest.1 | 45 | ||||
| -rw-r--r-- | man/dmsdosd.1 | 66 | ||||
| -rw-r--r-- | man/dmsdosfsck.8 | 41 | ||||
| -rw-r--r-- | man/dutil.1 | 175 | ||||
| -rw-r--r-- | man/mcdmsdos.1 | 47 |
7 files changed, 419 insertions, 0 deletions
diff --git a/man/Makefile b/man/Makefile new file mode 100644 index 0000000..f2a7cfd --- /dev/null +++ b/man/Makefile @@ -0,0 +1,21 @@ + +MAN_PREFIX=/usr/local/man + +install: + install dutil.1 -m 644 $(MAN_PREFIX)/man1/dutil.1 + install dmsdosd.1 -m 644 $(MAN_PREFIX)/man1/dmsdosd.1 + install dmsdosfsck.8 -m 644 $(MAN_PREFIX)/man8/dmsdosfsck.8 + install mcdmsdos.1 -m 644 $(MAN_PREFIX)/man1/mcdmsdos.1 + install cvftest.1 -m 644 $(MAN_PREFIX)/man1/cvftest.1 + install cvflist.1 -m 644 $(MAN_PREFIX)/man1/cvflist.1 + +install-min: + install dutil.1 -m 644 $(MAN_PREFIX)/man1/dutil.1 + +uninstall: + rm -f $(MAN_PREFIX)/man1/dutil.1 + rm -f $(MAN_PREFIX)/man1/dmsdosd.1 + rm -f $(MAN_PREFIX)/man8/dmsdosfsck.8 + rm -f $(MAN_PREFIX)/man1/mcdmsdos.1 + rm -f $(MAN_PREFIX)/man1/cvftest.1 + rm -f $(MAN_PREFIX)/man1/cvflist.1 diff --git a/man/cvflist.1 b/man/cvflist.1 new file mode 100644 index 0000000..7f4d0f1 --- /dev/null +++ b/man/cvflist.1 @@ -0,0 +1,24 @@ +.TH cvflist 1 "10 Oct 1998" "dmsdos 0.9.2.0" "dmsdos CVF list tool" +.SH NAME +cvflist \- lists names of CVFs in a raw FAT12 or FAT16 partition +.SH SYNOPSIS + +.BI cvflist " raw_device" + +.SH DESCRIPTION +.I cvflist +tries to find out whether the raw partition in raw_device contains +CVFs. If so, their file names are printed. The raw partition must be in +FAT12 or FAT16 format. + +The advantage of this program is that it works without mounting the +partition. + +.SH BUGS +.I cvflist +may react unexpectedly on partitions that are not FAT12 or +FAT16 (e.g. list some garbage). + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. diff --git a/man/cvftest.1 b/man/cvftest.1 new file mode 100644 index 0000000..f036b0d --- /dev/null +++ b/man/cvftest.1 @@ -0,0 +1,45 @@ +.TH cvftest 1 "10 Oct 1998" "dmsdos 0.9.2.0" "dmsdos CVF identification tool" +.SH NAME +cvftest \- dmsdos CVF identification tool +.SH SYNOPSIS + +.BI cvftest " filename [-v]" + +.SH DESCRIPTION +.I cvftest +tries to find out whether the file (or device) +.I filename +is a CVF. It does so by reading the first 512 bytes from +.I filename +and checking for certain strings. + +If +.I filename +is just a minus sign (-) the data are read from standard input. + +If the switch +.I -v +is given the result of the test is printed to standard output including +a description about what kind of CVF was detected. + +.SH RETURN VALUES +.I cvftest +returns zero (i.e. true) if +.I filename +has been recognized as a CVF. Otherwise it returns 1. A value >1 +indicates an error (e.g. +.I filename +does not exist or cannot be read). + +.SH BUGS +This program is so simple that it could be a shell script. But I'm not a shell +hacker, so it's C. + +The test is not idiot-proof. As it just checks for some magic values, it +might eventually misidentify other files as CVFs. These cases are supposed +to be extremely unlikely, though, and have never been reported yet. But if +you take a look at the source you easily find a way to fool the program :-) + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. diff --git a/man/dmsdosd.1 b/man/dmsdosd.1 new file mode 100644 index 0000000..71262cb --- /dev/null +++ b/man/dmsdosd.1 @@ -0,0 +1,66 @@ +.TH dmsdosd 1 "15 Apr 1998" "dmsdos 0.9.0.14" "dmsdos daemon" +.SH NAME +dmsdosd \- dmsdos daemon for background compression +.SH SYNOPSIS + +.BI dmsdosd " directory [level [debug]]" + +.SH DESCRIPTION +.I dmsdosd +does compression for the dmsdos driver in the background when +the system is idle. This may reduce system load when there are much data +to compress because the dmsdos driver can leave the data as they are and +pass them to the daemon to do the job of compression. +.I directory +must be the mountpoint of a CVF that is served by dmsdos. +In fact, +.I directory +may be also a subdirectory of the mountpoint. (If you mount more than +one dmsdos partition it doesn't matter which one you specify. There is +also no need to restart the daemon when additional partitions are mounted - +the daemon automatically handles them all.) + +.I level +is the compression level. It must be in the range of +.BR 1 " - " 12 . +If no +.I level +is given, it defaults to 12. + +If the parameter +.I debug +is given, dmsdosd prints a lot of debug information to stderr and doesn't +put itself into the background. + +Note that you must run +.I dmsdosd +as root. The daemon refuses to run if started by another user. It also +doesn't start if it finds already one instance of +.I dmsdosd +running. + +You can kill the daemon at any time (even when it is under heavy work). +Send a SIGINT to let the daemon finish its actual work and then exit. +Send a SIGTERM to make the daemon exit as soon as possible. You should not +send a SIGKILL. + +.SH BUGS +.I dmsdosd +can only be started when a CVF has already been mounted by the +dmsdos driver. + +You must kill +.I dmsdosd +before you can unmount the CVF that was given in the command line. + +Older versions (below 0.9.0.12) didn't run in the background, didn't check +for already running processes and didn't use stderr for error and debug +messages. This manual page is not valid for them. + +.SH FILES +.I /var/run/dmsdosd.pid +- pid of running daemon + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. diff --git a/man/dmsdosfsck.8 b/man/dmsdosfsck.8 new file mode 100644 index 0000000..67962ee --- /dev/null +++ b/man/dmsdosfsck.8 @@ -0,0 +1,41 @@ +.TH dmsdosfsck 8 "16 Jun 1998" "dmsdos 0.9.1.3" "dmsdos filesystem checker" +.SH NAME +dmsdosfsck \- dmsdos filesystem checker +.SH SYNOPSIS + +.BI dmsdosfsck " [-aflrtvVw] [-d path -d ...] [-u path -u ...] filename" + +.SH DESCRIPTION +.I dmsdosfsck +checks the CVF located in +.I filename +for errors and optionally tries to repair errors. It is command-line +compatible with dosfsck(8). + + -a automatically repair the file system + -d path (*) drop that file + -f (*) salvage unused chains to files + -l list path names + -r interactively repair the file system + -t (*) test for bad clusters + -u path (*) try to undelete that (non-directory) file + -v verbose mode + -V (*) perform a verification pass + -w (*) write changes to disk immediately + (*) not yet implemented but option accepted for dosfsck compatibility + + +.SH BUGS +.I dmsdosfsck +is not yet complete. Be extremely careful with repairs. + +.I It is strongly +.I recommended to let only the native CVF management tools that came with your +.I CVF software package do any repairs. +Use +.I dmsdosfsck +only to check (which is a read-only operation). + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. diff --git a/man/dutil.1 b/man/dutil.1 new file mode 100644 index 0000000..1cd4530 --- /dev/null +++ b/man/dutil.1 @@ -0,0 +1,175 @@ +.TH dutil 1 "16 Jun 1998" "dmsdos 0.9.1.3" "dmsdos utilities" +.SH NAME +dutil \- dmsdos hacker's utility +.SH SYNOPSIS + +.BI dutil " directory [command [options ...]]" + +.SH DESCRIPTION +Perform +.I command +on the CVF that is mounted under +.I directory. +In fact, +.I directory +may be also a subdirectory of the mountpoint. + +If no +.I command +is given, general information about the CVF is printed. + + +.B List of commands + + +.B cluster \- print cluster information + +.B sector \- read raw sector from disk and hexdump it + +.B rrawcluster \- read raw cluster from disk and hexdump it + +.B rcluster \- read and decompress cluster and hexdump it + +.B bitfat \- print bitfat content + +.B setcomp \- change compression format + +.B setcf \- change compression level + +.B dumpcache \- dump cache information to syslog + +.B synccache \- write dirty clusters to disk immediately + +.B logstat \- dump statistics to syslog + +.B checkfs \- check filesystem tables + +.B setloglevel \- change dmsdos log level + +.B setspeedup \- change dmsdos speedup flags + +.B memory \- report dmsdos memory usage for caching + + +.B The commands in detail + + +.B dutil directory cluster +.I clusternr + +Print information about cluster +.I clusternr. + +.B dutil directory sector +.I sectornr [file] + +Read raw sector +.I sectornr +from disk and print it as hexdump. If +.I file +is given, it is written to a binary file (raw, not as hexdump). + +.B dutil directory rrawcluster +.I clusternr [file] + +Read raw cluster data from cluster +.I clusternr +from disk and print it as hexdump. If +.I file +is given, it is written to a binary file (raw, not as hexdump). +The cluster data are not decompressed. This command does not work for +fragmented or suballocated clusters and may return complete garbage +in these cases. + +.B dutil directory rcluster +.I clusternr [file] + +Read and decompress cluster +.I clusternr +from disk and print it as hexdump. If +.I file +is given, it is written to a binary file (raw, not as hexdump). + +.B dutil directory bitfat +.I sectornr + +Read bitfat allocation information of sector +.I sectornr +from disk and print it. + +.B dutil directory setcomp +.I value + +Set compression scheme for write access. +.I value +must be one out of +.B guess ds00 ds01 ds02 jm00 jm01 sq00 sd3 sd4 . +See the dmsdos driver documentation about compression schemes. + +.B dutil directory setcf +.I value + +Set compression level for write access. +.I value +must be one out of the range +.BR 1 " - " 12. +A higher level means better but slower compression. + +.B dutil directory dumpcache + +Dump dmsdos cache information to syslog. + +.B dutil directory synccache +.I [value] + +Write dirty clusters back to disk immediately. If +.I value +is given and not zero, the data may be passed to the compression +daemon instead of written directly to disk. Otherwise the command +waits until the data are compressed and written. If you want to ensure +physical write access to disk also +.BR sync(1) +the buffer cache. + +.B dutil directory logstat + +Write dmsdos statistics to syslog. + +.B dutil directory checkfs +.I [value] + +Check the CVF internal tables for inconsistencies. If +.I value +is given and not zero, try to repair errors. + +.B dutil directory setloglevel +.I value + +Set the dmsdos driver log level. +.I value +must be a decimal or a 0x prefixed hexadecimal number. +See the dmsdos driver documentation for details about log levels. + +.B dutil directory setspeedup +.I value + +Set the dmsdos driver speedup flags. +.I value +must be a decimal or a 0x prefixed hexadecimal number. +See the dmsdos driver documentation for details about the speedup flags. + +.B dutil directory memory + +Report how much memory the dmsdos driver currently uses for caching. + +.SH BUGS + +The dutil commands for reading data from disk operate at a lower level than +the dmsdos cluster cache. +.I You must disable dmsdos write-back caching or sync the dmsdos cluster +.I cache before each operation to get correct results in all cases. + + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. diff --git a/man/mcdmsdos.1 b/man/mcdmsdos.1 new file mode 100644 index 0000000..9280583 --- /dev/null +++ b/man/mcdmsdos.1 @@ -0,0 +1,47 @@ +.TH dmsdosd 1 "10 Oct 1998" "dmsdos 0.9.2.0" "dmsdos MC external fs tool" +.SH NAME +mcdmsdos \- dmsdos tool for Midnight Commander external filesystem +.SH SYNOPSIS + +.BI mcdmsdos " mc-extfs-command args ..." + +i.e. + +.BI mcdmsdos " list <CVF_name> " + +.BI mcdmsdos " copyout <CVF_name> <path/name_in_CVF> <outfile> " + +.BI mcdmsdos " copyin <CVF_name> <path/name_in_CVF> <infile> " + +.SH DESCRIPTION +.I mcdmsdos +represents an interface for Midnight Commander +.I mc(1) +according to the documentation of 3.0 version for external filesystems. +See the Midnight Commander documentation for more information about +external filesystems. + +.I mc-extfs-command +can be: + +.B list: +lists the contents of a CVF (recursively) i.e. the names of all files +in the CVF are printed. + +.B copyout: +extracts a file from the CVF. + +.B copyin: +stores a file in the CVF. This is currently not yet implemented and results +in an error message. + +.SH BUGS +.I mcdmsdos +can interfere with mounted CVFs. You should not use mcdmsdos on a CVF that +is currently mounted by dmsdos. This would not make any sense either. + +.SH SEE ALSO + +Refer to the dmsdos main documentation for further information. +See the Midnight Commander documentation for more information about +its external filesystem interface. |