aboutsummaryrefslogtreecommitdiff
path: root/doc (follow)
AgeCommit message (Collapse)AuthorFilesLines
2024-01-24Move doc/logo/xz-logo.png to "doc" and Doxygen footer to "doxygen".Lasse Collin2-11/+0
The footer isn't a complete HTML file so having it in the doxygen directory is a tiny bit clearer.
2024-01-25Doxygen: Added the XZ logo and copyright information.Jia Tan2-0/+11
The PROJECT_LOGO field is now used to include the XZ logo. The footer of each page now lists the copyright information instead of the default footer. The license is also copied to statisfy the copyright and so the link in the documentation can be local.
2024-01-19Docs: Update .xz file format specification to 1.2.0.Jia Tan1-12/+17
The new RISC-V filter was added to the specification, in addition to updating the specification URL.
2024-01-19Docs: Update website URLs.Jia Tan2-10/+10
2023-09-24Docs: Change quoting style from `...' to '...'.Jia Tan2-9/+9
These days the ` and ' do not look symmetric. This quoting style has been changed in various apps over the years including the GNU tools.
2022-12-11Docs: Update xz-file-format.txt to 1.1.0 for ARM64 filter.Lasse Collin1-7/+22
2022-11-08Docs: Update faq.txt a little.Lasse Collin1-23/+43
2022-07-13liblzma: Add optional autodetection of LZMA end marker.Lasse Collin1-2/+9
Turns out that this is needed for .lzma files as the spec in LZMA SDK says that end marker may be present even if the size is stored in the header. Such files are rare but exist in the real world. The code in liblzma is so old that the spec didn't exist in LZMA SDK back then and I had understood that such files weren't possible (the lzma tool in LZMA SDK didn't create such files). This modifies the internal API so that LZMA decoder can be told if EOPM is allowed even when the uncompressed size is known. It's allowed with .lzma and not with other uses. Thanks to Karl Beldan for reporting the problem.
2020-03-23Typo fixes from fossies.org.Lasse Collin1-1/+1
https://fossies.org/linux/misc/xz-5.2.5.tar.xz/codespell.html
2019-05-11spellingAntoine Cœur1-1/+1
2017-05-23Docs: Fix a typo in a comment in doc/examples/02_decompress.c.Alexey Tourbin1-1/+1
2017-04-24Docs: Add doc/examples/11_file_info.c.Lasse Collin2-1/+208
2017-04-19Update the home page URLs to HTTPS.Lasse Collin1-2/+2
2014-12-21Docs: Use lzma_cputhreads() in 04_compress_easy_mt.c.Lasse Collin1-4/+26
2014-12-21Docs: Update docs/examples/00_README.txt.Lasse Collin1-0/+4
2014-05-04Docs: Update comments to refer to lzma/lzma12.h in example programs.Lasse Collin1-3/+3
2014-01-29Docs: Add example program for threaded encoding.Lasse Collin2-1/+186
I didn't add -DLZMA_UNSTABLE to Makefile so one has to specify it manually as long as LZMA_UNSTABLE is needed.
2012-06-18Docs: Language fix to 01_compress_easy.c.Lasse Collin1-1/+1
Thanks to Jonathan Nieder.
2012-06-14Docs: Add new example programs.Lasse Collin5-0/+827
These have more comments than the old examples and human-readable error messages. More tutorial-like examples are needed but these are a start.
2012-06-14Docs: Move xz_pipe_comp.c and xz_pipe_decomp.c to doc/examples_old.Lasse Collin2-0/+0
It is good to keep these around to so that if someone has copied the decompressor bug from xz_pipe_decomp.c he has an example how to easily fix it.
2012-06-14Docs: Fix a bug in xz_pipe_decomp.c example program.Lasse Collin1-1/+9
2012-05-10Docs: Cleanup line wrapping a bit.Lasse Collin1-24/+25
2012-05-10Fix a few typos and add some missing articles in some documents.Benno Schulenberg2-41/+41
Also hyphenate several compound adjectives. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-04-12Remove doubled words from documentation and comments.Lasse Collin1-2/+2
Spot candidates by running these commands: git ls-files |xargs perl -0777 -n \ -e 'while (/\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims)' \ -e '{$n=($` =~ tr/\n/\n/ + 1); ($v=$&)=~s/\n/\\n/g; print "$ARGV:$n:$v\n"}' Thanks to Jim Meyering for the original patch.
2010-10-02Update the FAQ.Lasse Collin1-4/+100
2010-07-13Add two simple example programs.Lasse Collin2-0/+242
Hopefully these help a bit when learning the basics of liblzma API. I plan to write detailed examples about both basic and advanced features with lots of comments, but these two examples are good have right now. The examples were written by Daniel Mealha Cabrita. Thanks.
2010-03-31Add a simple tip to faq.txt about tar and xz.Lasse Collin1-0/+6
Thanks to Gilles Espinasse.
2010-02-12Collection of language fixes to comments and docs.Lasse Collin1-1/+1
Thanks to Jonathan Nieder.
2009-08-27.xz file format specification 1.0.4 (probably).Lasse Collin1-11/+15
Thanks to Christian von Roques, Peter Lawler, and Jim Meyering for the fixes.
2009-08-27Removed doc/bugs.txt.Lasse Collin1-46/+0
2009-08-27Fix a typo in FAQ.Lasse Collin1-1/+1
Thanks to Jim Meyering. (From now on, I try to always remember to put the relevant thanks to commit messages.)
2009-08-18Updated faq.txt.Lasse Collin1-166/+73
Some questions worth answering were removed, because I currently don't have good up to date answers to them.
2009-06-05A few more spelling fixes. Released the .xz spec 1.0.3.Lasse Collin1-5/+7
2009-06-04Fix purporse -> purpose. Thanks to Andrew Dudman.Lasse Collin1-3/+5
Released .xz spec 1.0.2 due to this fix too.
2009-06-01The .xz file format version 1.0.1Lasse Collin1-7/+22
2009-05-01Remove docs that are too outdated to be updatedLasse Collin5-956/+0
(rewrite will be better).
2009-05-01Added documentation about the legacy .lzma file format.Lasse Collin1-0/+166
2009-05-01Renamed the file format specification to xz-file-format.txtLasse Collin1-0/+0
which is the filename used on the WWW.
2009-04-13Updated history.txt.Lasse Collin1-57/+66
2009-04-13Put the interesting parts of XZ Utils into the public domain.Lasse Collin1-35/+3
Some minor documentation cleanups were made at the same time.
2009-01-28The .xz file format specification version 1.0.0 is nowLasse Collin1-35/+49
officially released. The format has been technically the same since 2008-11-19, but now that it is frozen, people can start using it without a fear that the format will break.
2008-12-09Put the file format specification into the public domain.Lasse Collin1-15/+9
Same will be done to the actual code later.
2008-11-19Oh well, big messy commit again. Some highlights:Lasse Collin1-114/+146
- Updated to the latest, probably final file format version. - Command line tool reworked to not use threads anymore. Threading will probably go into liblzma anyway. - Memory usage limit is now about 30 % for uncompression and about 90 % for compression. - Progress indicator with --verbose - Simplified --help and full --long-help - Upgraded to the last LGPLv2.1+ getopt_long from gnulib. - Some bug fixes
2008-09-27Updated file format specification. It changes the suffixLasse Collin1-93/+32
of the new format to .xz and removes the recently added LZMA filter.
2008-09-07Changed Filter ID of LZMA to 0x20.Lasse Collin1-2/+2
2008-09-03Minor updates to the file format specification.Lasse Collin1-20/+85
2008-06-17Update the file format specification draft. The new one isLasse Collin1-1286/+508
a lot simpler than the previous versions, but it also means that the existing code will change a lot.
2008-05-30Typo fixes from meyering.Lasse Collin2-3/+3
2008-05-06Bunch of grammar fixes from meyering.Lasse Collin1-4/+4
2008-04-28Fixed wrong spelling "limitter" to "limiter". This affectsLasse Collin1-7/+7
liblzma's API.
2008-02-06Tiny clean up to file-format.txt.Lasse Collin1-3/+3
2008-01-16Tiny non-technical edits to file-format.txt.Lasse Collin1-3/+3
2008-01-06Introduced compatibility with systems that have pre-C99Lasse Collin1-2/+8
or no inttypes.h. This is useful when the compiler has good enough support for C99, but libc headers don't. Changed liblzma API so that sys/types.h and inttypes.h have to be #included before #including lzma.h. On systems that don't have C99 inttypes.h, it's the problem of the applications to provide the required types and macros before #including lzma.h. If lzma.h defined the missing types and macros, it could conflict with third-party applications whose configure has detected that the types are missing and defined them in config.h already. An alternative would have been introducing lzma_uint32 and similar types, but that would just be an extra pain on modern systems.
2007-12-09Imported to git.Lasse Collin9-0/+3244