diff options
Diffstat (limited to 'system/maxcso/man.patch')
| -rw-r--r-- | system/maxcso/man.patch | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/system/maxcso/man.patch b/system/maxcso/man.patch new file mode 100644 index 0000000000..441511d91b --- /dev/null +++ b/system/maxcso/man.patch @@ -0,0 +1,204 @@ +From bd7f860ebec755a67d09cd9c52a98bd7e1761fe3 Mon Sep 17 00:00:00 2001 +From: orbea <orbea@fredslev.dk> +Date: Thu, 22 Nov 2018 18:27:14 -0800 +Subject: [PATCH] man: Add the maxcso.1 manual. + +--- + Makefile | 5 ++ + maxcso.1 | 160 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + 2 files changed, 165 insertions(+) + create mode 100644 maxcso.1 + +diff --git a/Makefile b/Makefile +index 54a6489c..70870e23 100644 +--- a/Makefile ++++ b/Makefile +@@ -1,5 +1,6 @@ + PREFIX ?= /usr/local + BINDIR ?= $(PREFIX)/bin ++MANDIR ?= $(PREFIX)/share/man + + CC ?= gcc + CXX ?= g++ +@@ -34,11 +35,15 @@ maxcso: $(SRC_CXX_OBJ) $(CLI_CXX_OBJ) $(ZOPFLI_C_OBJ) 7zip/7zip.a + + install: + mkdir -p $(DESTDIR)$(BINDIR) ++ mkdir -p $(DESTDIR)$(MANDIR)/man1 + cp maxcso $(DESTDIR)$(BINDIR) ++ cp maxcso.1 $(DESTDIR)$(MANDIR)/man1 + chmod 0755 $(DESTDIR)$(BINDIR)/maxcso ++ chmod 0644 $(DESTDIR)$(MANDIR)/man1/maxcso.1 + + uninstall: + rm -f $(DESTDIR)$(BINDIR)/maxcso ++ rm -f $(DESTDIR)$(MANDIR)/man1/maxcso.1 + + clean: + rm -f $(SRC_CXX_OBJ) $(CLI_CXX_OBJ) $(ZOPFLI_C_OBJ) maxcso +diff --git a/maxcso.1 b/maxcso.1 +new file mode 100644 +index 00000000..67d7e16c +--- /dev/null ++++ b/maxcso.1 +@@ -0,0 +1,160 @@ ++.\" maxcso.1 ++.\" ++.Dd November 22, 2018 ++.Dt MAXCSO 1 ++.Os ++.Sh NAME ++.Nm MAXCSO ++.Nd Fast cso compressor ++.Sh SYNOPSIS ++.Nm maxcso ++.Op Fl -args ++.Op Ar input.iso ++.Op Fl o Ar output.cso ++.Sh DESCRIPTION ++A fast ISO to CSO compression program for use with PSP and PS2 emulators, which ++uses multiple algorithms for best compression ratio. ++.Ss FEATURES ++.Bl -bullet -offset <TAB> -compact ++.It ++Can use as many CPU cores as you want. ++.It ++Can use ++.Xr zlib 3 , ++7-zip's deflate, and Zopfli. ++.It ++Processes multiple files in one command. ++.It ++Can take a CSO or DAX file as a source. ++.It ++Able to output at larger block sizes. ++.It ++Support for experimental CSO v2 and ZSO formats using ++.Xr lz4 1 ++(faster decompression). ++.It ++Tuning of deflate or ++.Xr lz4 1 ++compression threshold. ++.It ++Decompression of all supported inputs (including DAX and CSO v2). ++.El ++.Ss Compression ++.Nm maxcso ++always uses compression level 9. ++Decompression speed is about the same regardless of level, and disk access is ++faster with smaller files. ++.Pp ++Using 7-zip's deflate and Zopfli improves compression ratios, but don't expect a ++lot. ++Usual results are between 0.5% to 1.0% smaller. ++.Pp ++Larger block sizes than the default will help compression, in the range of 2-3%. ++However, the files may not be compatible with some software. ++For example, ++.Nm ppsspp ++versions released after 2014-10-26 will support larger block ++sizes. ++.Pp ++Avoid DAX where CSOs using larger block sizes are supported, since DAX is less ++efficient. ++.Pp ++.Xr lz4 1 ++support is mostly for experimentation. ++.Ss Speed ++Compared to other tools like ciso and CisoPlus, ++.Nm maxcso ++can run much faster and achieve the same compression. ++Use ++.Fl -fast ++to get the fastest compression, which matches level 9 in other tools. ++.Pp ++Additionally, if you have better than a dual core processor, ++.Nm maxcso ++will use all ++of your cores, and perform even better. ++.Pp ++In usage, CSOs typically perform well in all known emulators. ++Some versions of PSP firmware with ++support for CSOs have bugs in their CSO support, but this doesn't affect ++emulators. ++.Sh OPTIONS ++Multiple files may be specified. ++Inputs can be iso or cso files. ++.Bl -tag -width indent ++.It Fl -threads=N ++Specify N threads for I/O and compression. ++.It Fl -quiet ++Suppress status output. ++.It Fl -crc ++Log CRC32 checksums, ignore output files and methods. ++.It Fl -fast ++Use only basic ++.Xr zlib 3 ++or lz4 for fastest result. ++.It Fl -decompress ++Write out to raw ISO, decompressing as needed. ++.It Fl -block=N ++Specify a block size (default depends on iso size). ++Many readers only support the 2048 size. ++.It Fl -format=VER Ar cso1 , cso2 , zso , dax ++Specify cso version. ++These are experimental, default is ++.Ar cso1 . ++.It Fl -usr-zlib ++Enable trials with ++.Xr zlib 3 ++for deflate compression. ++.It Fl -use-zopli ++Enable trials with Zopfli for deflate compression. ++Because Zopfli is significantly slower than the other methods and uses a lot ++more memory, it is disabled by default. ++Use for maximum compression. ++.It Fl -use-7zdeflate ++Enable trials with 7-zip's deflate compression. ++.It Fl -use-lz4 ++Enable trials with lz4hc for ++.Xr lz4 1 ++compression. ++.It Fl -use-lz4brute ++Enable bruteforce trials with lz4hc for ++.Xr lz4 1 ++compression. ++.It Fl -only-METHOD ++Only allow a certain compression method ( ++.Xr zlib 3 , ++etc. above). ++.It Fl -no-METHOD ++Disable a certain compression method ( ++.Xr zlib 3 , ++etc. above). ++.It Fl -lz4-cost=N ++Allow ++.Xr lz4 1 ++to increase block size by N% at most (cso2 only). ++.It Fl -orig-cost=N ++Allow uncompressed to increase block size by N% at most. ++.El ++.Pp ++The cost arguments allow you to allow each block to be N% bigger by using ++.Xr lz4 1 ++or no compression. ++This makes the file read faster (less cpu power), but take more space. ++.Sh EXAMPLES ++.Bl -tag -width indent ++.It Nm maxcso Ar myfile.iso ++Compress ++.Ar myfile.iso ++and create myfile.cso. ++.It Nm maxcso Ar myfile.iso Fl o Ar output.cso ++Compress ++.Ar myfile.iso ++and create ++.Ar output.cso . ++.El ++.Sh SEE ALSO ++.Xr lz4 1 , ++.Xr PCSX2 1 , ++.Xr zlib 3 ++.Sh BUGS ++.Lk https://github.com/unknownbrackets/maxcso/issues "Issue tracker" |