diff --git a/.gitattributes b/.gitattributes index 3b5aa410eeabbd30a3d91162ba6c3544ae2ee832..060639870fb952083f6b44669fcea354ae7aef7b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -2723,3 +2723,176 @@ miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/libpython3.10.so filter=lfs diff=l miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/libpython3.10.so.1.0 filter=lfs diff=lfs merge=lfs -text miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/ensurepip/_bundled/pip-23.0.1-py3-none-any.whl filter=lfs diff=lfs merge=lfs -text miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/ensurepip/_bundled/setuptools-79.0.1-py3-none-any.whl filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_asyncio.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_blake2.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_cn.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_hk.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_jp.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_kr.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_tw.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_csv.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ctypes.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_curses.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_datetime.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_decimal.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_elementtree.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_hashlib.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_heapq.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_json.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_lzma.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_multibytecodec.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_pickle.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sha3.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_socket.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sqlite3.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ssl.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_struct.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testbuffer.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testcapi.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testclinic.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_tkinter.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_xxsubinterpreters.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_zoneinfo.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/array.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/audioop.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/binascii.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/cmath.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/math.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/pyexpat.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/readline.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/select.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/unicodedata.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/zlib.cpython-310-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.1 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.13 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so.1.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/ensurepip/_bundled/pip-25.3-py3-none-any.whl filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_asyncio.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_blake2.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_cn.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_hk.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_jp.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_kr.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_tw.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_csv.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ctypes.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_curses.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_datetime.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_decimal.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_elementtree.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_hashlib.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_heapq.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpchannels.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpqueues.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpreters.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_json.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lsprof.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lzma.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_md5.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multibytecodec.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multiprocessing.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_pickle.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_posixsubprocess.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha2.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha3.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_socket.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sqlite3.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ssl.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_struct.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testbuffer.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testcapi.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testclinic.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testinternalcapi.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testlimitedcapi.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_tkinter.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_zoneinfo.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/array.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/binascii.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/cmath.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/math.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/mmap.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/pyexpat.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/readline.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/select.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/syslog.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/unicodedata.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/zlib.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.a filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8.3 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/ruamel.yaml.clib-0.2.14-py313h4aee224_0/lib/python3.13/site-packages/_ruamel_yaml.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23.0.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/bin/sqlite3 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.3.51.1 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/bin/sqlite3 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.3.51.2 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtcl8.6.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtk8.6.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/itcl4.3.0/libitcl4.3.0.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/sqlite3.45.3/libsqlite3.45.3.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/teapot.ppm filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6.4.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzcat filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzma filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unlzma filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unxz filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xz filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xzcat filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5.8.2 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so.1.11.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so.1.11.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8.0 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zlib-1.3.1-hb25bd0a_0/lib/libz.a filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/_cffi.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/backend_c.cpython-313-x86_64-linux-gnu.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/unzstd filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstd filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdcat filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdmt filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.a filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1 filter=lfs diff=lfs merge=lfs -text +miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1.5.7 filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/bg/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/ca/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/de/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/en@boldquot/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/en@quot/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/es/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/fi/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/fr/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/hr/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/it/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/ja/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/ko/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/pl/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/pt/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/pt_BR/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/ro/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/ru/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/sk/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/sl/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/sr/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/sv/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/uk/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/vi/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/zh_CN/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text +miniconda3/share/locale/zh_TW/LC_MESSAGES/gettext-tools.mo filter=lfs diff=lfs merge=lfs -text diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_16.png b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_16.png new file mode 100644 index 0000000000000000000000000000000000000000..46cc2af81a39625ec111aaa2bed58fdda1717793 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_16.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78fb3fb0ec11f61bc6cf0947f3c3923aa18e1c6513684058ed0fa01ac858143e +size 1031 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_256.png b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_256.png new file mode 100644 index 0000000000000000000000000000000000000000..dcb94bf00618b7e18b65bed91e02385a9a32d41e --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_256.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f517467d12e0e3ecf20f9bd68ce4bd18a2b8088f32308fd978fd80e87d3628b +size 39205 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.gif new file mode 100644 index 0000000000000000000000000000000000000000..89a600532f00e4d206bbc8a59b6baad82fd9dab1 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe70991cfccd1267922e94d91e02e9a58d2d29fd3382a2f4975280b9023cb7b9 +size 1019 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.png b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.png new file mode 100644 index 0000000000000000000000000000000000000000..464aceda8b1fa6e98d3553572e40ebe7d2de2ccb --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_32.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:797cd05f1964d57c4c6c248ac7f7ea6a38019ada32a9ab7e6c28d060f87b03de +size 2036 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.gif new file mode 100644 index 0000000000000000000000000000000000000000..8c44232f6288f2948637bf3c44522cf7230637a3 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37484901eb40eefa846308e1da3ff6f240ea98f769a2afc3cf4fdba00327ecbe +size 1388 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.png b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.png new file mode 100644 index 0000000000000000000000000000000000000000..fbc92eb6d2d6815ba8c9e1bfd38bccc643da84c1 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/idle_48.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a09f433197c8870b12bb7859cc4c3fe2068908cb1ddbd4880ab0f6fee91b6c23 +size 3977 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/minusnode.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/minusnode.gif new file mode 100644 index 0000000000000000000000000000000000000000..98541201db0e2935a0d113f67171d253473005e2 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/minusnode.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:efa5aa1d1e3439ab85425bd2aa3a25b9e6c21309e672690cfb32219e1eb7a7f3 +size 75 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/openfolder.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/openfolder.gif new file mode 100644 index 0000000000000000000000000000000000000000..91b37619cc0326db6bfc6faafcafde0322fb69b5 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/openfolder.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a59e2abf1840156e9db8f85a38822fd56ab79a139eb95ec86f1fba1bb87326b +size 125 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/plusnode.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/plusnode.gif new file mode 100644 index 0000000000000000000000000000000000000000..c4c7e864238f9fcfe272ea6754ea84c7798add1e --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/plusnode.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ace9e90a2bcb16d06c4d78837137f2c14bc26b3bd9f24b7b6afeadb689bdafb +size 78 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/python.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/python.gif new file mode 100644 index 0000000000000000000000000000000000000000..2d73d19be477b8af5f50c7712a2ce1be9db9c20d --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/python.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:158c31382f8e5b41fded0c2aa9cc66a382928b003cdd8b5b0518836ad9c89377 +size 380 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/tk.gif b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/tk.gif new file mode 100644 index 0000000000000000000000000000000000000000..666c5cc86c65a985eb2a962f850bdad58178d64a --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/idlelib/Icons/tk.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f16cb2e322891dbd9101302c09ffda0c2a3a72d053bb8c0927d507414c59cad +size 72 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_asyncio.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_asyncio.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..743cc5811a0e7c2d31e8ab0aa51f20193c9b8d63 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_asyncio.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99cfe61d2bec1d531f3a030babcd8b8ce1a6be47633d93548a660186a7f52a2a +size 226752 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_blake2.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_blake2.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..61d9b1c140d19bb890d556210a6b26b3b8a88935 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_blake2.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7244e80467c5a247c60e26f7bb09ad7bb21270092647368bb646d7e5fdaeb514 +size 224144 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_cn.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_cn.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..a395f09474ac802e621d662f33a8c252800b250d --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_cn.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33f44602a4401bb259101bb07dacb2130e1e75691862b3da58b024a1d80c187c +size 192024 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_hk.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_hk.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..23dc28163f8ae8e13cb4dc27a5f3e348c3da320f --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_hk.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ce82856cf35a77b983d268eb309b8ed5f3d71f8f87e97685fffa1338098bb82 +size 189128 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_jp.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_jp.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..c6e64fa8ce1d6a12bb8a8328b04008c7ef52144a --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_jp.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0caec8ca87cc6bddf49cbc0250573f98b5ea9778fc1f24a3e089983102de9b64 +size 321280 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_kr.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_kr.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..7433d00e9a07709badd4b5a022c37be765233672 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_kr.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b1f6984cbf0784542d14629009360911b99ccd585f4dc1a321df463b57693cdd +size 176944 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_tw.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_tw.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..add90fee8108315070d71113f743886612484ffb --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_codecs_tw.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb2c46e028c44069573bb724f89f162b90cdb103e9239e3d315394ce7c48b612 +size 140624 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_csv.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_csv.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..103f3a1185c7a460a7f7254708cb10da7f51d952 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_csv.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50710994e9e43c7a3bca982f77c2b6984d40e10b32a5bfefa7979df11f7eca71 +size 133160 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ctypes.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ctypes.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..d459c68de2bf8111c7c54dd640bfc42d5da72f07 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ctypes.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae8a0b9179cb7579ca87cc636946840ef8ceb212483efa502b10b630f7025a26 +size 550664 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_curses.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_curses.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..8ca37b2210dc6338277727ab31730e3a250b1d53 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_curses.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9346cfb4462733625b83ef4ad5a0ec9c63cf115421625f97a0d15fba2db986a +size 491312 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_datetime.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_datetime.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..4b9e135ba9105d19e10f4a87b7212873bd2d0577 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_datetime.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dacd807b96ed1f841f8794748436792f1993d2f6e52b35b3efa2d54fa1cf2c6e +size 584432 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_decimal.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_decimal.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..5b4a40e019de517315bb27016ab3669002df8e8b --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_decimal.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:586d9cb10e5ca4667ec31da0ac91cde2f2e523b1b13a595618bcbf10efab5025 +size 1489456 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_elementtree.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_elementtree.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..96928e28950362f553425e749847b4cccd1eb3eb --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_elementtree.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d407f6e50064f0a44c0746c21fb803f353ba9d9c53f9ec37bb15eb381c45e76 +size 330632 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_hashlib.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_hashlib.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..5b20185242d792a8eccc199ca0776a5aac45020e --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_hashlib.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:520ca0536ab8209a74fa49a56a129a2fe765c01c057158b270276b4bf54f24c5 +size 197448 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_heapq.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_heapq.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..bc217d9424541dbdad00511edd15eb6739efe819 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_heapq.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff8c6445a506d6b671a188cfdd0c0703ec8a0e0c577a5894f797950295b46e24 +size 101264 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_json.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_json.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..dd44ea7040a84b1665e4a5d226bdae115bce0046 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_json.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ffbd43d7383904df4eb473a446cc9739ddb28b10e6c2fdfb04aa62c87cd06a3 +size 159256 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_lzma.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_lzma.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..92c3b5838e08d3a0ae1a0023894b924eb46889f5 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_lzma.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa862cd837fdb5632871502951b84c3f02c67458f53ab0b2974c38d7e2ab4f0b +size 146344 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_multibytecodec.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_multibytecodec.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..b1b5f00bc8c78036a6841d4600146b8e370cf5c9 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_multibytecodec.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4097694ac4154a11d9f489ebc9bf98273a69ce44bdbef62c23366ae3deeb2cfc +size 202560 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_pickle.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_pickle.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..d2b5a3d6d8435d4c6a899771f5cea238f7f3ba02 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_pickle.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:863d926884c8e7631f3f16388048d6de76f4c61456358a39d22e6e9f665f96fd +size 515152 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sha3.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sha3.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..c3a142041aa28d8d3a0ce417ac80f215b318c8e2 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sha3.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a93e46d4b46312cd1231fe06f284c867bb7563531e168f15f119fca8f1ba0da6 +size 518120 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_socket.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_socket.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..2d3f9bc84fc9a39ad629d9af3e847cea99e4d2fc --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_socket.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d8f9045c3a7ebc5089a567ad95978e4b275fc8022b3da16a78c37947dfeaea2 +size 281840 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sqlite3.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sqlite3.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..de723ba7d104b16e1f324db27f519343c2ff6409 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_sqlite3.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f6a6e10aa5618dbc8bab052518d3bbc215b07af451c08faca062c6f4ead47fd +size 473424 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ssl.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ssl.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..c6579ee078feb4f84d9d930d6b550ddd9f968da0 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_ssl.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb1842d9e8d92322e833bcf0be7c5b94d4f02d42f8e38265725234918a3b98f8 +size 496616 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_struct.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_struct.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..cba375da5086f9b903e3d6928963e0c51e2a96f3 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_struct.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd42cb99fedbf703475cb7f2cdbd1c7efc163d4712e14927a665e204ce5e07fe +size 209216 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testbuffer.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testbuffer.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..b6856b36ed45ddb55a43cfa40e71db9ce47770da --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testbuffer.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6302d431e7e422b800bab2ef76b629fcd661668cbc558c83a305edc993baef4e +size 193408 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testcapi.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testcapi.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..040c4a4ccb4d0f7b1074c1a7e94b070fb2efb199 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testcapi.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29854b99f1e9510cac22b6eb20c895b5b3d81758c9847a8cb1db8a968ba3840b +size 488448 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testclinic.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testclinic.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..95def2d7949b537276f4bbce217ee91bcb6fada9 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_testclinic.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a4da6bf889d403b88feb85772e232cc6da1de8c58f322c72e4261bd11fbaeff +size 207936 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_tkinter.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_tkinter.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..f855bdd46fd5495ff2f669cf930dccbabd9397fb --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_tkinter.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f616f226b1e9b75591812d2422790c462401b36d096bb483cef14f8806a7245 +size 221120 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_xxsubinterpreters.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_xxsubinterpreters.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..85602829c7dec5d53efc907ee7d2674d02cac12b --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_xxsubinterpreters.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:846fdbe0df768f00ed25dd4d2cb3a39e3f386a5c221cbe06536b6422c72c2804 +size 149600 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_zoneinfo.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_zoneinfo.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..3a266997bb9d788d0e8c78f72368cdcb5079f6fc --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/_zoneinfo.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:80bc0a26f873b3ee04c2d9199fdf18078a2743ae70157fc35eaa2964f9fe8c68 +size 163232 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/array.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/array.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..74de6a609f27d86ac4889492212c0583a362c1ec --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/array.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea7ffef4dd8c01a3954e7fcdb987fac192839187e52dd09c398724b9f8f1a034 +size 224920 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/audioop.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/audioop.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..fd52d41f3979384d5c7912a9a0fc433ab1e6ad6e --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/audioop.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82d402f1be81fc8d269b9a0c1c367cf799ed8191e5d1d82305c1e24f2b2c98a7 +size 205200 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/binascii.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/binascii.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ece69b596e2bfa9e850b3344a8011e54e7090f3e --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/binascii.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:baf712761dc2fe728a6d54b8ff4c9d2980a2f2e04d14c596e47105bd851a4bf3 +size 114232 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/cmath.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/cmath.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..3826a3db4bd7220e53a2159a1344e4077eea7239 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/cmath.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d94358521a29eb7c00408d52575a7336f9924450702bd705dc824483a6401803 +size 178008 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/math.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/math.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..91bc052e0828d5a4c1d7a36faebbe65919810b17 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/math.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21eea68df4dd74b6303cad22b4dfe8275ff0562306add1396712dcfbe4b58fc9 +size 244832 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/pyexpat.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/pyexpat.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..a1290be198c65ad0db66a8f138b0e054b4b41cf0 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/pyexpat.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:262366cfb731901910e22fb4457ba127db69d8925c543c6e852afd921340618a +size 243120 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/readline.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/readline.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..9db5ed733b495706c38605f38f8f80aecc6376be --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/readline.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d17ff052bd1034b2047249c1801505f5364212a79eaaa69c0c9c2c9a4eb3cd6 +size 113264 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/select.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/select.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..092101260802ce101c2ba6ddeb7a7e6ca350d3e4 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/select.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86f17b3f66d54dec07c9fbabf3e0d563d590842bcde53815650ec9941bfe4b08 +size 113432 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/unicodedata.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/unicodedata.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..1cfca1f2aa951b15738be286b970856c1b6c3690 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/unicodedata.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23e94eb6cbe85a7525e7bd1cd12b8bfe8cb2e1560c11befd09218ff0b12907c0 +size 1209624 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/zlib.cpython-310-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/zlib.cpython-310-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..e07209fb29675852edd31780c72ced2ccff1afb1 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib-dynload/zlib.cpython-310-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:568685ef9dde8836c1c113b560320e336b0f452c7c0ca2892c3575a80f61f6c4 +size 137616 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/Grammar3.10.20.final.0.pickle b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/Grammar3.10.20.final.0.pickle new file mode 100644 index 0000000000000000000000000000000000000000..83bf5040259fd33c076f2a97b05a5e88cd70efe7 --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/Grammar3.10.20.final.0.pickle @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97c8ed74d091fcfd23498029bb819c29d096c3dcb1326edee5dfb0591ade2e4b +size 15313 diff --git a/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/PatternGrammar3.10.20.final.0.pickle b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/PatternGrammar3.10.20.final.0.pickle new file mode 100644 index 0000000000000000000000000000000000000000..e9de5e3aa351535c40c4d95139afac6eb97e675d --- /dev/null +++ b/miniconda3/pkgs/python-3.10.20-h741d88c_0/lib/python3.10/lib2to3/PatternGrammar3.10.20.final.0.pickle @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36ee934395b9209737b13893ddaff05fad8e239c2fdfac29d401d3fceeb30768 +size 1225 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python new file mode 100644 index 0000000000000000000000000000000000000000..251403509e6a2e92034f784abc547e82fbd741c4 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:769d834e5a949bc5c6d8562855d7050cf259dfc7c30da1b07770f591910727e8 +size 32010488 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3 b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3 new file mode 100644 index 0000000000000000000000000000000000000000..251403509e6a2e92034f784abc547e82fbd741c4 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:769d834e5a949bc5c6d8562855d7050cf259dfc7c30da1b07770f591910727e8 +size 32010488 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.1 b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.1 new file mode 100644 index 0000000000000000000000000000000000000000..251403509e6a2e92034f784abc547e82fbd741c4 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.1 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:769d834e5a949bc5c6d8562855d7050cf259dfc7c30da1b07770f591910727e8 +size 32010488 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.13 b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.13 new file mode 100644 index 0000000000000000000000000000000000000000..251403509e6a2e92034f784abc547e82fbd741c4 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/bin/python3.13 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:769d834e5a949bc5c6d8562855d7050cf259dfc7c30da1b07770f591910727e8 +size 32010488 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so new file mode 100644 index 0000000000000000000000000000000000000000..74e0a0bf6635a5245a83cf860d5ca077b13a98b3 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03d70ad22a7a821f1c95d55c8f5ba1da9de2096e9f1647476313906c4f55c210 +size 31949680 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so.1.0 b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so.1.0 new file mode 100644 index 0000000000000000000000000000000000000000..74e0a0bf6635a5245a83cf860d5ca077b13a98b3 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/libpython3.13.so.1.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:03d70ad22a7a821f1c95d55c8f5ba1da9de2096e9f1647476313906c4f55c210 +size 31949680 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/ensurepip/_bundled/pip-25.3-py3-none-any.whl b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/ensurepip/_bundled/pip-25.3-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..cad5b10cd1247ac54c172acf62a9b6ef5fae6bc1 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/ensurepip/_bundled/pip-25.3-py3-none-any.whl @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9655943313a94722b7774661c21049070f6bbb0a1516bf02f7c8d5d9201514cd +size 1778622 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/folder.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/folder.gif new file mode 100644 index 0000000000000000000000000000000000000000..b8f417629c16e88c45393133a5a2bddadb065dd7 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/folder.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c98d566a13fd599d1c11a375f387fef69b6c595c4f18c5d88c188a860be0e55 +size 120 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.gif new file mode 100644 index 0000000000000000000000000000000000000000..45f0c2ca179d883c56d835a230b64b03b699bc90 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe3af292b38660a8a58b1a8b4fa4240aa190602e7e9a700ea0536b3181fc968e +size 634 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.png b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.png new file mode 100644 index 0000000000000000000000000000000000000000..46cc2af81a39625ec111aaa2bed58fdda1717793 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_16.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78fb3fb0ec11f61bc6cf0947f3c3923aa18e1c6513684058ed0fa01ac858143e +size 1031 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_256.png b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_256.png new file mode 100644 index 0000000000000000000000000000000000000000..4ec4ae94cabd662ac9e4476172fa5d606679a5f1 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_256.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6f573efc06f2b2edce284c5758bd94344114547eb4c5e26baa8453eeaa91cf1 +size 31216 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.gif new file mode 100644 index 0000000000000000000000000000000000000000..89a600532f00e4d206bbc8a59b6baad82fd9dab1 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe70991cfccd1267922e94d91e02e9a58d2d29fd3382a2f4975280b9023cb7b9 +size 1019 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.png b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.png new file mode 100644 index 0000000000000000000000000000000000000000..464aceda8b1fa6e98d3553572e40ebe7d2de2ccb --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_32.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:797cd05f1964d57c4c6c248ac7f7ea6a38019ada32a9ab7e6c28d060f87b03de +size 2036 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.gif new file mode 100644 index 0000000000000000000000000000000000000000..8c44232f6288f2948637bf3c44522cf7230637a3 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37484901eb40eefa846308e1da3ff6f240ea98f769a2afc3cf4fdba00327ecbe +size 1388 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.png b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.png new file mode 100644 index 0000000000000000000000000000000000000000..fbc92eb6d2d6815ba8c9e1bfd38bccc643da84c1 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/idle_48.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a09f433197c8870b12bb7859cc4c3fe2068908cb1ddbd4880ab0f6fee91b6c23 +size 3977 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/minusnode.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/minusnode.gif new file mode 100644 index 0000000000000000000000000000000000000000..98541201db0e2935a0d113f67171d253473005e2 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/minusnode.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:efa5aa1d1e3439ab85425bd2aa3a25b9e6c21309e672690cfb32219e1eb7a7f3 +size 75 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/openfolder.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/openfolder.gif new file mode 100644 index 0000000000000000000000000000000000000000..91b37619cc0326db6bfc6faafcafde0322fb69b5 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/openfolder.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a59e2abf1840156e9db8f85a38822fd56ab79a139eb95ec86f1fba1bb87326b +size 125 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/plusnode.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/plusnode.gif new file mode 100644 index 0000000000000000000000000000000000000000..c4c7e864238f9fcfe272ea6754ea84c7798add1e --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/plusnode.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ace9e90a2bcb16d06c4d78837137f2c14bc26b3bd9f24b7b6afeadb689bdafb +size 78 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/python.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/python.gif new file mode 100644 index 0000000000000000000000000000000000000000..2d73d19be477b8af5f50c7712a2ce1be9db9c20d --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/python.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:158c31382f8e5b41fded0c2aa9cc66a382928b003cdd8b5b0518836ad9c89377 +size 380 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/tk.gif b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/tk.gif new file mode 100644 index 0000000000000000000000000000000000000000..666c5cc86c65a985eb2a962f850bdad58178d64a --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/idlelib/Icons/tk.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f16cb2e322891dbd9101302c09ffda0c2a3a72d053bb8c0927d507414c59cad +size 72 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_asyncio.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_asyncio.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..f6fce9be14c9f19720856a615624f1ab57ba4460 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_asyncio.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59071fd9f38f29bdf8eb209766a772c539bb36e039e93b02d496fc2ce5502285 +size 378360 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_blake2.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_blake2.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..1d5aed437f32216f39fdef6795cc49af87bc7359 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_blake2.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:057752d8bafde05229935293f4e762dd855863a2a2e76650d0fec5a2a715b120 +size 399720 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_cn.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_cn.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..fece76f33b66b71adc507090381397c48f9ca60d --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_cn.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9469d64f3ef8f60b46df8268f6a5e7a822b2686c2982233fdcfe7f7ec405a182 +size 195008 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_hk.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_hk.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..76b38a9482984c19155aa99eee9600843afebb9c --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_hk.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:240f317b1fd7a6eae0ad8c6bcc6316f0f522be1b25b48578251415aa6d69d4ce +size 193840 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_jp.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_jp.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..8a2760f18da3ec0bc8efb694316f3b14dceb70fb --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_jp.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb48bee1bbfa44df066d7815c6ea7f7cc3a92a43cb95d0da17c696589fccf316 +size 326528 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_kr.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_kr.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..e702eab2b2a69209fc068357276fe30d7947814a --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_kr.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43f74bf14ae692e9cd3c61162deea72d995f2360c6a3c744b8c17ecfd47b6c82 +size 179832 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_tw.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_tw.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..abf3187d900c476678696c17bb3c47167681b4fd --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_codecs_tw.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:005e8a3bea9d343410f75a46b99a7d757e39cbb7cf3b008512bfc077983a9e11 +size 143184 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_csv.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_csv.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ea7aa4edc1fde8db2b3afa9e6d4f31e7d0b50f52 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_csv.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1308dc29ca055484eecffc5dee60374da92f7e82efe6a20928c89143986b3a5f +size 144576 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ctypes.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ctypes.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ba242e258625624288bb96d71b653be165f731a2 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ctypes.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c23fe6e227e0091f0acb2a19d86229542e4889181917de3059434e43ef9443c8 +size 948176 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_curses.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_curses.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..b84cefdfbeaa87234d6e29457be6ee8e31ce36ec --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_curses.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:034d217ed1c9f28a6c174d941a4f9476271cadd8d194a0e596e8c138728711ac +size 576024 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_datetime.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_datetime.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..19330bd0e028b6fc69efd957331d5200c80c4b17 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_datetime.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b952c3ac5ca131e73039bc55e7d81e0ac8894d63e322af5d5e2a0cf1d2baf40a +size 785784 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_decimal.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_decimal.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..b605c5895612f264ef752b9b311530017c5ab41d --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_decimal.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:735a38e0f82e403e4348906633d6f73733ac60bcd4756eec577aba1acb7344f7 +size 910824 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_elementtree.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_elementtree.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..a1142314a0741a729a5c541980282cf568b638fe --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_elementtree.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f235cecdf551ae94257247c0fba368048df517bbabc92f8b38e963481379f62 +size 501648 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_hashlib.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_hashlib.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..7c4d961acc6bb0ff3c5d8f8959e04f4bc18d44a7 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_hashlib.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8daf317f09f9302710bf5aa6e5fe3b65959880502c3be9e1b57bdee0b86b104e +size 236024 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_heapq.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_heapq.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..0dd00812205a7003ab81b04654352c1870a2436e --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_heapq.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbf49e24b96ea1f2fa98356cd1ca3f0f82e6f6bf1b7c854248422b18a604d470 +size 113128 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpchannels.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpchannels.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..3882c92e0730670470075ce0fe441a8a953ba541 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpchannels.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97188debeed6faf6fe1623e6f6fe084cf78488f6af7bd29d718f5c5fe49a4c9e +size 303528 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpqueues.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpqueues.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..a16c91df6d40c7431b6d980a72a80e42e9c2019f --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpqueues.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5a881eb3a45c63c2d377cb21a56bbad71d4def9ebf98c520fd50e8343860b9d +size 127648 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpreters.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpreters.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..4d870274b558186f98efe24086b6c415c824fc1b --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_interpreters.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abfb65c21fc379027d9732a31aad39cadfdcd9c23727d81213ca9f4835b9336d +size 201048 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_json.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_json.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..987d8ef0e6551d91970ff5443a2f493dc91c30fd --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_json.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c87ff1007b521b82a8f43165016981857622af7a2a6d18a6f6a5a3339d10bec +size 299848 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lsprof.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lsprof.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ea5900a6655e53fff01109e2b2669510437993fe --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lsprof.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a710534e8f13100e6e9a11643085c156e2b665fefd2042a02006b7d79e54e04b +size 208032 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lzma.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lzma.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..fcf62768ef0272cf509735948154799a62b9933c --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_lzma.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b4f6bd8499913b8ff622e3ccdb1232a3158be9f81dbead5d6df2a56f38562870 +size 161912 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_md5.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_md5.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..242a9f76623d6e9b276fa00bada799837ed9d8e6 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_md5.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc6480f75da4ed3e1ecaa88b81ee6b805a7e471d51464cea477ee9a3def3dd90 +size 140656 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multibytecodec.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multibytecodec.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..92ae284b0250fd3b7f1ef375a22460a1eb34db4f --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multibytecodec.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed0cd28b6049edf770c25801ffa52d65d8e7ad9929ca48ae5524076b8b8edd56 +size 225160 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multiprocessing.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multiprocessing.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..de681aba15263983df8a286c6ef35be35a47feb1 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_multiprocessing.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bad32ba1bbfe837e30a0387757c60592a9993ba70c6871909606d74d0ca62aa5 +size 163608 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_pickle.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_pickle.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..d5dd2f7356457cbc696e422692a0b5fed1705049 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_pickle.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4238cc322109edf369df169ee39e2de27488e5391fa9aa0679dc1f922ef916a7 +size 685784 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_posixsubprocess.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_posixsubprocess.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..bed6d36b92d7d39288ce3b6aad986c75d944eec8 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_posixsubprocess.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ebc61dc040710a0a4fac8648d14a78d1c139362341fced74e0cb0725dc8ceac +size 188832 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha2.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha2.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..13740000f491849c0451658fee4006d79edde0d0 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha2.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e58cde0033ebf41f765428f9c551dcde06a5eef7f3611d5fc48e62bbd1d2fc49 +size 1172184 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha3.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha3.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..b04d5d910ab996b71cb4bd7b623752f50461c02f --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sha3.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e4cc4e8f15fd0a2fa16e09096c818dacdc5fc213f775d65e9d82c8fe48ecfa5 +size 214968 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_socket.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_socket.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..e03d44f507e0ec269f58cf28ebd28c3aecdfc27c --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_socket.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a70b9471f1ecd5a2e6eda1247060b9228a9c475bd6dc59297e883701003d8a8 +size 323008 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sqlite3.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sqlite3.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..a1ed5f2094108663584715411a05955048b2efdc --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_sqlite3.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbe1e966a682ad68eaf106ff0b0129465692e5ac3d390e8c3ca8e70185a496a3 +size 907864 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ssl.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ssl.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..576feee2594af98537f9e993b3045adeb1df67f6 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_ssl.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82d3643a577987548f2079892f4a448bdcd0f97d482f3f6a5e140a8e84dfdeb6 +size 638296 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_struct.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_struct.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..91a276222b0fd5d770aa4c400ff684aa6451c1a8 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_struct.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a213e28d3ad83ff68a04427a08ca715059d250cf1f1db6b4c97e180b51f40b5 +size 221656 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testbuffer.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testbuffer.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..c806685d556e8acd713bd7408b6ab6015006b582 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testbuffer.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2629e364fe78ad7e417501341aee04fbc91f1a8ed6a6d6129490661b4f345cdc +size 211528 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testcapi.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testcapi.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..2300e2afb8046958e5b04112bfd1116d3f9654aa --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testcapi.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06ea856d477f0c443b6ccd52d5aab5cd0e6ad341de0bfd7241605d0888195047 +size 1207992 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testclinic.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testclinic.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..0d473d2a5a6d1801e8444093841105f37269c4df --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testclinic.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a369256b0fe0c4454b4bd1ce0d215db6e384bed8a5a80a6b85071b4c1b6a2384 +size 501176 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testinternalcapi.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testinternalcapi.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..3b5c4b67c3f49a1cdda5c80e487979b6372d70e3 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testinternalcapi.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1b7a2ae2d20d69672b700e32b11839620d2413623af26af8ac5f81b7b27c480 +size 430488 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testlimitedcapi.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testlimitedcapi.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ef98bbef71ac1b853a4bf2b4bd152af3f8c45897 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_testlimitedcapi.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8df707975fa10030a994e6ccb73f8711ae81ef76408f97d6fe033aef166bd0a +size 709640 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_tkinter.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_tkinter.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..4e4632a978a350c903683763f6c9ba03128861fe --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_tkinter.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b46e6a9b5c41e93790fabb50d0bd0d5d0beb1a4c53bfd8f301f936e886e77baf +size 324352 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_zoneinfo.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_zoneinfo.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ab79f7d3839a8615ab9af4309b3e47dc566f843e --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/_zoneinfo.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53cf6bed717c327ce0ca3694c5b0b18cc2d0fdfa020e3a0186262ffce428fbc0 +size 263616 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/array.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/array.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..5b75f75778fb23e5744f8115d9c03ab3b6902f5c --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/array.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7566ee387561ea61ff83381eda0df9f044d1cd4bf183252337757c0cdaeecca +size 268200 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/binascii.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/binascii.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..8212f485e246daf67252f58604a0c1fca44498ef --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/binascii.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:761de4c45331416a8b12ea77eced4f27548338fa6c50f4750368255f17589b02 +size 193976 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/cmath.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/cmath.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..1cd3ad3ecb66117f6283767cb380bbb1ba5286c2 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/cmath.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b83228fb47e0e308e3fd57dd597573addfe2ab2e4e94bd275d0a14bb3a3f6da0 +size 166576 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/math.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/math.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..404562a6e0f9d4b2379ac8fccbcde6e68604e79e --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/math.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a344cfb66bccab084cc36c14e23a62b23d041cbeea7f414e410c9e4ba03e0c81 +size 390648 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/mmap.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/mmap.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..3f44666f46f0c768f47fe9f50737d48f2dbad7f4 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/mmap.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f76d37f3d011c68da3aeb6416bafe62f57782946f2413b94120ee1eec5b690ff +size 193208 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/pyexpat.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/pyexpat.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..ee9dce48ee39f5f1eec556de5299d06dec581323 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/pyexpat.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4647320d007cfced69ff80e3c7c3ae81d63f37d9e446d63cd2b73c4fd9bc502f +size 334320 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/readline.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/readline.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..10e0a28744c35c4f3f95cffe34b8672dfe456820 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/readline.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e802adf9efbd79e39d91b76bff82ac718d4be834578037acc7d46f1b2388af2 +size 210384 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/select.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/select.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..cc13e5a39b0d72612c7940af5acad4de7407a0a5 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/select.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb57a6cb7288fd5ef8c70965c43629ce5cb5bc4e2907f2845983691928f6a7b7 +size 211912 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/syslog.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/syslog.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..1bd6eea2f04d3471eba3a65fc89da008ccf56b21 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/syslog.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c9c1db955ad910871f687b51a78a35db535d3a6357a168d36eb7f9d1138f620 +size 147984 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/unicodedata.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/unicodedata.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..7ccc8924e10787918b3af223815c22a0b2e3fde6 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/unicodedata.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff91c0bd712ee04ec887e5899b633a5b16290ccb296a096a911164e51af0286b +size 818104 diff --git a/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/zlib.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/zlib.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..cbf26b09da9a96f732b6a1f490a7ec86067942b3 --- /dev/null +++ b/miniconda3/pkgs/python-3.13.12-hb7b561f_100_cp313/lib/python3.13/lib-dynload/zlib.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:19a2df0de1659c098ddc0f636788aaf29c78b74fe670f1a67afef9780cf4a0b6 +size 165360 diff --git a/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.a b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.a new file mode 100644 index 0000000000000000000000000000000000000000..8d66ebd8d512e241dfaa2c74b5ae4c6f4329cb8b --- /dev/null +++ b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.a @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2152fb16bced27b27afe89781277814c2f6d03e775abb7ff1a90ce9c6d1ae0ee +size 796336 diff --git a/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so new file mode 100644 index 0000000000000000000000000000000000000000..cb7e397eac1c08ef1944f53eb470d31360848c21 --- /dev/null +++ b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4f8e11f9697c71faeaa42de41da4b0ae59d182f47e9d95720288efa4c412ad1 +size 430464 diff --git a/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8 b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8 new file mode 100644 index 0000000000000000000000000000000000000000..cb7e397eac1c08ef1944f53eb470d31360848c21 --- /dev/null +++ b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4f8e11f9697c71faeaa42de41da4b0ae59d182f47e9d95720288efa4c412ad1 +size 430464 diff --git a/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8.3 b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8.3 new file mode 100644 index 0000000000000000000000000000000000000000..cb7e397eac1c08ef1944f53eb470d31360848c21 --- /dev/null +++ b/miniconda3/pkgs/readline-8.3-hc2a1206_0/lib/libreadline.so.8.3 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4f8e11f9697c71faeaa42de41da4b0ae59d182f47e9d95720288efa4c412ad1 +size 430464 diff --git a/miniconda3/pkgs/ruamel.yaml.clib-0.2.14-py313h4aee224_0/lib/python3.13/site-packages/_ruamel_yaml.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/ruamel.yaml.clib-0.2.14-py313h4aee224_0/lib/python3.13/site-packages/_ruamel_yaml.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..f8655979003b215126183751f7210a9edd0301cf --- /dev/null +++ b/miniconda3/pkgs/ruamel.yaml.clib-0.2.14-py313h4aee224_0/lib/python3.13/site-packages/_ruamel_yaml.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee449f85f308e5b5296f1f9601dee1c3febffccc443150e835f105fc9ddc547e +size 395376 diff --git a/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/distutils-precedence.pth b/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/distutils-precedence.pth new file mode 100644 index 0000000000000000000000000000000000000000..c659194195f07bd6f19b5522515551309af14a3d --- /dev/null +++ b/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/distutils-precedence.pth @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2638ce9e2500e572a5e0de7faed6661eb569d1b696fcba07b0dd223da5f5d224 +size 151 diff --git a/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip b/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip new file mode 100644 index 0000000000000000000000000000000000000000..400905eecf0385de4d3b8e50b9892e1302b2b894 --- /dev/null +++ b/miniconda3/pkgs/setuptools-80.10.2-py310h06a4308_0/lib/python3.10/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01845c437f4655e3cf9cc4fc4e49cfd607431f22675e1b611129a90239f34822 +size 1809 diff --git a/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/distutils-precedence.pth b/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/distutils-precedence.pth new file mode 100644 index 0000000000000000000000000000000000000000..c659194195f07bd6f19b5522515551309af14a3d --- /dev/null +++ b/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/distutils-precedence.pth @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2638ce9e2500e572a5e0de7faed6661eb569d1b696fcba07b0dd223da5f5d224 +size 151 diff --git a/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip b/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip new file mode 100644 index 0000000000000000000000000000000000000000..400905eecf0385de4d3b8e50b9892e1302b2b894 --- /dev/null +++ b/miniconda3/pkgs/setuptools-80.10.2-py313h06a4308_0/lib/python3.13/site-packages/pkg_resources/tests/data/my-test-package-zip/my-test-package.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01845c437f4655e3cf9cc4fc4e49cfd607431f22675e1b611129a90239f34822 +size 1809 diff --git a/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so new file mode 100644 index 0000000000000000000000000000000000000000..ed59a32135b7374e1a961c268fd6286682663cd7 --- /dev/null +++ b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:594d33f7e22af14c9f6b47f5acdb178b077f6ae78cc27011eaf69006aa8959c1 +size 217928 diff --git a/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23 b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23 new file mode 100644 index 0000000000000000000000000000000000000000..ed59a32135b7374e1a961c268fd6286682663cd7 --- /dev/null +++ b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:594d33f7e22af14c9f6b47f5acdb178b077f6ae78cc27011eaf69006aa8959c1 +size 217928 diff --git a/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23.0.0 b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23.0.0 new file mode 100644 index 0000000000000000000000000000000000000000..ed59a32135b7374e1a961c268fd6286682663cd7 --- /dev/null +++ b/miniconda3/pkgs/simdjson-3.10.1-hdb19cb5_0/lib/libsimdjson.so.23.0.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:594d33f7e22af14c9f6b47f5acdb178b077f6ae78cc27011eaf69006aa8959c1 +size 217928 diff --git a/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/bin/sqlite3 b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/bin/sqlite3 new file mode 100644 index 0000000000000000000000000000000000000000..7881fa8619556a6b2b02bc58c12e7abfb201c467 --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/bin/sqlite3 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5089110e1eba89e350ecf23fb89b9abe7dabbf0bc7fe916faa9d29bcf6fe86f4 +size 2015408 diff --git a/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so new file mode 100644 index 0000000000000000000000000000000000000000..5291aa98347bedabc7adb96335188a0a72546ed5 --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ff176fff66e4a603f4b6f709f64d90a35d74cf12a3c1ee2a18919446f32489a +size 1488352 diff --git a/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.0 b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.0 new file mode 100644 index 0000000000000000000000000000000000000000..5291aa98347bedabc7adb96335188a0a72546ed5 --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ff176fff66e4a603f4b6f709f64d90a35d74cf12a3c1ee2a18919446f32489a +size 1488352 diff --git a/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.3.51.1 b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.3.51.1 new file mode 100644 index 0000000000000000000000000000000000000000..5291aa98347bedabc7adb96335188a0a72546ed5 --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.1-he0a8d7e_0/lib/libsqlite3.so.3.51.1 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ff176fff66e4a603f4b6f709f64d90a35d74cf12a3c1ee2a18919446f32489a +size 1488352 diff --git a/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/bin/sqlite3 b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/bin/sqlite3 new file mode 100644 index 0000000000000000000000000000000000000000..ab8e9a346d64e3a07d079aad23753520ca6f54d4 --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/bin/sqlite3 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e33aef9a4c1f98fc47a3054ab122ad4c34883bfa60a4e56f8f55f60f2cb28d43 +size 2015408 diff --git a/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so new file mode 100644 index 0000000000000000000000000000000000000000..8d24b28a739864d50f17209a37bb1350ee1b511a --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9da9c9112213c609d1f9cffcd96b6d44338ac80a69f13af1ef314b23d78f5b2 +size 1488352 diff --git a/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.0 b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.0 new file mode 100644 index 0000000000000000000000000000000000000000..8d24b28a739864d50f17209a37bb1350ee1b511a --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9da9c9112213c609d1f9cffcd96b6d44338ac80a69f13af1ef314b23d78f5b2 +size 1488352 diff --git a/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.3.51.2 b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.3.51.2 new file mode 100644 index 0000000000000000000000000000000000000000..8d24b28a739864d50f17209a37bb1350ee1b511a --- /dev/null +++ b/miniconda3/pkgs/sqlite-3.51.2-h3e8d24a_0/lib/libsqlite3.so.3.51.2 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9da9c9112213c609d1f9cffcd96b6d44338ac80a69f13af1ef314b23d78f5b2 +size 1488352 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/itcl4.3.0/libitcl4.3.0.so b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/itcl4.3.0/libitcl4.3.0.so new file mode 100644 index 0000000000000000000000000000000000000000..c9624bcb2f6ea65e8005ba4d116594689dedc08f --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/itcl4.3.0/libitcl4.3.0.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1764f24042ddab382f4df0cf3eb5cb4675d147404ec202a1894b53fe2e8924f1 +size 318840 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtcl8.6.so b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtcl8.6.so new file mode 100644 index 0000000000000000000000000000000000000000..4a17a99d7dd623900f102ef622fb3c0e655e167d --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtcl8.6.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85bcc1538db35465f5abc0a60cc01d5b71b388660ff9366024db5c1608f50624 +size 1987776 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtk8.6.so b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtk8.6.so new file mode 100644 index 0000000000000000000000000000000000000000..3962e15d686378ce5b2c1c6fe3aadb15c11863c1 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/libtk8.6.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:683189caa5543909c64fd6af77f8b594a8821d9d29c2507dafa4af65cee95272 +size 1617880 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/sqlite3.45.3/libsqlite3.45.3.so b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/sqlite3.45.3/libsqlite3.45.3.so new file mode 100644 index 0000000000000000000000000000000000000000..1b6cfe0ef88c85b927c920025782ed7794cf7305 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/sqlite3.45.3/libsqlite3.45.3.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2700af09320a58e113e33aa1af72ff2d3d4ff3b52c1d57bb5c8fafe80a1829f +size 1623720 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earth.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earth.gif new file mode 100644 index 0000000000000000000000000000000000000000..4261c334b50676b1528252b6ecbb29a5e322c469 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earth.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf29c94949f125a04fee6bdf93ba8f358f26e9e39aa7a4977466834b3133fcb7 +size 51559 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthmenu.png b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthmenu.png new file mode 100644 index 0000000000000000000000000000000000000000..5e8870f9cb699c1f8fe06cf091be65c5549fbe4e --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthmenu.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9bf8d96016039d7fdb2ffc506743724636a70ed5925199aab64ca20820963bde +size 8157 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthris.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthris.gif new file mode 100644 index 0000000000000000000000000000000000000000..a104d736b72a048dd959acf484cda77ac58aa84b --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/earthris.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2da473e55d8317bd1f983638adb729bff1461de590d76f99d8b3430c71e0f6e +size 6343 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/ouster.png b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/ouster.png new file mode 100644 index 0000000000000000000000000000000000000000..9063c076c2df8672404ca52bbe9fac6160163438 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/ouster.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2fe354dfcb09b9eeb488128f4ac0b498766faf4a8becf65bbcd779bdb9c4c8f +size 54257 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/tcllogo.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/tcllogo.gif new file mode 100644 index 0000000000000000000000000000000000000000..1594bc2df6786ff7e444f5eddb3bdc298d5f260d --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/tcllogo.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72f6b34d3c8f424ff0a290a793fcfbf34fd5630a916cd02e0a5dda0144b5957f +size 2341 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/teapot.ppm b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/teapot.ppm new file mode 100644 index 0000000000000000000000000000000000000000..59307eb96ee451f7682034add2d2737673ef04c2 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/demos/images/teapot.ppm @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:786f29b88771e439187dd2e86ad4d255dd185e0c1ea3f8c37d21770fd1df253a +size 196623 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo100.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo100.gif new file mode 100644 index 0000000000000000000000000000000000000000..1594bc2df6786ff7e444f5eddb3bdc298d5f260d --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo100.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72f6b34d3c8f424ff0a290a793fcfbf34fd5630a916cd02e0a5dda0144b5957f +size 2341 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo64.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo64.gif new file mode 100644 index 0000000000000000000000000000000000000000..1401554ec80451603fbf50973d2ed612e415cc4f --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logo64.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:138c240382304f350383b02ed56c69103a9431c0544eb1ec5dcd7dec7a555dd9 +size 1670 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoLarge.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoLarge.gif new file mode 100644 index 0000000000000000000000000000000000000000..b41b8a09800766fa7b915c0f825d79929196c253 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoLarge.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f404764d07a6ae2ef9e1e0e8eaac278b7d488d61cf1c084146f2f33b485f2ed +size 11000 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoMed.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoMed.gif new file mode 100644 index 0000000000000000000000000000000000000000..d55684babccf7e0be627fbddd3acdaac970a88fd --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/logoMed.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d0bd3228ab4cc3e5159f4337be969ec7b7334e265c99b7633e3daf3c3fcfb62 +size 3889 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo100.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo100.gif new file mode 100644 index 0000000000000000000000000000000000000000..fc42b0335005a22bd368352017a9d84045745120 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo100.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcc0e6458249433e8cba6c58122b7c0efa9557cbc8fb5f9392eed5d2579fc70b +size 1615 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo150.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo150.gif new file mode 100644 index 0000000000000000000000000000000000000000..e8eb2d43ff9648869a6e77cd691cef3e0b44d72e --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo150.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5fc25c30aee76477f1c4e922931cc806823df059525583ff5705705d9e913c1c +size 2489 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo175.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo175.gif new file mode 100644 index 0000000000000000000000000000000000000000..7e90f13b82f54a4c5388cc71ccd8bc0ffea375fe --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo175.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62866e95501c436b329a15432355743c6efd64a37cfb65bcece465ab63ecf240 +size 2981 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo200.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo200.gif new file mode 100644 index 0000000000000000000000000000000000000000..64fc3bbb41fa399ea8bc12b720934b3efd9a2f29 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo200.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bad9116386343f4a4c394bdb87146e49f674f687d52bb847bd9e8198fda382cc +size 3491 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo75.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo75.gif new file mode 100644 index 0000000000000000000000000000000000000000..5247cb56c953663cd5608a6a19c78475b6b9a4c4 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/pwrdLogo75.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:462a8ff8fd051a8100e8c6c086f497e4056ace5b20b44791f4aab964b010a448 +size 1171 diff --git a/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/tai-ku.gif b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/tai-ku.gif new file mode 100644 index 0000000000000000000000000000000000000000..57fe342da7b1602baf6bde52c87a6a0e14f86d75 --- /dev/null +++ b/miniconda3/pkgs/tk-8.6.15-h54e0aa7_0/lib/tk8.6/images/tai-ku.gif @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e538f8f4934ca6e1ce29416d292171f28e67da6c72ed9d236ba42f37445ea41e +size 5473 diff --git a/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so new file mode 100644 index 0000000000000000000000000000000000000000..9f5b2cbc10a955ac43610ed40493c1cedac57af9 --- /dev/null +++ b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42b82811c7f974e982d9808703d6eae6f5b9fc97ff2967f1909852e7dc6237d7 +size 1460344 diff --git a/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6 b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6 new file mode 100644 index 0000000000000000000000000000000000000000..9f5b2cbc10a955ac43610ed40493c1cedac57af9 --- /dev/null +++ b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42b82811c7f974e982d9808703d6eae6f5b9fc97ff2967f1909852e7dc6237d7 +size 1460344 diff --git a/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6.4.0 b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6.4.0 new file mode 100644 index 0000000000000000000000000000000000000000..9f5b2cbc10a955ac43610ed40493c1cedac57af9 --- /dev/null +++ b/miniconda3/pkgs/xorg-libx11-1.8.12-h9b100fa_1/lib/libX11.so.6.4.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42b82811c7f974e982d9808703d6eae6f5b9fc97ff2967f1909852e7dc6237d7 +size 1460344 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzcat b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzcat new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzcat @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzma b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzma new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/lzma @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unlzma b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unlzma new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unlzma @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unxz b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unxz new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/unxz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xz b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xz new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xzcat b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xzcat new file mode 100644 index 0000000000000000000000000000000000000000..624d408d387de19bfbd675d5a3cc50a9aec06593 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/bin/xzcat @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c86ebe209e5a119ad921b150d83e310e720ec7e12c54c61aea26e07f928840 +size 118920 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so new file mode 100644 index 0000000000000000000000000000000000000000..ac1b68bd0bd93efa5f0e4c173ea18e3b2667fc66 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e54df1cc3cd5873fa0961b599cd28a86af87f3337a9021654fd1e1e8e650cb0d +size 223000 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5 b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5 new file mode 100644 index 0000000000000000000000000000000000000000..ac1b68bd0bd93efa5f0e4c173ea18e3b2667fc66 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e54df1cc3cd5873fa0961b599cd28a86af87f3337a9021654fd1e1e8e650cb0d +size 223000 diff --git a/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5.8.2 b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5.8.2 new file mode 100644 index 0000000000000000000000000000000000000000..ac1b68bd0bd93efa5f0e4c173ea18e3b2667fc66 --- /dev/null +++ b/miniconda3/pkgs/xz-5.8.2-h448239c_0/lib/liblzma.so.5.8.2 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e54df1cc3cd5873fa0961b599cd28a86af87f3337a9021654fd1e1e8e650cb0d +size 223000 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so new file mode 100644 index 0000000000000000000000000000000000000000..0c4e3db69b9184478f25e3885bf6be738b2792b2 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9adba3426700aaa69ce25f22e9aa4d88783a8696d4fabf7b2f26d2b5f40ab5b3 +size 160320 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so.1.11.0 b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so.1.11.0 new file mode 100644 index 0000000000000000000000000000000000000000..0c4e3db69b9184478f25e3885bf6be738b2792b2 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgmock.so.1.11.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9adba3426700aaa69ce25f22e9aa4d88783a8696d4fabf7b2f26d2b5f40ab5b3 +size 160320 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so new file mode 100644 index 0000000000000000000000000000000000000000..5f966b614e8d9de2ac4196d1ebe1a38a3ecce898 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bc1ff0cab92f2d630fd21e36ab65245b22a8be09120799ec53cae81d82fdf9b +size 617952 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so.1.11.0 b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so.1.11.0 new file mode 100644 index 0000000000000000000000000000000000000000..5f966b614e8d9de2ac4196d1ebe1a38a3ecce898 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libgtest.so.1.11.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bc1ff0cab92f2d630fd21e36ab65245b22a8be09120799ec53cae81d82fdf9b +size 617952 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so new file mode 100644 index 0000000000000000000000000000000000000000..5241f46ab70d192219ebd9503fce0ee76e7ccb61 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbc6c4297430b66011b61ded35723283f56c218137637e94b1f2f6d58ee2a58a +size 562816 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8 b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8 new file mode 100644 index 0000000000000000000000000000000000000000..5241f46ab70d192219ebd9503fce0ee76e7ccb61 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbc6c4297430b66011b61ded35723283f56c218137637e94b1f2f6d58ee2a58a +size 562816 diff --git a/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8.0 b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8.0 new file mode 100644 index 0000000000000000000000000000000000000000..5241f46ab70d192219ebd9503fce0ee76e7ccb61 --- /dev/null +++ b/miniconda3/pkgs/yaml-cpp-0.8.0-h6a678d5_1/lib/libyaml-cpp.so.0.8.0 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbc6c4297430b66011b61ded35723283f56c218137637e94b1f2f6d58ee2a58a +size 562816 diff --git a/miniconda3/pkgs/zlib-1.3.1-hb25bd0a_0/lib/libz.a b/miniconda3/pkgs/zlib-1.3.1-hb25bd0a_0/lib/libz.a new file mode 100644 index 0000000000000000000000000000000000000000..96fae6ec480afef803ab65861370324d36b25791 --- /dev/null +++ b/miniconda3/pkgs/zlib-1.3.1-hb25bd0a_0/lib/libz.a @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a87faa8280f7cb45c61376d4c71c5be94f3068b12162416c8b7b18e355f01a2d +size 153844 diff --git a/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/_cffi.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/_cffi.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..372b96a61d6febd77cce96aa5d473f41732e1ff1 --- /dev/null +++ b/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/_cffi.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b727e73927bc3b07d3c8aa5e726ce6ea0ff51d1c2e8c27c3d77f1a2aa30659b +size 952432 diff --git a/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/backend_c.cpython-313-x86_64-linux-gnu.so b/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/backend_c.cpython-313-x86_64-linux-gnu.so new file mode 100644 index 0000000000000000000000000000000000000000..6e395e066c9dafd45d487d27d7abd397ba4e6e11 --- /dev/null +++ b/miniconda3/pkgs/zstandard-0.24.0-py313h3d778a8_0/lib/python3.13/site-packages/zstandard/backend_c.cpython-313-x86_64-linux-gnu.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a78336d2580fdafb3af6c929b0dcb47019d9f451839adf9d5b57ac24d28dba0 +size 145176 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/unzstd b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/unzstd new file mode 100644 index 0000000000000000000000000000000000000000..ee5608dd8f6ff9d6aef33babcfc4bd5fef1ca117 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/unzstd @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48bc854041f77d98367dcaf0374b3d1f737fa10d4610e007df46a0f6cdc3d44c +size 219168 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstd b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstd new file mode 100644 index 0000000000000000000000000000000000000000..ee5608dd8f6ff9d6aef33babcfc4bd5fef1ca117 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstd @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48bc854041f77d98367dcaf0374b3d1f737fa10d4610e007df46a0f6cdc3d44c +size 219168 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdcat b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdcat new file mode 100644 index 0000000000000000000000000000000000000000..ee5608dd8f6ff9d6aef33babcfc4bd5fef1ca117 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdcat @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48bc854041f77d98367dcaf0374b3d1f737fa10d4610e007df46a0f6cdc3d44c +size 219168 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdmt b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdmt new file mode 100644 index 0000000000000000000000000000000000000000..ee5608dd8f6ff9d6aef33babcfc4bd5fef1ca117 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/bin/zstdmt @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48bc854041f77d98367dcaf0374b3d1f737fa10d4610e007df46a0f6cdc3d44c +size 219168 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.a b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.a new file mode 100644 index 0000000000000000000000000000000000000000..c1946d1c0f2ee0055dde617c51ccbf198c227501 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.a @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26cb92217e517fc23a4d7309be72eb031436b618ae357aee36988afcd4d44998 +size 1508092 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so new file mode 100644 index 0000000000000000000000000000000000000000..30e9839a57e64cf17ff4ccca85fc20aa1ac771e5 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04386b17742680c97e5c4a9da31414238477d4951ec04f5c9499a0728e41ba3d +size 1187048 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1 b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1 new file mode 100644 index 0000000000000000000000000000000000000000..30e9839a57e64cf17ff4ccca85fc20aa1ac771e5 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04386b17742680c97e5c4a9da31414238477d4951ec04f5c9499a0728e41ba3d +size 1187048 diff --git a/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1.5.7 b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1.5.7 new file mode 100644 index 0000000000000000000000000000000000000000..30e9839a57e64cf17ff4ccca85fc20aa1ac771e5 --- /dev/null +++ b/miniconda3/pkgs/zstd-1.5.7-h11fc155_0/lib/libzstd.so.1.5.7 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04386b17742680c97e5c4a9da31414238477d4951ec04f5c9499a0728e41ba3d +size 1187048 diff --git a/miniconda3/share/doc/dbus/diagram.png b/miniconda3/share/doc/dbus/diagram.png new file mode 100644 index 0000000000000000000000000000000000000000..ffb8d5551d1b9033755601bb392733a793556f57 --- /dev/null +++ b/miniconda3/share/doc/dbus/diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:552d5d0582db3aa6f180eae85f97e822eebc6938b07d84e1a2063ab85ff3f3d7 +size 78762 diff --git a/miniconda3/share/gettext/archive.dir.tar.xz b/miniconda3/share/gettext/archive.dir.tar.xz new file mode 100644 index 0000000000000000000000000000000000000000..9c7bc971438d354fd1c792e093b761683954f141 --- /dev/null +++ b/miniconda3/share/gettext/archive.dir.tar.xz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73076986c0f6195c64698f6e595dc5d7762d344d5b6d4821462d94f06c2bc262 +size 606708 diff --git a/miniconda3/share/locale/bg/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/bg/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..fb3c992af1717e2d73b82a29d2d58e1a73c49a9c --- /dev/null +++ b/miniconda3/share/locale/bg/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d9cacb276b87d041d6a56f2af9a4230b4ba72e9f3039ca64b53b2bc47dcf098 +size 159236 diff --git a/miniconda3/share/locale/ca/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/ca/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..8ce74c1300284d0cd1d7250d0abb315ce8610b33 --- /dev/null +++ b/miniconda3/share/locale/ca/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c1a266277b9990818c67d6c2f90a47a0f0c685240891eff0d8ed97fdb380fae1 +size 125236 diff --git a/miniconda3/share/locale/de/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/de/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..6464f04470c6e5961c829d41d1ccbdec1a360f11 --- /dev/null +++ b/miniconda3/share/locale/de/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8cc3b57719ece713cd3b38c3df98ca7f96cd6e926cf76517964b5eeb7ca87e75 +size 138879 diff --git a/miniconda3/share/locale/en@boldquot/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/en@boldquot/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..428db1cc58f4de2db4e6850b003a6de048d3aff4 --- /dev/null +++ b/miniconda3/share/locale/en@boldquot/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d395ac50deb98755d17f3138887582ce0e1bf521ee02b9b1cdc338db79c802f +size 131259 diff --git a/miniconda3/share/locale/en@quot/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/en@quot/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..ef52800969136a9fd8bed4b095ffb636709d3102 --- /dev/null +++ b/miniconda3/share/locale/en@quot/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2e313d382d8c17dc0e9a66ce42d04647ed2cb99ddbcf6ad6909ef63dd23992b1 +size 129215 diff --git a/miniconda3/share/locale/es/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/es/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..eab9370da8f5371b4bccb6e18795cfde9d1b91c6 --- /dev/null +++ b/miniconda3/share/locale/es/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4453a019b246830630eeabafd5d8e7b337cb6b4e1cd95a456ad3938cfd1e6ea2 +size 132452 diff --git a/miniconda3/share/locale/fi/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/fi/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..7ee97b98070aaca7562899bbef19faf4bba42c6c --- /dev/null +++ b/miniconda3/share/locale/fi/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42b03123ca4d348f920ae4964860ea7d92f862d8c9012adec25c44560ccb1c24 +size 112581 diff --git a/miniconda3/share/locale/fr/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/fr/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..bf9816d00f4b9c47208b082aa3aaa35c04b17fde --- /dev/null +++ b/miniconda3/share/locale/fr/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab5f4e999c1c06061aa5191e048ea778c2230ca3e40eaae336fd6fb0696949cd +size 126157 diff --git a/miniconda3/share/locale/hr/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/hr/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..dcda778a83c50191b0db639cfe7718434cc8d612 --- /dev/null +++ b/miniconda3/share/locale/hr/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:130202f8c47f4cb181a3f070326a8665955fd2027e13b1b04385f66ccb763055 +size 129882 diff --git a/miniconda3/share/locale/it/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/it/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..65c90ea5e59e74021ed2b9bf1ea385ce520181f0 --- /dev/null +++ b/miniconda3/share/locale/it/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea15b53838b009ce061d93c93019c9d06a33d511aee9f126117b7ab9ef2baca8 +size 133272 diff --git a/miniconda3/share/locale/ja/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/ja/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..c249595f456f822465fe00da07dbe7c8d85dc46e --- /dev/null +++ b/miniconda3/share/locale/ja/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:427303e93c8d60f239cd6ae369a66dbc8955fe7dd6ef57bfccb8650191b0a8d7 +size 141536 diff --git a/miniconda3/share/locale/ko/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/ko/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..61ff2424685c396fa41623c3863c2c3a62fa2db1 --- /dev/null +++ b/miniconda3/share/locale/ko/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b7979db8e4bea60858ec8ea201166b9d3f5c33b4a308eb382bcc55a4924199d +size 139858 diff --git a/miniconda3/share/locale/pl/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/pl/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..b5f2ae1797535e875500f8fc2527d77cdfeba12d --- /dev/null +++ b/miniconda3/share/locale/pl/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:681c509027b549349e0591ee5080ae69e6fd691131a6ac87003bdde0237098cd +size 134369 diff --git a/miniconda3/share/locale/pt/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/pt/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..c45d8e73688612549ce5ef021d3a81b4186b21bd --- /dev/null +++ b/miniconda3/share/locale/pt/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ea85c02434af8136e02a28292057ad807c2a2b6a1d2ad59eeabbadf89f548b9 +size 131722 diff --git a/miniconda3/share/locale/pt_BR/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/pt_BR/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..dce99da9b5008f4753b3bdfb0a503adea318777e --- /dev/null +++ b/miniconda3/share/locale/pt_BR/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff911789b717174f914aca234a8e109e72bd1551e4e89a597ee73652925c80d0 +size 135811 diff --git a/miniconda3/share/locale/ro/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/ro/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..895dabe32c5d8f069bdd13848b4f55914bef48df --- /dev/null +++ b/miniconda3/share/locale/ro/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a8bd298a83926558be91960e444f0061bd168079fded880ed681f6747bb9841 +size 139467 diff --git a/miniconda3/share/locale/ru/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/ru/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..61cf945fb3f30e8859dede5295c0f4f174b9b0b8 --- /dev/null +++ b/miniconda3/share/locale/ru/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c5cdce65771704a6063c9d7ba6a9600ed5e62c02ac5080bff031a75a18e4afb +size 169930 diff --git a/miniconda3/share/locale/sk/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/sk/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..79b54cdff66e3e15aee50bb055b4d994fb7ebb5d --- /dev/null +++ b/miniconda3/share/locale/sk/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3409d0f4fed0244dfcfe2c022b1e1701006df8dc8f2f738ef5a3f9be7dd8467b +size 133123 diff --git a/miniconda3/share/locale/sl/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/sl/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..7c3f6aab577a364d1d9d26a589a51080619152f6 --- /dev/null +++ b/miniconda3/share/locale/sl/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b640ee3b2c6b2dcf36d56d2c387d7f304aa30bf4128961a5585fe130b26839c4 +size 102527 diff --git a/miniconda3/share/locale/sr/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/sr/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..f2e785ebf301ab2cb1d6979e6914177d2761a323 --- /dev/null +++ b/miniconda3/share/locale/sr/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00d1d1a90f25d893d79ad0b3579c2e43ce01f308c89c533c419bd57d1208284c +size 155133 diff --git a/miniconda3/share/locale/sv/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/sv/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..12b3cdcae2f857cb5234c6929f065788fa872913 --- /dev/null +++ b/miniconda3/share/locale/sv/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afddf06839d2115ab2c7d3746aa788b1fdc5c4a923e41f59743a6fb4009e1822 +size 128210 diff --git a/miniconda3/share/locale/uk/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/uk/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..8700f8c9b7cff31d2c04ea5ce25341ea6b6c8878 --- /dev/null +++ b/miniconda3/share/locale/uk/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4080ad68849253b05dfc3b744169414d6a86654f988c0a90cfafbf634b6ec987 +size 168142 diff --git a/miniconda3/share/locale/vi/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/vi/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..398f3e2c82f5caec9b0f96c3d238d560e525ef6f --- /dev/null +++ b/miniconda3/share/locale/vi/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1fe09cd7770020f32eeb2967116488ed04a15b253f5d4869541266a4d123bce +size 132326 diff --git a/miniconda3/share/locale/zh_CN/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/zh_CN/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..7a1e8d2af867f7cedcbf0b40bd6006280b3e8bac --- /dev/null +++ b/miniconda3/share/locale/zh_CN/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0214b9b2079392854084aa901aed95892c5f49514dba1e8a34612643772fad01 +size 124114 diff --git a/miniconda3/share/locale/zh_TW/LC_MESSAGES/gettext-tools.mo b/miniconda3/share/locale/zh_TW/LC_MESSAGES/gettext-tools.mo new file mode 100644 index 0000000000000000000000000000000000000000..d1d242c5c84289aa8a58db74d2b9ab643d40712f --- /dev/null +++ b/miniconda3/share/locale/zh_TW/LC_MESSAGES/gettext-tools.mo @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed0d032beaea575e28cd5ac149b6fdf5ac362f45bf913c779a0985980177b3df +size 118833 diff --git a/miniconda3/share/man/man3/ares_getaddrinfo.3 b/miniconda3/share/man/man3/ares_getaddrinfo.3 new file mode 100644 index 0000000000000000000000000000000000000000..5544ce20224eba722ad6edd3b7f021820a3a40e9 --- /dev/null +++ b/miniconda3/share/man/man3/ares_getaddrinfo.3 @@ -0,0 +1,194 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETADDRINFO 3 "4 November 2018" +.SH NAME +ares_getaddrinfo \- Initiate a host query by name and service +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_addrinfo_callback)(void *\fIarg\fP, int \fIstatus\fP, + int \fItimeouts\fP, + struct ares_addrinfo *\fIresult\fP) + +void ares_getaddrinfo(ares_channel_t *\fIchannel\fP, const char *\fIname\fP, + const char* \fIservice\fP, + const struct ares_addrinfo_hints *\fIhints\fP, + ares_addrinfo_callback \fIcallback\fP, void *\fIarg\fP) +.fi +.SH DESCRIPTION +The \fBares_getaddrinfo(3)\fP function initiates a host query by name on the +name service channel identified by +.IR channel . +The +.I name +and +.I service +parameters give the hostname and service as NULL-terminated C strings. +The +.I hints +parameter is an +.BR ares_addrinfo_hints +structure: +.PP +.RS +.EX +struct ares_addrinfo_hints { + int ai_flags; + int ai_family; + int ai_socktype; + int ai_protocol; +}; +.EE +.RE +.TP +.I ai_family +Specifies desired address family. AF_UNSPEC means return both AF_INET and AF_INET6. +.TP +.I ai_socktype +Specifies desired socket type, for example SOCK_STREAM or SOCK_DGRAM. +Setting this to 0 means any type. +.TP +.I ai_protocol +Setting this to 0 means any protocol. +.TP +.I ai_flags +Specifies additional options, see below. +.PP +.TP 19 +.B ARES_AI_NUMERICSERV +If this option is set +.I service +field will be treated as a numeric value. +.TP 19 +.B ARES_AI_CANONNAME +The ares_addrinfo structure will return a canonical names list. +.TP 19 +.B ARES_AI_NOSORT +Result addresses will not be sorted and no connections to resolved addresses will be attempted. +.TP 19 +.B ARES_AI_ENVHOSTS +Read hosts file path from the environment variable +.I CARES_HOSTS . +.PP +When the query is complete or has failed, the ares library will invoke \fIcallback\fP. +Completion or failure of the query may happen immediately, or may happen +during a later call to \fIares_process(3)\fP, \fIares_destroy(3)\fP or +\fIares_cancel(3)\fP. +.PP +When the associated callback is called, it is called with a channel lock so care +must be taken to ensure any processing is minimal to prevent DNS channel stalls. + +The callback may be triggered from a different thread than the one which +called \fIares_getaddrinfo(3)\fP. + +For integrators running their own event loops and not using \fBARES_OPT_EVENT_THREAD\fP, +care needs to be taken to ensure any file descriptor lists are updated immediately +within the eventloop when notified. +.PP +The callback argument +.I arg +is copied from the \fBares_getaddrinfo(3)\fP argument +.IR arg . +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The host lookup completed successfully. +.TP 19 +.B ARES_ENOTIMP +The ares library does not know how to find addresses of type +.IR family . +.TP 19 +.B ARES_ENOTFOUND +The +.I name +was not found. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ESERVICE +The textual service name provided could not be dereferenced into a port. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.PP +On successful completion of the query, the callback argument +.I result +points to a +.B struct ares_addrinfo +which contains two linked lists, one with resolved addresses and another with canonical names. +Also included is the official name of the host (analogous to gethostbyname() h_name). +.PP +.RS +.EX +struct ares_addrinfo { + struct ares_addrinfo_cname *cnames; + struct ares_addrinfo_node *nodes; + char *name; +}; +.EE +.RE +.PP +.I ares_addrinfo_node +structure is similar to RFC3493 addrinfo, but without canonname and with extra ttl field. +.RS +.PP +.EX +struct ares_addrinfo_node { + int ai_ttl; + int ai_flags; + int ai_family; + int ai_socktype; + int ai_protocol; + ares_socklen_t ai_addrlen; + struct sockaddr *ai_addr; + struct ares_addrinfo_node *ai_next; +}; +.EE +.RE +.PP +.I ares_addrinfo_cname +structure is a linked list of CNAME records where +.I ttl +is a time to live +.I alias +is a label of the resource record and +.I name +is a value (canonical name) of the resource record. +See RFC2181 10.1.1. CNAME terminology. +.RS +.PP +.EX +struct ares_addrinfo_cname { + int ttl; + char *alias; + char *name; + struct ares_addrinfo_cname *next; +}; +.EE +.RE +.PP +The reserved memory has to be deleted by \fBares_freeaddrinfo(3)\fP. + +The result is sorted according to RFC6724 except: + - Rule 3 (Avoid deprecated addresses) + - Rule 4 (Prefer home addresses) + - Rule 7 (Prefer native transport) + +Please note that the function will attempt a connection +on each of the resolved addresses as per RFC6724. +.SH AVAILABILITY +This function was added in c-ares 1.16.0, released in March 2020. +.SH SEE ALSO +.BR ares_freeaddrinfo (3) diff --git a/miniconda3/share/man/man3/ares_gethostbyaddr.3 b/miniconda3/share/man/man3/ares_gethostbyaddr.3 new file mode 100644 index 0000000000000000000000000000000000000000..cc4092285c0168aaa6b6f0125a2dd9952bf81755 --- /dev/null +++ b/miniconda3/share/man/man3/ares_gethostbyaddr.3 @@ -0,0 +1,100 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETHOSTBYADDR 3 "24 July 1998" +.SH NAME +ares_gethostbyaddr \- Initiate a host query by address +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP, + int \fItimeouts\fP, + struct hostent *\fIhostent\fP) + +void ares_gethostbyaddr(ares_channel_t *\fIchannel\fP, const void *\fIaddr\fP, + int \fIaddrlen\fP, int \fIfamily\fP, + ares_host_callback \fIcallback\fP, void *\fIarg\fP) +.fi +.SH DESCRIPTION +The +.B ares_gethostbyaddr +function initiates a host query by address on the name service channel +identified by +.IR channel . +The parameters +.I addr +and +.I addrlen +give the address as a series of bytes, and +.I family +gives the type of address. When the query is complete or has failed, the ares +library will invoke \fIcallback\fP. Completion or failure of the query may +happen immediately, or may happen during a later call to +\fIares_process(3)\fP, \fIares_destroy(3)\fP or \fIares_cancel(3)\fP. +.PP +The callback argument +.I arg +is copied from the +.B ares_gethostbyaddr +argument +.IR arg . +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The host lookup completed successfully. +.TP 19 +.B ARES_ENOTIMP +The ares library does not know how to look up addresses of type +.IR family . +.TP 19 +.B ARES_ENOTFOUND +The address +.I addr +was not found. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.PP +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. +.PP +On successful completion of the query, the callback argument +.I hostent +points to a +.B struct hostent +containing the name of the host returned by the query. The callback +need not and should not attempt to free the memory pointed to by +.IR hostent ; +the ares library will free it when the callback returns. If the query +did not complete successfully, +.I hostent +will be +.BR NULL . +.PP +When the associated callback is called, it is called with a channel lock so care +must be taken to ensure any processing is minimal to prevent DNS channel stalls. + +The callback may be triggered from a different thread than the one which +called \fIares_gethostbyaddr(3)\fP. + +For integrators running their own event loops and not using \fBARES_OPT_EVENT_THREAD\fP, +care needs to be taken to ensure any file descriptor lists are updated immediately +within the eventloop when notified. +.SH SEE ALSO +.BR ares_process (3), +.BR ares_gethostbyname (3) diff --git a/miniconda3/share/man/man3/ares_gethostbyname.3 b/miniconda3/share/man/man3/ares_gethostbyname.3 new file mode 100644 index 0000000000000000000000000000000000000000..06d075ca6c51367b8af188e1c018d076a5ad9eaa --- /dev/null +++ b/miniconda3/share/man/man3/ares_gethostbyname.3 @@ -0,0 +1,108 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETHOSTBYNAME 3 "25 July 1998" +.SH NAME +ares_gethostbyname \- Initiate a host query by name +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP, + int \fItimeouts\fP, + struct hostent *\fIhostent\fP) + +void ares_gethostbyname(ares_channel_t *\fIchannel\fP, const char *\fIname\fP, + int \fIfamily\fP, ares_host_callback \fIcallback\fP, + void *\fIarg\fP) +.fi +.SH DESCRIPTION +The +.B ares_gethostbyname +function initiates a host query by name on the name service channel +identified by +.IR channel . +The parameter +.I name +gives the hostname as a NUL-terminated C string, and +.I family +gives the desired type of address for the resulting host entry. When the +query is complete or has failed, the ares library will invoke \fIcallback\fP. +Completion or failure of the query may happen immediately, or may happen +during a later call to \fIares_process(3)\fP, \fIares_destroy(3)\fP or +\fIares_cancel(3)\fP. +.PP +The callback argument +.I arg +is copied from the +.B ares_gethostbyname +argument +.IR arg . +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The host lookup completed successfully. +.TP 19 +.B ARES_ENOTIMP +The ares library does not know how to find addresses of type +.IR family . +.TP 19 +.B ARES_EBADNAME +The hostname +.B name +is composed entirely of numbers and periods, but is not a valid +representation of an Internet address. +.TP 19 +.B ARES_ENODATA +There was no data returned to extract a result from. +.TP 19 +.B ARES_ENOTFOUND +The name +.I name +was not found. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.PP +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. +.PP +On successful completion of the query, the callback argument +.I hostent +points to a +.B struct hostent +containing the name of the host returned by the query. The callback +need not and should not attempt to free the memory pointed to by +.IR hostent ; +the ares library will free it when the callback returns. If the query +did not complete successfully, +.I hostent +will be +.BR NULL . +.PP +When the associated callback is called, it is called with a channel lock so care +must be taken to ensure any processing is minimal to prevent DNS channel stalls. + +The callback may be triggered from a different thread than the one which +called \fIares_gethostbyname(3)\fP. + +For integrators running their own event loops and not using \fBARES_OPT_EVENT_THREAD\fP, +care needs to be taken to ensure any file descriptor lists are updated immediately +within the eventloop when notified. +.SH SEE ALSO +.BR ares_process (3), +.BR ares_gethostbyaddr (3) diff --git a/miniconda3/share/man/man3/ares_gethostbyname_file.3 b/miniconda3/share/man/man3/ares_gethostbyname_file.3 new file mode 100644 index 0000000000000000000000000000000000000000..57dd7c43e95ebd807cc4b931bbd96516c3119452 --- /dev/null +++ b/miniconda3/share/man/man3/ares_gethostbyname_file.3 @@ -0,0 +1,68 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETHOSTBYNAME 3 "25 July 1998" +.SH NAME +ares_gethostbyname_file \- Lookup a name in the system's hosts file +.SH SYNOPSIS +.nf +#include + +int ares_gethostbyname_file(ares_channel_t *\fIchannel\fP, const char *\fIname\fP, + int \fIfamily\fP, struct hostent **host) +.fi +.SH DESCRIPTION +The +.B ares_gethostbyname_file +function performs a host lookup by name against the system's hosts file (or equivalent local hostname database). +The +.IR channel +parameter is required, but no asynchronous queries are performed. Instead, the +lookup is done via the same mechanism used to perform 'f' lookups +(see the +.I lookups +options field in \fIares_init_options(3)\fP). +The parameter +.I name +gives the hostname as a NUL-terminated C string, and +.I family +gives the desired type of address for the resulting host entry. +.PP +The return value indicates whether the query succeeded and, if not, how it +failed. It may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The host lookup completed successfully and +.I host +now points to the result (and must be freed with \fIares_free_hostent(3)\fP). +.TP 19 +.B ARES_ENOTFOUND +The hostname +.I name +was not found. +.TP 19 +.B ARES_EFILE +There was a file I/O error while performing the lookup. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.PP +On successful completion of the query, the pointer pointed to by +.I host +points to a +.B struct hostent +containing the address of the host returned by the lookup. The user must +free the memory pointed to by +.IR host +when finished with it by calling \fIares_free_hostent(3)\fP. If the lookup did +not complete successfully, +.I host +will be +.BR NULL . +.SH AVAILABILITY +Added in c-ares 1.5.4 +.SH SEE ALSO +.BR ares_gethostbyname (3), +.BR ares_free_hostent (3), +.BR ares_init_options (3) diff --git a/miniconda3/share/man/man3/ares_getnameinfo.3 b/miniconda3/share/man/man3/ares_getnameinfo.3 new file mode 100644 index 0000000000000000000000000000000000000000..66b04f9efc11a7c506ed33e39722adbe11a74343 --- /dev/null +++ b/miniconda3/share/man/man3/ares_getnameinfo.3 @@ -0,0 +1,147 @@ +.\" +.\" Copyright 2005 by Dominick Meglio. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETNAMEINFO 3 "1 May 2009" +.SH NAME +ares_getnameinfo \- Address-to-nodename translation in protocol-independent manner +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_nameinfo_callback)(void *\fIarg\fP, int \fIstatus\fP, + int \fItimeouts\fP, char *\fInode\fP, + char *\fIservice\fP) + +void ares_getnameinfo(ares_channel_t *\fIchannel\fP, const struct sockaddr *\fIsa\fP, + ares_socklen_t \fIsalen\fP, int \fIflags\fP, + ares_nameinfo_callback \fIcallback\fP, void *\fIarg\fP) +.fi +.SH DESCRIPTION +The +.B ares_getnameinfo +function is defined for protocol-independent address translation. The function +is a combination of \fIares_gethostbyaddr(3)\fP and \fIgetservbyport(3)\fP. The function will +translate the address either by executing a host query on the name service channel +identified by +.IR channel +or it will attempt to resolve it locally if possible. +The parameters +.I sa +and +.I len +give the address as a sockaddr structure, and +.I flags +gives the options that the function will use. Valid flags are listed below: +.TP 19 +.B ARES_NI_NOFQDN +Only the nodename portion of the FQDN is returned for local hosts. +.TP 19 +.B ARES_NI_NUMERICHOST +The numeric form of the hostname is returned rather than the name. +.TP 19 +.B ARES_NI_NAMEREQD +An error is returned if the hostname cannot be found in the DNS. +.TP 19 +.B ARES_NI_NUMERICSERV +The numeric form of the service is returned rather than the name. +.TP 19 +.B ARES_NI_TCP +The service name is to be looked up for the TCP protocol. +.TP 19 +.B ARES_NI_UDP +The service name is to be looked up for the UDP protocol. +.TP 19 +.B ARES_NI_SCTP +The service name is to be looked up for the SCTP protocol. +.TP 19 +.B ARES_NI_DCCP +The service name is to be looked up for the DCCP protocol. +.TP 19 +.B ARES_NI_NUMERICSCOPE +The numeric form of the scope ID is returned rather than the name. +.TP 19 +.B ARES_NI_LOOKUPHOST +A hostname lookup is being requested. +.TP 19 +.B ARES_NI_LOOKUPSERVICE +A service name lookup is being requested. +.PP +When the query +is complete or has +failed, the ares library will invoke \fIcallback\fP. Completion or failure of +the query may happen immediately, or may happen during a later call to +\fIares_process(3)\fP, \fIares_destroy(3)\fP or \fIares_cancel(3)\fP. +.PP +When the associated callback is called, it is called with a channel lock so care +must be taken to ensure any processing is minimal to prevent DNS channel stalls. + +The callback may be triggered from a different thread than the one which +called \fIares_getnameinfo(3)\fP. + +For integrators running their own event loops and not using \fBARES_OPT_EVENT_THREAD\fP, +care needs to be taken to ensure any file descriptor lists are updated immediately +within the eventloop when notified. +.PP +The callback argument +.I arg +is copied from the +.B ares_getnameinfo +argument +.IR arg . +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The host lookup completed successfully. +.TP 19 +.B ARES_ENOTIMP +The ares library does not know how to look up addresses of type +.IR family . +.TP 19 +.B ARES_ENOTFOUND +The address +.I addr +was not found. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.TP 19 +.B ARES_EBADFLAGS +The +.I flags +parameter contains an illegal value. +.PP +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. +.PP +On successful completion of the query, the callback argument +.I node +contains a string representing the hostname (assuming +.B ARES_NI_LOOKUPHOST +was specified). Additionally, +.I service +contains a string representing the service name (assuming +.B ARES_NI_LOOKUPSERVICE +was specified). +If the query did not complete successfully, or one of the values +was not requested, +.I node +or +.I service +will be +.BR NULL . +.SH SEE ALSO +.BR ares_process (3), diff --git a/miniconda3/share/man/man3/ares_getsock.3 b/miniconda3/share/man/man3/ares_getsock.3 new file mode 100644 index 0000000000000000000000000000000000000000..b5302a3906b58a47118953e4dc77b469f344a741 --- /dev/null +++ b/miniconda3/share/man/man3/ares_getsock.3 @@ -0,0 +1,53 @@ +.\" +.\" Copyright 1998 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_GETSOCK 3 "11 March 2010" +.SH NAME +ares_getsock \- get socket descriptors to wait on (deprecated) +.SH SYNOPSIS +.nf +#include + +int ares_getsock(const ares_channel_t *\fIchannel\fP, ares_socket_t *\fIsocks\fP, + int \fInumsocks\fP); +.fi +.SH DESCRIPTION +The +.B ares_getsock +function retrieves the set of socket descriptors which the calling +application should wait on for reading and/or writing for the +processing of name service queries pending on the name service channel +identified by +.IR channel . +Socket descriptors will be set in the socket descriptor array pointed to by +\fIsocks\fP. +\fInumsocks\fP is the size of the given array in number of ints. + +This function can only return information up to 16 sockets. If more are +in use, they are simply not reported back. +.SH RETURN VALUES +\fBares_getsock\fP returns a bitmask for what actions to wait for on the +different sockets. The ares.h header file provides these convenience macros to +extract the information appropriately: + +.nf +#define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about + this many sockets */ +#define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num))) +#define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \ + ARES_GETSOCK_MAXNUM))) +.fi +.SH NOTES +This function was added in c-ares 1.3.1 and deprecated in c-ares 1.20.0 due to +the implementation of \fBARES_OPT_MAX_UDP_QUERIES\fP which makes it likely to +exceed 16 open file descriptors. + +It is recommended to use \fBARES_OPT_EVENT_THREAD\fP passed to +\fIares_init_options(3)\fP or to use socket state callbacks +(\fBARES_OPT_SOCK_STATE_CB\fP) registered via \fBares_init_options(3)\fP. +.SH SEE ALSO +.BR ares_init_options (3), +.BR ares_timeout (3), +.BR ares_fds (3), +.BR ares_process (3) diff --git a/miniconda3/share/man/man3/ares_inet_ntop.3 b/miniconda3/share/man/man3/ares_inet_ntop.3 new file mode 100644 index 0000000000000000000000000000000000000000..4a9f0049d310729cc803a04ede7d1abacc93ccf3 --- /dev/null +++ b/miniconda3/share/man/man3/ares_inet_ntop.3 @@ -0,0 +1,34 @@ +.\" +.\" Copyright (C) 2013 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_INET_NTOP 3 "17 Feb 2013" +.SH NAME +ares_inet_ntop \- convert a network format address to presentation format +.SH SYNOPSIS +.nf +#include + +const char *ares_inet_ntop(int \fIaf\fP, const void *\fIsrc\fP, char *\fIdst\fP, + ares_socklen_t \fIsize\fP); +.fi +.SH DESCRIPTION +This is a portable version with the identical functionality of the commonly +available \fIinet_ntop\fP. + +The ares_inet_ntop() function converts a numeric address into a text string +suitable for presentation. The \fBaf\fP argument shall specify the family of +the address. This can be AF_INET or AF_INET6. The \fBsrc\fP argument points +to a buffer holding an IPv4 address if the af argument is AF_INET, or an IPv6 +address if the af argument is AF_INET6; the address must be in network byte +order. The \fBdst\fP argument points to a buffer where the function stores the +resulting text string; it shall not be NULL. The \fBsize\fP argument specifies +the size of this buffer, which shall be large enough to hold the text string +(INET_ADDRSTRLEN (16) characters for IPv4, INET6_ADDRSTRLEN (46) characters +for IPv6). +.SH SEE ALSO +.BR ares_init (3), +.BR ares_inet_pton (3) +.SH AVAILABILITY +made properly publicly available in c-ares for real in version 1.10.0 + diff --git a/miniconda3/share/man/man3/ares_inet_pton.3 b/miniconda3/share/man/man3/ares_inet_pton.3 new file mode 100644 index 0000000000000000000000000000000000000000..34b2df063c6820bf630dc4073f3102a3d6f27bab --- /dev/null +++ b/miniconda3/share/man/man3/ares_inet_pton.3 @@ -0,0 +1,35 @@ +.\" +.\" Copyright (C) 2013 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_INET_PTON 3 "17 Feb 2013" +.SH NAME +ares_inet_pton \- convert an IPv4 or IPv6 address from text to binary form +.SH SYNOPSIS +.nf +#include + +int ares_inet_pton(int \fIaf\fP, const char *\fIsrc\fP, void *\fIdst\fP); +.fi +.SH DESCRIPTION +This is a portable version with the identical functionality of the commonly +available \fIinet_pton\fP. + +The ares_inet_pton() function converts the address in its standard text +presentation form into its numeric binary form. The \fBaf\fP argument shall +specify the family of the address. The AF_INET and AF_INET6 address families +shall be supported. The \fBsrc\fP argument points to the string being passed +in. The \fBdst\fP argument points to a buffer into which the function stores +the numeric address; this shall be large enough to hold the numeric address +(32 bits for AF_INET, 128 bits for AF_INET6). + +It returns 1 if the address was valid for the specified address family, or 0 +if the address was not parseable in the specified address family, or -1 if +some system error occurred (in which case errno will have been set). + +.SH SEE ALSO +.BR ares_init (3), +.BR ares_inet_ntop (3) +.SH AVAILABILITY +made properly publicly available in c-ares for real in version 1.10.0 + diff --git a/miniconda3/share/man/man3/ares_init.3 b/miniconda3/share/man/man3/ares_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..6f81734ce3c0d8e7a7fe8eb0441612ac08acc38c --- /dev/null +++ b/miniconda3/share/man/man3/ares_init.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_init_options.3 diff --git a/miniconda3/share/man/man3/ares_init_options.3 b/miniconda3/share/man/man3/ares_init_options.3 new file mode 100644 index 0000000000000000000000000000000000000000..9b3b4815355659952b7016690e42ea8a7f85eead --- /dev/null +++ b/miniconda3/share/man/man3/ares_init_options.3 @@ -0,0 +1,415 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" Copyright (C) 2004-2010 by Daniel Stenberg +.\" +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_INIT_OPTIONS 3 "5 March 2010" +.SH NAME +ares_init_options, ares_init \- Initialize a resolver channel +.SH SYNOPSIS +.nf +#include + +struct ares_server_failover_options { + unsigned short retry_chance; + size_t retry_delay; +}; + +struct ares_options { + int flags; + int timeout; /* in seconds or milliseconds, depending on options */ + int tries; + int ndots; + unsigned short udp_port; + unsigned short tcp_port; + int socket_send_buffer_size; + int socket_receive_buffer_size; + struct in_addr *servers; + int nservers; + char **domains; + int ndomains; + char *lookups; + ares_sock_state_cb sock_state_cb; + void *sock_state_cb_data; + struct apattern *sortlist; + int nsort; + int ednspsz; + char *resolvconf_path; + char *hosts_path; + int udp_max_queries; + int maxtimeout; /* in milliseconds */ + unsigned int qcache_max_ttl; /* in seconds */ + ares_evsys_t evsys; + struct ares_server_failover_options server_failover_opts; +}; + +int ares_init_options(ares_channel_t **\fIchannelptr\fP, + const struct ares_options *\fIoptions\fP, + int \fIoptmask\fP); + +int ares_init(ares_channel_t **\fIchannelptr\fP); + +.fi +.SH DESCRIPTION +The \fBares_init(3)\fP function is equivalent to calling +\fBares_init_options(channelptr, NULL, 0)\fP. It is recommended to use +\fBares_init_options(3)\fP instead and to set or make configurable the +appropriate options for your application. + +The \fBares_init_options(3)\fP function initializes a communications channel +for name service lookups. If it returns successfully, +\fBares_init_options(3)\fP will set the variable pointed to by +\fIchannelptr\fP to a handle used to identify the name service channel. The +caller should invoke \fIares_destroy(3)\fP on the handle when the channel is +no longer needed. + +It is recommended for an application to have at most one ares channel and use +this for all DNS queries for the life of the application. When system +configuration changes, \fIares_reinit(3)\fP can be called to reload the +configuration if necessary. The recommended concurrent query limit is about +32k queries, but remembering that when specifying AF_UNSPEC for +\fBares_getaddrinfo(3)\fP or \fBares_gethostbyname(3)\fP, they may spawn +2 queries internally. The reason for the limit is c-ares does not allow +duplicate DNS query ids (which have a maximum of 64k) to be oustanding at a +given time, and it must randomly search for an available id thus 32k will limit +the number of searches. This limitation should not be a concern for most +implementations and c-ares may implement queuing in future releases to lift this +limitation. + +The \fIoptmask\fP parameter generally specifies which fields in the structure pointed to +by \fIoptions\fP are set, as follows: +.TP 18 +.B ARES_OPT_FLAGS +.B int \fIflags\fP; +.br +Flags controlling the behavior of the resolver: +.RS 4 +.TP 23 +.B ARES_FLAG_USEVC +Always use TCP queries (the "virtual circuit") instead of UDP +queries. Normally, TCP is only used if a UDP query yields a truncated +result. +.TP 23 +.B ARES_FLAG_PRIMARY +Only query the first server in the list of servers to query. +.TP 23 +.B ARES_FLAG_IGNTC +If a truncated response to a UDP query is received, do not fall back +to TCP; simply continue on with the truncated response. +.TP 23 +.B ARES_FLAG_NORECURSE +Do not set the "recursion desired" bit on outgoing queries, so that the name +server being contacted will not try to fetch the answer from other servers if +it doesn't know the answer locally. Be aware that ares will not do the +recursion for you. Recursion must be handled by the application calling ares +if \fIARES_FLAG_NORECURSE\fP is set. +.TP 23 +.B ARES_FLAG_STAYOPEN +Do not close communications sockets when the number of active queries +drops to zero. +.TP 23 +.B ARES_FLAG_NOSEARCH +Do not use the default search domains; only query hostnames as-is or +as aliases. +.TP 23 +.B ARES_FLAG_NOALIASES +Do not honor the HOSTALIASES environment variable, which normally +specifies a file of hostname translations. +.TP 23 +.B ARES_FLAG_NOCHECKRESP +Do not discard responses with the SERVFAIL, NOTIMP, or REFUSED +response code or responses whose questions don't match the questions +in the request. Primarily useful for writing clients which might be +used to test or debug name servers. +.TP 23 +.B ARES_FLAG_EDNS +Include an EDNS pseudo-resource record (RFC 2671) in generated requests. As of +v1.22, this is on by default if flags are otherwise not set. +.TP 23 +.B ARES_FLAG_NO_DFLT_SVR +Do not attempt to add a default local named server if there are no other +servers available. Instead, fail initialization with \fIARES_ENOSERVER\fP. +.TP 23 +.B ARES_FLAG_DNS0x20 +Enable support for DNS 0x20 as per https://datatracker.ietf.org/doc/html/draft-vixie-dnsext-dns0x20-00 +which adds additional entropy to the request by randomizing the case of the +query name. Integrators need to ensure they treat DNS name responses as +case-insensitive. In rare circumstances this may cause the inability to lookup +certain domains if the upstream server or the authoritative server for the +domain is non-compliant. +.RE +.TP 18 +.B ARES_OPT_TIMEOUT +.B int \fItimeout\fP; +.br +The number of seconds each name server is given to respond to a query on the +first try. See \fIARES_OPT_TIMEOUTMS\fP which this value is converted into. +.TP 18 +.B ARES_OPT_TIMEOUTMS +.B int \fItimeout\fP; +.br +The number of milliseconds each name server is given to respond to a query on +the first try of any given server. The default is two seconds, however any +value below 250ms will automatically be set to 250ms (roughly the RTT half-way +around the world). Note that this option is specified with the same struct field +as the former \fIARES_OPT_TIMEOUT\fP, it is but the option bits that tell c-ares +how to interpret the number. This option was added in c-ares 1.5.2. + +As of c-ares 1.32.0, this option is only honored on the first successful query +to any given server, after that the timeout is automatically calculated based +on prior query history. +.TP 18 +.B ARES_OPT_TRIES +.B int \fItries\fP; +.br +The number of tries the resolver will try contacting each name server +before giving up. The default is three tries. +.TP 18 +.B ARES_OPT_NDOTS +.B int \fIndots\fP; +.br +The number of dots which must be present in a domain name for it to be +queried for "as is" prior to querying for it with the default domain +extensions appended. The default value is 1 unless set otherwise by +resolv.conf or the RES_OPTIONS environment variable. Valid range is 0-15. +.TP 18 +.B ARES_OPT_MAXTIMEOUTMS +.B int \fImaxtimeout\fP; +.br +The upper bound for timeout between sequential retry attempts. When retrying +queries, the timeout is increased from the requested timeout parameter, this +caps the value. +.TP 18 +.B ARES_OPT_UDP_PORT +.B unsigned short \fIudp_port\fP; +.br +The port to use for queries over UDP, in host byte order. +The default value is 53, the standard name service port. +.TP 18 +.B ARES_OPT_TCP_PORT +.B unsigned short \fItcp_port\fP; +.br +The port to use for queries over TCP, in host byte order. +The default value is 53, the standard name service port. +.TP 18 +.B ARES_OPT_SERVERS +.B struct in_addr *\fIservers\fP; +.br +.B int \fInservers\fP; +.br +The list of IPv4 servers to contact, instead of the servers specified in +resolv.conf or the local named. In order to allow specification of either IPv4 +or IPv6 name servers, the \Bares_set_servers(3)\fP function must be used +instead. +.TP 18 +.B ARES_OPT_DOMAINS +.B char **\fIdomains\fP; +.br +.B int \fIndomains\fP; +.br +The domains to search, instead of the domains specified in resolv.conf +or the domain derived from the kernel hostname variable. +.TP 18 +.B ARES_OPT_LOOKUPS +.B char *\fIlookups\fP; +.br +The lookups to perform for host queries. +.I lookups +should be set to a string of the characters "b" or "f", where "b" +indicates a DNS lookup and "f" indicates a lookup in the hosts file. +.TP 18 +.B ARES_OPT_SOCK_STATE_CB +.B void (*\fIsock_state_cb\fP)(void *data, ares_socket_t socket_fd, int readable, int writable); +.br +.B void *\fIsock_state_cb_data\fP; +.br +A callback function to be invoked when a socket changes state. +.I socket_fd +will be passed the socket whose state has changed; +.I readable +will be set to true if the socket should listen for read events, and +.I writable +will be set to true if the socket should listen for write events. +The value of +.I sock_state_cb_data +will be passed as the +.I data +argument. The channel lock is held during this callback, if in a multithreaded +application, care must be taken to ensure lock order is correct to be able to +handle this and avoid deadlocks. + +Cannot be used with \fBARES_OPT_EVENT_THREAD\fP. +.TP 18 +.B ARES_OPT_SORTLIST +.B struct apattern *\fIsortlist\fP; +.br +.B int \fInsort\fP; +.br +A list of IP address ranges that specifies the order of preference that +results from \fIares_gethostbyname\fP should be returned in. Note that +this can only be used with a sortlist retrieved via +\fBares_save_options(3)\fP (because +.B struct apattern +is opaque); to set a fresh sort list, use \fBares_set_sortlist(3)\fP. +.TP 18 +.B ARES_OPT_SOCK_SNDBUF +.B int \fIsocket_send_buffer_size\fP; +.br +The send buffer size to set for the socket. +.TP 18 +.B ARES_OPT_SOCK_RCVBUF +.B int \fIsocket_receive_buffer_size\fP; +.br +The receive buffer size to set for the socket. +.TP 18 +.B ARES_OPT_EDNSPSZ +.B int \fIednspsz\fP; +.br +The message size to be advertised in EDNS; only takes effect if the +.B ARES_FLAG_EDNS +flag is set. Defaults to 1232, the recommended size. +.TP 18 +.B ARES_OPT_RESOLVCONF +.B char *\fIresolvconf_path\fP; +.br +The path to use for reading the resolv.conf file. The +.I resolvconf_path +should be set to a path string, and will be honoured on *nix like systems. The +default is +.B /etc/resolv.conf +.br +.TP 18 +.B ARES_OPT_HOSTS_FILE +.B char *\fIhosts_path\fP; +.br +The path to use for reading the hosts file. The +.I hosts_path +should be set to a path string, and will be honoured on *nix like systems. The +default is +.B /etc/hosts +.br +.TP 18 +.B ARES_OPT_UDP_MAX_QUERIES +.B int \fIudp_max_queries\fP; +.br +The maximum number of udp queries that can be sent on a single ephemeral port +to a given DNS server before a new ephemeral port is assigned. Any value of 0 +or less will be considered unlimited, and is the default. +.br +.TP 18 +.B ARES_OPT_QUERY_CACHE +.B unsigned int \fIqcache_max_ttl\fP; +.br +As of c-ares 1.31.0, the query cache is enabled by default with a TTL of 1hr. +To disable the query cache, specify this option with a TTL of 0. The query +cache is based on the returned TTL in the DNS message. Only fully successful +and NXDOMAIN query results will be cached. Fill in the \fIqcache_max_ttl\fP +with the maximum number of seconds a query result may be cached which will +override a larger TTL in the response message. This must be a non-zero value +otherwise the cache will be disabled. Choose a reasonable value for your +application such as 300 (5 minutes) or 3600 (1 hour). The query cache is +automatically flushed if a server configuration change is made. +.br +.TP 18 +.B ARES_OPT_EVENT_THREAD +.B ares_evsys_t \fIevsys\fP; +.br +Enable the built-in event thread (Recommended). Introduced in c-ares 1.26.0. +Set the \fIevsys\fP parameter to \fBARES_EVSYS_DEFAULT\fP (0). Other values are +reserved for testing and should not be used by integrators. + +This option cannot be used with the \fBARES_OPT_SOCK_STATE_CB\fP option, nor the +\fIares_set_socket_functions(3)\fP or +\fIares_set_socket_configure_callback(3)\fP functions. + +When enabled, the integrator is no longer responsible for notifying c-ares of +any events on the file descriptors, so \fIares_process(3)\fP nor +\fIares_process_fd(3)\fP should ever be called when this option is enabled. + +As of c-ares 1.29.0, when enabled, it will also automatically re-load the +system configuration when changes are detected. + +Use \fIares_threadsafety(3)\fP to determine if this option is available to be +used. + +Returns \fBARES_ENOTIMP\fP if this option is passed but not available, and +\fBARES_ESERVFAIL\fP if there is a critical failure during initialization of +the event thread. +.br +.TP 18 +.B ARES_OPT_SERVER_FAILOVER +.B struct ares_server_failover_options \fIserver_failover_opts\fP; +.br +Configure server failover retry behavior. When a DNS server fails to +respond to a query, c-ares will deprioritize the server. On subsequent +queries, servers with fewer consecutive failures will be selected in +preference. However, in order to detect when such a server has recovered, +c-ares will occasionally retry failed servers by probing with a copy of +the query, without affecting the latency of the actual requested query. The +\fIares_server_failover_options\fP structure contains options to control this +behavior. +The \fIretry_chance\fP field gives the probability (1/N) of retrying a +failed server on any given query. Setting to a value of 0 disables retries. +The \fIretry_delay\fP field gives the minimum delay in milliseconds that c-ares +will wait before retrying a specific failed server. +If this option is not specificed then c-ares will use a probability of 10% +and a minimum delay of 5 seconds. +.br +.PP +The \fIoptmask\fP parameter also includes options without a corresponding +field in the +.B ares_options +structure, as follows: +.TP 23 +.B ARES_OPT_ROTATE +Perform round-robin selection of the nameservers configured for the channel +for each resolution. +.TP 23 +.B ARES_OPT_NOROTATE +Do not perform round-robin nameserver selection; always use the list of +nameservers in the same order. The default is not to rotate servers, however +the system configuration can specify the desire to rotate and this +configuration value can negate such a system configuration. +.PP + +.SH RETURN VALUES +\fBares_init_options(3)\fP and \fBares_init(3)\fP can return any of the +following values: +.TP 14 +.B ARES_SUCCESS +Initialization succeeded. +.TP 14 +.B ARES_EFILE +A configuration file could not be read. +.TP 14 +.B ARES_ENOMEM +The process's available memory was exhausted. +.TP 14 +.B ARES_ENOTINITIALIZED +c-ares library initialization not yet performed. +.TP 14 +.B ARES_ENOSERVER +No DNS servers were available to use. +.SH NOTES +When initializing from +.B /etc/resolv.conf, +(or, alternatively when specified by the +.I resolvconf_path +path location) +\fBares_init_options(3)\fP and \fBares_init(3)\fP reads the \fIdomain\fP and +\fIsearch\fP directives to allow lookups of short names relative to the domains +specified. The \fIdomain\fP and \fIsearch\fP directives override one another. +If more than one instance of either \fIdomain\fP or \fIsearch\fP directives is +specified, the last occurrence wins. For more information, please see the +.BR resolv.conf (5) +manual page. +.SH SEE ALSO +.BR ares_reinit (3), +.BR ares_destroy (3), +.BR ares_dup (3), +.BR ares_library_init (3), +.BR ares_save_options (3), +.BR ares_set_servers (3), +.BR ares_set_sortlist (3), +.BR ares_threadsafety (3) diff --git a/miniconda3/share/man/man3/ares_library_cleanup.3 b/miniconda3/share/man/man3/ares_library_cleanup.3 new file mode 100644 index 0000000000000000000000000000000000000000..ff7d946faeb4206defe392dfc4d993a1dfb0cecb --- /dev/null +++ b/miniconda3/share/man/man3/ares_library_cleanup.3 @@ -0,0 +1,66 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" Copyright (C) 2004-2009 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_LIBRARY_CLEANUP 3 "19 May 2009" +.SH NAME +ares_library_cleanup \- c-ares library deinitialization +.SH SYNOPSIS +.nf +#include + +void ares_library_cleanup(void) +.fi +.SH DESCRIPTION +.PP +The +.B ares_library_cleanup +function uninitializes the c-ares library, freeing all resources +previously acquired by \fIares_library_init(3)\fP when the library +was initialized, provided there was only one single previous call to +\fIares_library_init(3)\fP. If there was more than one previous call to +\fIares_library_init(3)\fP, this function uninitializes the c-ares +library only if it is the call matching the call to +\fIares_library_init(3)\fP which initialized the library +(usually the very first call to \fIares_library_init(3)\fP). +Other calls to \fIares_library_cleanup(3)\fP have no effect other than +decrementing an internal counter. +.PP +This function must be called when the program using c-ares will +no longer need any c-ares function. Once the program has called +\fIares_library_cleanup(3)\fP sufficiently often such that the +library is uninitialised, it shall not make any further call to any +c-ares function. +.PP +This function does not cancel any pending c-ares lookups or requests +previously done. Program must use \fIares_cancel(3)\fP for this purpose. +.PP +.B This function is not thread safe. +You have to call it once the program is about to terminate, but this call must +be done once the program has terminated every single thread that it could have +initiated. This is required to avoid potential race conditions in library +deinitialization, and also due to the fact that \fIares_library_cleanup(3)\fP +might call functions from other libraries that are thread unsafe, and could +conflict with any other thread that is already using these other libraries. +.PP +Win32/64 application DLLs shall not call \fIares_library_cleanup(3)\fP from +the DllMain function. Doing so will produce deadlocks and other problems. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.0 along with the +definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_CLEANUP\fP as an +indication of the availability of this function. Reference counting in +\fIares_library_init(3)\fP and \fIares_library_cleanup(3)\fP, which requires +calls to the former function to match calls to the latter, is present since +c-ares version 1.10.0. Earlier versions would deinitialize the library on the +first call to \fIares_library_cleanup(3)\fP. +.PP +Since the introduction of this function, it is absolutely mandatory to call it +for any Win32/64 program using c-ares. +.PP +Non-Win32/64 systems can still use c-ares version 1.7.0 without calling +\fIares_library_cleanup(3)\fP due to the fact that \fIcurrently\fP it is nearly +a do-nothing function on non-Win32/64 platforms. +.SH SEE ALSO +.BR ares_library_init (3), +.BR ares_cancel (3) diff --git a/miniconda3/share/man/man3/ares_library_init.3 b/miniconda3/share/man/man3/ares_library_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..1c30faf29fc381b3454c798e311288e86d6a45c1 --- /dev/null +++ b/miniconda3/share/man/man3/ares_library_init.3 @@ -0,0 +1,98 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" Copyright (C) 2004-2009 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_LIBRARY_INIT 3 "19 May 2009" +.SH NAME +ares_library_init \- c-ares library initialization +.SH SYNOPSIS +.nf +#include + +int ares_library_init(int \fIflags\fP) + +int ares_library_init_mem(int \fIflags\fP, + void *(*\fIamalloc\fP)(size_t), + void (*\fIafree\fP)(void *ptr), + void (*\fIarealloc\fP)(void *ptr, size_t size)) +.fi +.SH DESCRIPTION +.PP +The +.B ares_library_init +function performs initializations internally required by the c-ares +library that must take place before any other function provided by +c-ares can be used in a program. +.PP +This function must be called at least once within the life of a program, +before the program actually executes any other c-ares library function. +Initializations done by this function remain effective until a number of +calls to \fIares_library_cleanup(3)\fP equal to the number of calls to +this function are performed. +.PP +Successive calls to this function do nothing further, only the first +call done when c-ares is in an uninitialized state is actually +effective. +.PP +The +.I flags +parameter is a bit pattern that tells c-ares exactly which features +should be initialized, as described below. Set the desired bits by +ORing the values together. In normal operation you should specify +\fIARES_LIB_INIT_ALL\fP. Don't use any other value unless you are +familiar with it and trying to control some internal c-ares feature. +.PP +The +.B ares_library_init_mem +function allows the caller to provide memory management functions that the +c-ares library will be use instead of \fImalloc(3)\fP, \fIfree(3)\fP and +\fIrealloc(3)\fP. +.PP +.B This function is not thread safe. +You have to call it once the program has started, but this call must be done +before the program starts any other thread. This is required to avoid +potential race conditions in library initialization, and also due to the fact +that \fIares_library_init(3)\fP might call functions from other libraries that +are thread unsafe, and could conflict with any other thread that is already +using these other libraries. +.PP +On Windows platforms, the library user should ensure that \fIWSAStartup()\fP +is called before the c-ares library is initialized and used. +.PP +Win32/64 application DLLs shall not call \fIares_library_init(3)\fP from the +DllMain function. Doing so will produce deadlocks and other problems. +.SH FLAGS +.TP 5 +.B ARES_LIB_INIT_ALL +Initialize everything possible. This sets all known bits. +.TP +.B ARES_LIB_INIT_WIN32 +Initialize Win32/64 specific libraries. As of c-ares 1.19.0, this is ignored +as there are no currently dynamically loaded libraries. +.TP +.B ARES_LIB_INIT_NONE +Initialize nothing extra. This sets no bit. +.SH RETURN VALUE +Upon successful completion, \fIares_library_init(3)\fP returns 0. Otherwise, +a non-zero error number is returned to indicate the error. Except for +\fIares_strerror(3)\fP, you shall not call any other c-ares function upon +\fIares_library_init(3)\fP failure. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.0 along with the +definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_INIT\fP as an +indication of the availability of this function. Its recursive behavior, which +requires a matching number of calls to \fIares_library_cleanup(3)\fP in order +to deinitialize the library, is present since c-ares version 1.10.0. Earlier +versions would deinitialize the library on the first call to +\fIares_library_cleanup(3)\fP. +.PP +Since the introduction of this function it is absolutely mandatory to +call it for any Win32/64 program using c-ares. +.PP +Non-Win32/64 systems can still use c-ares version 1.7.0 without calling +\fIares_library_init(3)\fP due to the fact that \fIcurrently\fP it is nearly +a do-nothing function on non-Win32/64 platforms at this point. +.SH SEE ALSO +.BR ares_library_cleanup (3), +.BR ares_strerror (3) diff --git a/miniconda3/share/man/man3/ares_library_init_android.3 b/miniconda3/share/man/man3/ares_library_init_android.3 new file mode 100644 index 0000000000000000000000000000000000000000..bf132d84f3e8fd1ce63a1338e27772d615051ed3 --- /dev/null +++ b/miniconda3/share/man/man3/ares_library_init_android.3 @@ -0,0 +1,127 @@ +.\" +.\" Copyright (C) 2017 by John Schember +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_LIBRARY_INIT_ANDROID 3 "13 Sept 2017" +.SH NAME +ares_library_init_android \- c-ares library Android initialization +.SH SYNOPSIS +.nf +#include + +int ares_library_init_android(jobject \fIconnectivity_manager\fP) + +int ares_library_android_initialized(); + +void ares_library_init_jvm(JavaVM *\fIjvm\fP) + +.fi +.SH DESCRIPTION +The \fIares_library_init_android(3)\fP function performs initializations +internally required by the c-ares library when used on Android. This can take +place anytime after \fIares_library_init(3)\fP. It must take place after +\fIares_library_init_jvm\fP. ares_library_init_android must be called before +DNS resolution will work on Android 8 (Oreo) or newer when targetSdkVersion is +set to 26+. + +As of Android 8 (API level 26) getting DNS server information has +becomei more restrictive and can only be accessed using the +Connectivity Manager. It is necessary to pass the connectivity +manager to c-ares via JNI. Also, the ACCESS_NETWORK_STATE permission +must be present in the Android application. + +Android older than 8 do not need to to be initialized as they +are less restrictive. However, this is a run time not compile time +limitation. Proper Android initialization should take place regardless +of the targeted Android version. + +Deinitialization will take place though \fIares_library_cleanup(3)\fP. + +The \fBares_library_init_jvm\fP function allows the caller to register the JVM +with c-ares. It's meant to be called during JNI_OnLoad because you're +guaranteed to have the JVM in that function. The JVM is required in order to +use the Connectivity Manager registered using +\fIares_library_init_android(3)\fP. This must be call before +\fIares_library_init_android(3)\fP. + +The \fBares_library_android_initialized\fP function can be used to check +whether c-ares has been initialized for use with Android. +.SH RETURN VALUES +ARES_SUCCESS will be returned on success otherwise an error code will be +returned. +.SH THREAD SAFETY +.B These init functions are not thread safe. +You have to call it once the program has started, but this call must be done +before the program starts any other thread. This is required to avoid +potential race conditions in library initialization, and also due to the fact +these might call functions from other libraries that +are thread unsafe, and could conflict with any other thread that is already +using these other libraries. +.SH JNI +Accessing the Connectivity Manager though Java: + +Register the \fIares_library_android_init\fP. +.nf + static JNINativeMethod funcs[] = { + { "initialize_native", "(Landroid/net/ConnectivityManager;)I", + (void *)&ares_library_init_android} + }; + + JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved) + { + JNIEnv *env = NULL; + jclass cls = NULL; + jint res; + + if ((*vm)->GetEnv(vm, (void **)&env, JNI_VERSION_1_6) != JNI_OK) + return -1; + + cls = (*env)->FindClass(env, JNIT_CLASS); + if (cls == NULL) + return -1; + + res = (*env)->RegisterNatives(env, cls, funcs, sizeof(funcs)/sizeof(funcs[0])); + if (res != 0) + return -1; + + ares_library_init_jvm(vm); + return JNI_VERSION_1_6; + } +.fi +Calling the registered function from Java: +.nf + public class MyObject { + static { + System.loadLibrary("cares"); + } + + private static native boolean initialize_native(ConnectivityManager + connectivity_manager); + + public static boolean initialize(Context context) { + initialize_native((ConnectivityManager)context.getSystemService(Context.CONNECTIVITY_SERVICE)); + } + } +.fi +Initializing the Connectivity Manager in JNI directly using an Android +Context. It is assumed the JVM has already been registered through +\fIJNI_OnLoad\fP. +.nf + void initialize(jobject android_context) + { + jclass obj_cls = jni_get_class(env, "android/content/Context"); + jmethodID obj_mid = jni_get_method_id(env, obj_cls, "getSystemService", "(Ljava/lang/String;)Ljava/lang/Object;"); + jfieldID fid = (*env)->GetStaticFieldID(env, obj_cls, "CONNECTIVITY_SERVICE", "Ljava/lang/String;"); + jstring str = (*env)->GetStaticObjectField(env, obj_cls, fid); + connectivity_manager = (*env)->CallObjectMethod(env, android_context, obj_mid, str); + if (connectivity_manager == NULL) + return; + ares_library_init_android(connectivity_manager); + } +.fi +.SH AVAILABILITY +This function was first introduced in c-ares version 1.15.0. +.SH SEE ALSO +.BR ares_library_init (3), +.BR ares_library_cleanup (3), + diff --git a/miniconda3/share/man/man3/ares_library_initialized.3 b/miniconda3/share/man/man3/ares_library_initialized.3 new file mode 100644 index 0000000000000000000000000000000000000000..ece6404d352345dabe147e8326b7cb805168c345 --- /dev/null +++ b/miniconda3/share/man/man3/ares_library_initialized.3 @@ -0,0 +1,23 @@ +.\" +.\" Copyright (C) 2016 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_LIBRARY_INITIALIZED 3 "29 Sep 2016" +.SH NAME +ares_library_initialized \- get the initialization state +.SH SYNOPSIS +.nf +#include + +int ares_library_initialized(void) +.fi +.SH DESCRIPTION +Returns information if c-ares needs to get initialized. +.SH RETURN VALUE +\fIARES_ENOTINITIALIZED\fP if not initialized and \fIARES_SUCCESS\fP if no +initialization is needed. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.11.0 +.SH SEE ALSO +.BR ares_library_init (3), +.BR ares_library_cleanup (3) diff --git a/miniconda3/share/man/man3/ares_mkquery.3 b/miniconda3/share/man/man3/ares_mkquery.3 new file mode 100644 index 0000000000000000000000000000000000000000..2f42d169210fef3240d897df454ae5b75822ee7a --- /dev/null +++ b/miniconda3/share/man/man3/ares_mkquery.3 @@ -0,0 +1,76 @@ +.\" +.\" Copyright 1998, 2000 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_MKQUERY 3 "20 Nov 2009" +.SH NAME +ares_mkquery \- Compose a single-question DNS query buffer +.SH SYNOPSIS +.nf +#include + +int ares_mkquery(const char *\fIname\fP, int \fIdnsclass\fP, int \fItype\fP, + unsigned short \fIid\fP, int \fIrd\fP, unsigned char **\fIbuf\fP, + int *\fIbuflen\fP) +.fi +.SH DESCRIPTION +This function is deprecated as of c-ares 1.10, please use +\fIares_dns_record_create(3)\fP instead. + +The +.B ares_mkquery +function composes a DNS query with a single question. +The parameter +.I name +gives the query name as a NUL-terminated C string of period-separated +labels optionally ending with a period; periods and backslashes within +a label must be escaped with a backlash. The parameters +.I dnsclass +and +.I type +give the class and type of the query using the values defined in +.BR . +The parameter +.I id +gives a 16-bit identifier for the query. The parameter +.I rd +should be nonzero if recursion is desired, zero if not. The query +will be placed in an allocated buffer, a pointer to which will be +stored in the variable pointed to by +.IR buf , +and the length of which will be stored in the variable pointed to by +.IR buflen . +It is the caller's responsibility to free this buffer using +\fIares_free_string(3)\fP when it is no longer needed. + +Usage of \fIares_mkquery(3)\fP is deprecated, whereas the function is +equivalent to \fIares_create_query(3)\fP with \fBmax_udp_size\fP set to +0. + +.SH RETURN VALUES +.B ares_mkquery +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +Construction of the DNS query succeeded. +.TP 15 +.B ARES_ENOTFOUND +The query name +.I name +refers to a +.I .onion +domain name. See RFC 7686. +.TP 15 +.B ARES_EBADNAME +The query name +.I name +could not be encoded as a domain name, either because it contained a +zero-length label or because it contained a label of more than 63 +characters. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_expand_name (3), +.BR ares_dns_record (3), +.BR ares_free_string (3) diff --git a/miniconda3/share/man/man3/ares_opt_param_t.3 b/miniconda3/share/man/man3/ares_opt_param_t.3 new file mode 100644 index 0000000000000000000000000000000000000000..4587b9a586ef8e8d7620d0e202aaa1dde520b5ab --- /dev/null +++ b/miniconda3/share/man/man3/ares_opt_param_t.3 @@ -0,0 +1,4 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.so man3/ares_dns_mapping.3 diff --git a/miniconda3/share/man/man3/ares_parse_a_reply.3 b/miniconda3/share/man/man3/ares_parse_a_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..f4a0e8bb917fed9aa9e22b16a14946e227f0e1a4 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_a_reply.3 @@ -0,0 +1,63 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_A_REPLY 3 "25 July 1998" +.SH NAME +ares_parse_a_reply \- Parse a reply to a DNS query of type A +.SH SYNOPSIS +.nf +#include + +int ares_parse_a_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, + struct hostent **\fIhost\fP, + struct ares_addrttl *\fIaddrttls\fP, int *\fInaddrttls\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_a_reply +function parses the response to a query of type A into a +.BR "struct hostent" +and/or an array of +.BR "struct ares_addrttls" . +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR host , +if host is nonnull. +It is the caller's responsibility to free the resulting host structure +using +.BR ares_free_hostent (3) +when it is no longer needed. +.PP +If +.IR addrttls +and +.IR naddrttls +are both nonnull, +then up to *naddrttls +.BR "struct ares_addrttl" +records are stored in the array pointed to by addrttls, +and then *naddrttls is set to the number of records so stored. +Note that the memory for these records is supplied by the caller. +.SH RETURN VALUES +.B ares_parse_a_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_gethostbyname (3), +.BR ares_free_hostent (3) diff --git a/miniconda3/share/man/man3/ares_parse_aaaa_reply.3 b/miniconda3/share/man/man3/ares_parse_aaaa_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..364766f0d1d926b48ccfa6da2084234b09f8b9df --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_aaaa_reply.3 @@ -0,0 +1,63 @@ +.\" +.\" Copyright 2005 by Dominick Meglio. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_AAAA_REPLY 3 "20 Nov 2009" +.SH NAME +ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA +.SH SYNOPSIS +.nf +#include + +int ares_parse_aaaa_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, + struct hostent **\fIhost\fP, + struct ares_addr6ttl *\fIaddrttls\fP, int *\fInaddrttls\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_aaaa_reply +function parses the response to a query of type AAAA into a +.BR "struct hostent" +and/or an array of +.BR "struct ares_addr6ttl" . +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR host , +if host is nonnull. +It is the caller's responsibility to free the resulting host structure +using +.BR ares_free_hostent (3) +when it is no longer needed. +.PP +If +.IR addrttls +and +.IR naddrttls +are both nonnull, +then up to *naddrttls +.BR "struct ares_addr6ttl" +records are stored in the array pointed to by addrttls, +and then *naddrttls is set to the number of records so stored. +Note that the memory for these records is supplied by the caller. +.SH RETURN VALUES +.B ares_parse_aaaa_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_gethostbyname (3), +.BR ares_free_hostent (3) diff --git a/miniconda3/share/man/man3/ares_parse_caa_reply.3 b/miniconda3/share/man/man3/ares_parse_caa_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..489d420127ca0951ceda3b0029bec23fce0f95da --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_caa_reply.3 @@ -0,0 +1,158 @@ +.\" +.\" Copyright 2020 Danny Sonnenschein +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_CAA_REPLY 3 "16 September 2020" +.SH NAME +ares_parse_caa_reply \- Parse a reply to a DNS query of type CAA +.SH SYNOPSIS +.nf +#include + +int ares_parse_caa_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_caa_reply **\fIcaa_out\fP); +.fi +.SH DESCRIPTION +The +.BR "ares_parse_caa_reply" +function parses the response to a query of type CAA into a +linked list (one element per sub-string) of +.IR "struct ares_caa_reply" +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR caa_out . +It is the caller's responsibility to free the resulting +.IR caa_out +structure when it is no longer needed using the function +.B ares_free_data(3) +.PP +The structure +.I ares_caa_reply(3) +contains the following fields: +.sp +.in +4n +.nf +struct ares_caa_reply { + struct ares_caa_reply *next; + int critical; + unsigned char *property; + size_t plength; /* plength excludes null */ + unsigned char *value; + size_t length; /* length excludes null */ +}; +.fi +.in +.PP +.SH RETURN VALUES +.BR "ares_parse_caa_reply" +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH EXAMPLE +.nf +#include +#include +#include +#include + +#include +#include +#include + +#include "ares.h" + +static void dns_callback(void *arg, + int status, + int timeouts, + unsigned char *abuf, + int alen) + { + struct ares_caa_reply *caa_out; + int err; + + err = ares_parse_caa_reply (abuf, alen, &caa_out); + if (err == ARES_SUCCESS) + { + struct ares_caa_reply *caa_curr; + for (caa_curr=caa_out; caa_curr; caa_curr=caa_curr->next) + printf ("%s. CAA %i %s \\"%s\\"\\n", arg, + caa_curr->critical, + caa_curr->property, + caa_curr->value); + } + else + { + printf ("err=%i\\n", err); + } + ares_free_data (caa_out); + } + +static void main_loop(ares_channel_t **channel) + { + int nfds, count; + fd_set readers, writers; + struct timeval tv, *tvp; + while (1) + { + FD_ZERO (&readers); + FD_ZERO (&writers); + nfds = ares_fds (*channel, &readers, &writers); + if (nfds == 0) + break; + tvp = ares_timeout (*channel, NULL, &tv); + count = select (nfds, &readers, &writers, NULL, tvp); + ares_process (*channel, &readers, &writers); + } + } + +int main(int argc, char **argv) + { + const char *sversion; + int iversion; + int err; + + sversion = ares_version (&iversion); + printf ("c-ares version %s\\n", sversion); + + char *domain = "wikipedia.org"; + if (argc > 1) + domain = argv[1]; + + ares_channel_t *channel; + if ((err = ares_init (&channel)) != ARES_SUCCESS) + { + printf ("ares_init() failed (%i)\\n", err); + exit (EXIT_FAILURE); + } + + ares_query (channel, domain, + 1, /* ns_c_in */ + 257, /* T_CAA */ + dns_callback, domain); + + main_loop (&channel); + + ares_destroy (channel); + + exit (EXIT_SUCCESS); + } +.fi +.SH AVAILABILITY +This function was first introduced in c-ares version 1.17.0. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_mx_reply.3 b/miniconda3/share/man/man3/ares_parse_mx_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..c5c03e1a242be1041cfcaf657f7c8c1b729533a0 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_mx_reply.3 @@ -0,0 +1,65 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_MX_REPLY 3 "4 August 2009" +.SH NAME +ares_parse_mx_reply \- Parse a reply to a DNS query of type MX +.SH SYNOPSIS +#include + +int ares_parse_mx_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_mx_reply** \fImx_out\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_mx_reply +function parses the response to a query of type MX into a +linked list of +.I struct ares_mx_reply +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR mx_out . +It is the caller's responsibility to free the resulting +.IR mx_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. +.PP +The structure +.I ares_mx_reply +contains the following fields: +.sp +.in +4n +.nf +struct ares_mx_reply { + struct ares_mx_reply *next; + char *host; + unsigned short priority; +}; +.fi +.in +.PP +.SH RETURN VALUES +.B ares_parse_mx_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.2. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_naptr_reply.3 b/miniconda3/share/man/man3/ares_parse_naptr_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..d970b39fc037aee46e6e4b53af041055d3c1d6b7 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_naptr_reply.3 @@ -0,0 +1,70 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_NAPTR_REPLY 3 "23 February 2012" +.SH NAME +ares_parse_naptr_reply \- Parse a reply to a DNS query of type NAPTR +.SH SYNOPSIS +.nf +#include + +int ares_parse_naptr_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_naptr_reply** \fInaptr_out\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_naptr_reply +function parses the response to a query of type NAPTR into a +linked list of +.I struct ares_naptr_reply +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR naptr_out . +It is the caller's responsibility to free the resulting +.IR naptr_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. +.PP +The structure +.I ares_naptr_reply +contains the following fields: +.sp +.in +4n +.nf +struct ares_naptr_reply { + struct ares_naptr_reply *next; + unsigned char *flags; + unsigned char *service; + unsigned char *regexp; + char *replacement; + unsigned short order; + unsigned short preference; +}; +.fi +.in +.PP +.SH RETURN VALUES +.B ares_parse_naptr_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.6. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_ns_reply.3 b/miniconda3/share/man/man3/ares_parse_ns_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..c380f93fadbb9c13ffecaa677e0edc4949c3e845 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_ns_reply.3 @@ -0,0 +1,53 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_NS_REPLY 3 "10 February 2007" +.SH NAME +ares_parse_ns_reply \- Parse a reply to a DNS query of type NS into a hostent +.SH SYNOPSIS +.nf +#include + +int ares_parse_ns_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, + struct hostent **\fIhost\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_ns_reply +function parses the response to a query of type NS into a +.BR "struct hostent" . +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR host . +The nameservers are stored into the +.BR aliases +field of the +.IR host +structure. +It is the caller's responsibility to free the resulting host structure +using +.BR ares_free_hostent (3) +when it is no longer needed. +.SH RETURN VALUES +.B ares_parse_ns_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_query (3), +.BR ares_free_hostent (3) diff --git a/miniconda3/share/man/man3/ares_parse_ptr_reply.3 b/miniconda3/share/man/man3/ares_parse_ptr_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..5bdc072693cbf2eb5c88f37f1d17788ceea8d343 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_ptr_reply.3 @@ -0,0 +1,59 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_PTR_REPLY 3 "25 July 1998" +.SH NAME +ares_parse_ptr_reply \- Parse a reply to a DNS query of type PTR into a hostent +.SH SYNOPSIS +.nf +#include + +int ares_parse_ptr_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, + const void *\fIaddr\fP, int \fIaddrlen\fP, + int \fIfamily\fP, struct hostent **\fIhost\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_ptr_reply +function parses the response to a query of type PTR into a +.BR "struct hostent" . +The parameters +.I abuf +and +.I alen +give the contents of the response. The parameters +.IR addr , +.IR addrlen , +and +.I family +specify which address was queried for; they are not used to verify the +response, merely used to fill in the address of the +.BR "struct hostent" . +The resulting +.B struct hostent +is stored in allocated memory and a pointer to it stored into the +variable pointed to by +.IR host . +It is the caller's responsibility to free the resulting host structure +using +.BR ares_free_hostent (3) +when it is no longer needed. +.SH RETURN VALUES +.B ares_parse_ptr_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_gethostbyaddr (3), +.BR ares_free_hostent (3) diff --git a/miniconda3/share/man/man3/ares_parse_soa_reply.3 b/miniconda3/share/man/man3/ares_parse_soa_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..8a80d3fd4ae17be08ef50683f0fc477aa6881129 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_soa_reply.3 @@ -0,0 +1,69 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_SOA_REPLY 3 "29 May 2012" +.SH NAME +ares_parse_soa_reply \- Parse a reply to a DNS query of type SOA +.SH SYNOPSIS +.nf +#include + +int ares_parse_soa_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_soa_reply** \fIsoa_out\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_soa_reply +function parses the response to a query of type SOA into a +.IR struct\ ares_soa_reply . +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR soa_out . +It is the caller's responsibility to free the resulting +.IR soa_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. +.PP +The structure +.I ares_soa_reply +contains the following fields: +.sp +.in +4n +.nf +struct ares_soa_reply { + char *nsname; + char *hostmaster; + unsigned int serial; + unsigned int refresh; + unsigned int retry; + unsigned int expire; + unsigned int minttl; +}; +.fi +.in +.PP +.SH RETURN VALUES +.B ares_parse_soa_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.9.0. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_srv_reply.3 b/miniconda3/share/man/man3/ares_parse_srv_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..2e394a4359512ed39d25bd1fcdbad5f01ba0fe45 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_srv_reply.3 @@ -0,0 +1,68 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_SRV_REPLY 3 "4 August 2009" +.SH NAME +ares_parse_srv_reply \- Parse a reply to a DNS query of type SRV +.SH SYNOPSIS +.nf +#include + +int ares_parse_srv_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_srv_reply** \fIsrv_out\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_srv_reply +function parses the response to a query of type SRV into a +linked list of +.I struct ares_srv_reply +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR srv_out . +It is the caller's responsibility to free the resulting +.IR srv_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. +.PP +The structure +.I ares_srv_reply +contains the following fields: +.sp +.in +4n +.nf +struct ares_srv_reply { + struct ares_srv_reply *next; + unsigned short weight; + unsigned short priority; + unsigned short port; + char *host; +}; +.fi +.in +.PP +.SH RETURN VALUES +.B ares_parse_srv_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.0. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_txt_reply.3 b/miniconda3/share/man/man3/ares_parse_txt_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..eb08a3fa6f4473e5a94c69b4cf2cd3dd4ce64408 --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_txt_reply.3 @@ -0,0 +1,96 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_TXT_REPLY 3 "27 October 2009" +.SH NAME +ares_parse_txt_reply \- Parse a reply to a DNS query of type TXT +.SH SYNOPSIS +.nf +#include + +int ares_parse_txt_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_txt_reply **\fItxt_out\fP); + +int ares_parse_txt_reply_ext(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_txt_ext **\fItxt_out\fP); +.fi +.SH DESCRIPTION +The \fIares_parse_txt_reply(3)\fP and \fIares_parse_txt_reply_ext(3)\fP +functions parse the response to a query of type TXT into a linked list (one +element per sub-string) of +.IR "struct ares_txt_reply" " (" "struct ares_txt_ext" ")" +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR txt_out . +It is the caller's responsibility to free the resulting +.IR txt_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. + +The structure +.I ares_txt_reply +contains the following fields: +.nf +struct ares_txt_reply { + struct ares_txt_reply *next; + unsigned int length; + unsigned char *txt; +}; +.fi + +The structure +.I ares_txt_ext +contains the following fields: +.nf +struct ares_txt_ext { + struct ares_txt_ext *next; + unsigned int length; + unsigned char *txt; + unsigned char record_start; +}; +.fi +The +.I record_start +field in +.I struct ares_txt_ext +is 1 if this structure is a start of a TXT record, and 0 if the structure is a +continuation of a previous record. The linked list of the +.I struct ares_txt_ext +will have at least one item with +.I record_start +equal to 1, and may have some items with +.I record_start +equal to 0 between them. + +These sequences of +.I struct ares_txt_ext +(starting from the item with +.I record_start +equal to 1, and ending right before the record start item) may be treated as +either components of a single TXT record or as a multi-parted TXT record, +depending on particular use case. +.SH RETURN VALUES +.BR "ares_parse_txt_reply" " (" "ares_parse_txt_reply_ext" ")" +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.0. +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_parse_uri_reply.3 b/miniconda3/share/man/man3/ares_parse_uri_reply.3 new file mode 100644 index 0000000000000000000000000000000000000000..ad32821edceca99dc91190de96f4487f061af77e --- /dev/null +++ b/miniconda3/share/man/man3/ares_parse_uri_reply.3 @@ -0,0 +1,62 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PARSE_URI_REPLY 3 "14 August 2020" +.SH NAME +ares_parse_uri_reply \- Parse a reply to a DNS query of type URI +.SH SYNOPSIS +.nf +#include + +int ares_parse_uri_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, + struct ares_uri_reply** \fIuri_out\fP); +.fi +.SH DESCRIPTION +The \fIares_parse_uri_reply(3)\fP function parses the response to a query of +type URI into a linked list of +.I struct ares_uri_reply +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR uri_out . +It is the caller's responsibility to free the resulting +.IR uri_out +structure when it is no longer needed using the function +\fBares_free_data(3)\fP. + +The structure +.I ares_uri_reply +contains the following fields: +.nf +struct ares_uri_reply { + struct ares_uri_reply *next; + unsigned short weight; + unsigned short priority; + char *uri; + int ttl; +}; +.fi +.SH RETURN VALUES +.B ares_parse_uri_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH AVAILABILITY + +.SH SEE ALSO +.BR ares_query (3) +.BR ares_free_data (3) diff --git a/miniconda3/share/man/man3/ares_process.3 b/miniconda3/share/man/man3/ares_process.3 new file mode 100644 index 0000000000000000000000000000000000000000..ce45a60d6c07d4795fa3a46744451b1b52c7018a --- /dev/null +++ b/miniconda3/share/man/man3/ares_process.3 @@ -0,0 +1,109 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_PROCESS 3 "25 July 1998" +.SH NAME +ares_process_fds, ares_process_fd, ares_process \- Process events for name resolution +.SH SYNOPSIS +.nf +#include + +/*! Events used by ares_fd_events_t */ +typedef enum { + ARES_FD_EVENT_NONE = 0, /*!< No events */ + ARES_FD_EVENT_READ = 1 << 0, /*!< Read event (including disconnect/error) */ + ARES_FD_EVENT_WRITE = 1 << 1 /*!< Write event */ +} ares_fd_eventflag_t; + +/*! Type holding a file descriptor and mask of events, used by + * ares_process_fds() */ +typedef struct { + ares_socket_t fd; /*!< File descriptor */ + unsigned int events; /*!< Mask of ares_fd_event_t */ +} ares_fd_events_t; + +typedef enum { + ARES_PROCESS_FLAG_NONE = 0, + ARES_PROCESS_FLAG_SKIP_NON_FD = 1 << 0 +} ares_process_flag_t; + + +ares_status_t ares_process_fds(ares_channel_t *\fIchannel\fP, + const ares_fd_events_t *\fIevents\fP, + size_t \fInevents\fP, + unsigned int \fIflags\fP) + +void ares_process_fd(ares_channel_t *\fIchannel\fP, + ares_socket_t \fIread_fd\fP, + ares_socket_t \fIwrite_fd\fP) + +void ares_process(ares_channel_t *\fIchannel\fP, + fd_set *\fIread_fds\fP, + fd_set *\fIwrite_fds\fP) + +.fi +.SH DESCRIPTION +These functions must be used by integrators choosing not to use the +EventThread enabled via \fBARES_OPT_EVENT_THREAD\fP passed to +\fBares_init_options\fP. This assumes integrators already have their own +event loop handling event notifications for various file descriptors and +wish to do the same with their integration with c-ares. + +The \fBares_process_fds(3)\fP function handles input/output events on file +descriptors and timeouts associated with queries pending on the channel +identified by \fIchannel\fP. The file descriptors to be processed are passed +in an array of \fIares_fd_events_t\fP data structures in the \fIfd\fP member, +and events are a bitwise mask of \fIares_fd_eventflag_t\fP in the \fIevent\fP +member. This function can also be used to process timeouts by passing NULL +to the \fIevents\fP member with \fInevents\fP value of 0. Flags may also be +specified in the \fIflags\fP field and are defined in \fBares_process_flag_t\fP. + +\fBARES_PROCESS_FLAG_SKIP_NON_FD\fP can be specified to specifically skip any +processing unrelated to the file descriptor events passed in, examples include +timeout processing and cleanup handling. This is useful if an integrator +knows they will be sending multiple \fIares_process_fds(3)\fP requests and +wants to skip that extra processing. However, the integrator must send the +final request with the flag so that timeout and other processing gets performed +before their event loop waits on additional events. + +It is allowable to use an \fIares_fd_events_t\fP with \fIevents\fP member of +value \fIARES_FD_EVENT_NONE\fP (0) if there are no events for a given file +descriptor if an integrator wishes to simply maintain an array with all +possible file descriptors and update readiness via the \fIevent\fP member. + +This function will return \fIARES_ENOMEM\fP in out of memory conditions, +otherwise will return \fIARES_SUCCESS\fP. + +This function is recommended over \fBares_process_fd(3)\fP since it can +handle processing of multiple file descriptors at once, thus skipping repeating +additional logic such as timeout processing which would be required if calling +\fBares_process_fd(3)\fP for multiple file descriptors notified at the same +time. + +This function is typically used with the \fIARES_OPT_SOCK_STATE_CB\fP option. + +\fBares_timeout(3)\fP should be used to retrieve the desired timeout, and when +the timeout expires, the integrator must call \fBares_process_fds(3)\fP with +a NULL \fIevents\fP array. (or \fBares_process_fd(3)\fP with both sockets set +to \fIARES_SOCKET_BAD\fP). There is no need to do this if events are also +delivered for any file descriptors as timeout processing will automatically be +handled by any call to \fBares_process_fds(3)\fP or \fBares_process_fd(3)\fP. + +The \fBares_process_fd(3)\fP function is the same as \fBares_process_fds(3)\fP +except can only process a single read and write file descriptor at a time. +New integrators should use \fBares_process_fds(3)\fP if possible. + +The \fBares_process(3)\fP function works in the same manner, except it works +on \fIfd_sets\fP as is used by \fBselect(3)\fP and retrieved by +\fBares_fds(3)\fP. This method is deprecated and should not be used in modern +applications due to known limitations to the \fBselect(3)\fP implementation. + +.SH AVAILABILITY +\fBares_process_fds(3)\fP was introduced in c-ares 1.34.0. + +.SH SEE ALSO +.BR ares_fds (3), +.BR ares_timeout (3), +.BR ares_init_options (3) +with \fIARES_OPT_EVENT_THREAD\fP or \fIARES_OPT_SOCK_STATE_CB\fP diff --git a/miniconda3/share/man/man3/ares_process_fd.3 b/miniconda3/share/man/man3/ares_process_fd.3 new file mode 100644 index 0000000000000000000000000000000000000000..94e50f41a91717aa4acb0a0c86802f4a3c67030f --- /dev/null +++ b/miniconda3/share/man/man3/ares_process_fd.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_process.3 diff --git a/miniconda3/share/man/man3/ares_process_fds.3 b/miniconda3/share/man/man3/ares_process_fds.3 new file mode 100644 index 0000000000000000000000000000000000000000..94e50f41a91717aa4acb0a0c86802f4a3c67030f --- /dev/null +++ b/miniconda3/share/man/man3/ares_process_fds.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_process.3 diff --git a/miniconda3/share/man/man3/ares_process_pending_write.3 b/miniconda3/share/man/man3/ares_process_pending_write.3 new file mode 100644 index 0000000000000000000000000000000000000000..90843341950bbbb3899e505be596af44e6abb221 --- /dev/null +++ b/miniconda3/share/man/man3/ares_process_pending_write.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_set_pending_write_cb.3 diff --git a/miniconda3/share/man/man3/ares_query.3 b/miniconda3/share/man/man3/ares_query.3 new file mode 100644 index 0000000000000000000000000000000000000000..3aa428b00bb8135b2aa723f75ed2b92d6e7d6cb7 --- /dev/null +++ b/miniconda3/share/man/man3/ares_query.3 @@ -0,0 +1,154 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_QUERY 3 "24 July 1998" +.SH NAME +ares_query \- Initiate a single-question DNS query +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_callback_dnsrec)(void *arg, ares_status_t status, + size_t timeouts, + const ares_dns_record_t *dnsrec); + +ares_status_t ares_query_dnsrec(ares_channel_t *channel, + const char *name, + ares_dns_class_t dnsclass, + ares_dns_rec_type_t type, + ares_callback_dnsrec callback, + void *arg, + unsigned short *qid); + +typedef void (*ares_callback)(void *arg, int status, + int timeouts, unsigned char *abuf, + int alen); + +void ares_query(ares_channel_t *channel, const char *name, + int dnsclass, int type, + ares_callback callback, void *arg); + +.fi + +.SH DESCRIPTION + +The \fBares_query_dnsrec(3)\fP and \fBares_query(3)\fP functions initiate a +single-question DNS query on the name service channel identified by +.IR channel . +The parameter +.I name +gives the query name as a NUL-terminated C string of period-separated +labels optionally ending with a period; periods and backslashes within +a label must be escaped with a backslash. The parameters +.I dnsclass +and +.I type +give the class and type of the query. + +\fBares_query_dnsrec(3)\fP uses the ares \fBares_dns_class_t\fP and +\fBares_dns_rec_type_t\fP defined types. However, \fBares_query(3)\fP uses +the values defined in \fB\fP. + +When the query is complete or has failed, the ares library will invoke +.IR callback . +Completion or failure of the query may happen immediately (even before the +return of the function call), or may happen during a later call to +\fBares_process(3)\fP or \fBares_destroy(3)\fP. + +If this is called from a thread other than which the main program event loop is +running, care needs to be taken to ensure any file descriptor lists are updated +immediately within the eventloop. When the associated callback is called, +it is called with a channel lock so care must be taken to ensure any processing +is minimal to prevent DNS channel stalls. + +The callback argument +.I arg +is copied from the \fBares_query_dnsrec(3)\fP or \fBares_query(3)\fP argument +.IR arg . +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The query completed successfully. +.TP 19 +.B ARES_ENODATA +The query completed but contains no answers. +.TP 19 +.B ARES_EFORMERR +The query completed but the server claims that the query was +malformatted. +.TP 19 +.B ARES_ESERVFAIL +The query completed but the server claims to have experienced a +failure. (This code can only occur if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the \fBares_send_dnsrec(3)\fP level.) +.TP 19 +.B ARES_ENOTFOUND +The query completed but the queried-for domain name was not found. +.TP 19 +.B ARES_ENOTIMP +The query completed but the server does not implement the operation +requested by the query. (This code can only occur if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the \fBares_send_dnsrec(3)\fP level.) +.TP 19 +.B ARES_EREFUSED +The query completed but the server refused the query. (This code can +only occur if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the \fBares_send_dnsrec(3)\fP level.) +.TP 19 +.B ARES_EBADNAME +The query name +.I name +could not be encoded as a domain name, either because it contained a +zero-length label or because it contained a label of more than 63 +characters. +.TP 19 +.B ARES_ETIMEOUT +No name servers responded within the timeout period. +.TP 19 +.B ARES_ECONNREFUSED +No name servers could be contacted. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.TP 19 +.B ARES_ENOSERVER +The query will not be completed because no DNS servers were configured on the +channel. +.PP + +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. + +If the query completed (even if there was something wrong with it, as +indicated by some of the above error codes), the callback argument +.I dnsrec +or +.I abuf +will be non-NULL, otherwise they will be NULL. + +.SH AVAILABILITY +\fBares_query_dnsrec(3)\fP was introduced in c-ares 1.28.0. + +.SH SEE ALSO +.BR ares_process (3), +.BR ares_dns_record (3) diff --git a/miniconda3/share/man/man3/ares_query_dnsrec.3 b/miniconda3/share/man/man3/ares_query_dnsrec.3 new file mode 100644 index 0000000000000000000000000000000000000000..b178e9876460551f79fa0025c335354cc2e20c2d --- /dev/null +++ b/miniconda3/share/man/man3/ares_query_dnsrec.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_query.3 diff --git a/miniconda3/share/man/man3/ares_queue.3 b/miniconda3/share/man/man3/ares_queue.3 new file mode 100644 index 0000000000000000000000000000000000000000..276d31f6088a7b50b0a21799003fb53e76aa6c7e --- /dev/null +++ b/miniconda3/share/man/man3/ares_queue.3 @@ -0,0 +1,52 @@ +.\" +.\" Copyright 2024 by the c-ares project and its contributors +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_QUEUE 3 "16 February 2024" +.SH NAME +ares_queue_wait_empty, ares_queue_active_queries \- Functions for checking the +c-ares queue status +.SH SYNOPSIS +.nf +#include + +size_t ares_queue_active_queries(const ares_channel_t *channel); + +ares_status_t ares_queue_wait_empty(ares_channel_t *channel, + int timeout_ms); +.fi +.SH DESCRIPTION +The \fBares_queue_active_queries(3)\fP function retrieves the total number of +active queries pending answers from servers. Some c-ares requests may spawn +multiple queries, such as \fIares_getaddrinfo(3)\fP when using \fIAF_UNSPEC\fP, +which will be reflected in this number. The \fBchannel\fP parameter must be set +to an initialized channel. + +The \fBares_queue_wait_empty(3)\fP function blocks until notified that there are +no longer any queries in queue, or the specified timeout has expired. The +\fBchannel\fP parameter must be set to an initialized channel. The +\fBtimeout_ms\fP parameter is the number of milliseconds to wait for the queue +to be empty or -1 for Infinite. + +.SH RETURN VALUES +\fIares_queue_active_queries(3)\fP returns the active query count. + +\fIares_queue_wait_empty(3)\fP can return any of the following values: +.TP 14 +.B ARES_ENOTIMP +if not built with threading support +.TP 14 +.B ARES_ETIMEOUT +if requested timeout expired +.TP 14 +.B ARES_SUCCESS +when queue is empty. +.TP 14 + +.SH AVAILABILITY +This function was first introduced in c-ares version 1.27.0, and requires the +c-ares library to be built with threading support. + +.SH SEE ALSO +.BR ares_init_options (3), +.BR ares_threadsafety (3) diff --git a/miniconda3/share/man/man3/ares_queue_active_queries.3 b/miniconda3/share/man/man3/ares_queue_active_queries.3 new file mode 100644 index 0000000000000000000000000000000000000000..c16c69ddcb9e02338393e58c54df1cc4d5058149 --- /dev/null +++ b/miniconda3/share/man/man3/ares_queue_active_queries.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2024 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_queue.3 diff --git a/miniconda3/share/man/man3/ares_queue_wait_empty.3 b/miniconda3/share/man/man3/ares_queue_wait_empty.3 new file mode 100644 index 0000000000000000000000000000000000000000..c16c69ddcb9e02338393e58c54df1cc4d5058149 --- /dev/null +++ b/miniconda3/share/man/man3/ares_queue_wait_empty.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2024 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_queue.3 diff --git a/miniconda3/share/man/man3/ares_reinit.3 b/miniconda3/share/man/man3/ares_reinit.3 new file mode 100644 index 0000000000000000000000000000000000000000..020af1dbebb0f49afaf5f7953846c12f80daf2a2 --- /dev/null +++ b/miniconda3/share/man/man3/ares_reinit.3 @@ -0,0 +1,53 @@ +.\" +.\" Copyright 2023 by the c-ares project and its contributors +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_REINIT 3 "12 November 2023" +.SH NAME +ares_reinit \- ReInitialize a resolver channel from system configuration. +.SH SYNOPSIS +.nf +#include + +int ares_reinit(ares_channel_t *\fIchannel\fP) +.fi +.SH DESCRIPTION +The \fBares_reinit(3)\fP function re-reads the system configuration and safely +applies the configuration to the existing channel. System configuration will +never override user-provided settings such as provided via +\fBares_init_options(3)\fP or \fBares_set_servers(3)\fP. + +Any existing queries will be automatically requeued if the server they are +currently assigned to is removed from the system configuration. + +This function may cause additional file descriptors to be created, and existing +ones to be destroyed if server configuration has changed. + +\Bares_reinit(3)\fP, when compiled with thread safety, will spawn a background +thread to read the configuration and apply it. It is crucial that developers +use the \fBARES_OPT_SOCK_STATE_CB\fP or \fBARES_OPT_EVENT_THREAD\fP so that +notifications of changes are alerted. If using \fBares_getsock(3)\fP or +\fBares_fds(3)\fP, no notification is possible which could cause a stall. + +.SH RETURN VALUES +\fIares_reinit(3)\fP can return any of the following values: +.TP 14 +.B ARES_SUCCESS +Initialization succeeded. +.TP 14 +.B ARES_EFILE +A configuration file could not be read. +.TP 14 +.B ARES_ENOMEM +The process's available memory was exhausted. + +.SH AVAILABILITY +This function was first introduced in c-ares version 1.22.0. +.SH SEE ALSO +.BR ares_init (3), +.BR ares_init_options (3), +.BR ares_destroy (3), +.BR ares_dup (3), +.BR ares_library_init (3), +.BR ares_set_servers (3), +.BR ares_threadsafety (3) diff --git a/miniconda3/share/man/man3/ares_save_options.3 b/miniconda3/share/man/man3/ares_save_options.3 new file mode 100644 index 0000000000000000000000000000000000000000..1a1fbfdc1c750e783fe229b048ae4a7c1fcdd55e --- /dev/null +++ b/miniconda3/share/man/man3/ares_save_options.3 @@ -0,0 +1,60 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SAVE_OPTIONS 3 "5 March 2010" +.SH NAME +ares_save_options \- Save configuration values obtained from initialized ares_channel +.SH SYNOPSIS +.nf +#include + +int ares_save_options(const ares_channel_t *\fIchannel\fP, + struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) +.fi +.SH DESCRIPTION +The \fBares_save_options(3)\fP function saves the channel data identified by +.IR channel , +into the options struct identified by +.IR options , +and saves the mask of options which are set to the integer +pointer (passed by reference) identified by +.IR optmask . + +The resultant options and optmask are then able to be +passed directly to ares_init_options. When the options +are no longer needed, ares_destroy_options should be called +to free any associated memory. +.SH RETURN VALUES +.B ares_save_options(3) +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The channel data was successfully stored +.TP 15 +.B ARES_ENOMEM +The memory was exhausted +.TP 15 +.B ARES_ENODATA +The channel data identified by +.IR channel +were invalid. +.SH NOTE +Since c-ares 1.6.0 the ares_options struct has been "locked" meaning that it +won't be extended to cover new functions. This function will remain +functioning, but it can only return config data that can be represented in +this config struct, which may no longer be the complete set of config +options. \fBares_dup(3)\fP will not have that restriction. + +The ares_options struct can not handle potential IPv6 name servers the +ares channel might be configured to use. The \fBares_save_options(3)\fP function +will only return IPv4 servers, if any. In order to retrieve all name servers +an ares channel might be using, the \fBares_get_servers(3)\fP function must be +used instead. +.SH SEE ALSO +.BR ares_destroy_options (3), +.BR ares_init_options (3), +.BR ares_get_servers (3), +.BR ares_dup (3) +.SH AVAILABILITY +ares_save_options(3) was added in c-ares 1.4.0 diff --git a/miniconda3/share/man/man3/ares_search.3 b/miniconda3/share/man/man3/ares_search.3 new file mode 100644 index 0000000000000000000000000000000000000000..66791b47e908fbf35b3ebf6cc76121a32172a14e --- /dev/null +++ b/miniconda3/share/man/man3/ares_search.3 @@ -0,0 +1,181 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SEARCH 3 "24 July 1998" +.SH NAME +ares_search \- Initiate a DNS query with domain search +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_callback_dnsrec)(void *\fIarg\fP, + ares_status_t \fIstatus\fP, + size_t \fItimeouts\fP, + const ares_dns_record_t *\fIdnsrec\fP); + +void ares_search_dnsrec(ares_channel_t *\fIchannel\fP, + const ares_dns_record_t *\fIdnsrec\fP, + ares_callback_dnsrec \fIcallback\fP, void *\fIarg\fP); + +typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP, + int \fItimeouts\fP, unsigned char *\fIabuf\fP, + int \fIalen\fP); + +void ares_search(ares_channel_t *\fIchannel\fP, const char *\fIname\fP, + int \fIdnsclass\fP, int \fItype\fP, + ares_callback \fIcallback\fP, void *\fIarg\fP); + +.fi +.SH DESCRIPTION +The +.B ares_search +function initiates a series of single-question DNS queries on the name +service channel identified by +.IR channel , +using the channel's search domains as well as a host alias file given +by the HOSTALIAS environment variable. The parameter +.I name +gives the alias name or the base of the query name as a NUL-terminated +C string of period-separated labels; if it ends with a period, the +channel's search domains will not be used. Periods and backslashes +within a label must be escaped with a backslash. The parameters +.I dnsclass +and +.I type +give the class and type of the query using the values defined in +.BR . +When the query sequence is complete or has failed, the ares library +will invoke +.IR callback . +Completion or failure of the query sequence may happen immediately, or +may happen during a later call to +.BR ares_process (3) +or +.BR ares_destroy (3). +.PP +If this is called from a thread other than which the main program event loop is +running, care needs to be taken to ensure any file descriptor lists are updated +immediately within the eventloop. When the associated callback is called, +it is called with a channel lock so care must be taken to ensure any processing +is minimal to prevent DNS channel stalls. +.PP +The callback argument +.I arg +is copied from the +.B ares_search +argument +.IR arg . +The callback argument +.I status +indicates whether the query sequence ended with a successful query +and, if not, how the query sequence failed. It may have any of the +following values: +.TP 19 +.B ARES_SUCCESS +A query completed successfully. +.TP 19 +.B ARES_ENODATA +No query completed successfully; when the query was tried without a +search domain appended, a response was returned with no answers. +.TP 19 +.B ARES_EFORMERR +A query completed but the server claimed that the query was +malformatted. +.TP 19 +.B ARES_ESERVFAIL +No query completed successfully; when the query was tried without a +search domain appended, the server claimed to have experienced a +failure. (This code can only occur if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the +.BR ares_send (3) +level.) +.TP 19 +.B ARES_ENOTFOUND +No query completed successfully; when the query was tried without a +search domain appended, the server reported that the queried-for +domain name was not found. +.TP 19 +.B ARES_ENOTIMP +A query completed but the server does not implement the operation +requested by the query. (This code can only occur if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the +.BR ares_send (3) +level.) +.TP 19 +.B ARES_EREFUSED +A query completed but the server refused the query. (This code can +only occur returned if the +.B ARES_FLAG_NOCHECKRESP +flag was specified at channel initialization time; otherwise, such +responses are ignored at the +.BR ares_send (3) +level.) +.TP 19 +.B ARES_TIMEOUT +No name servers responded to a query within the timeout period. +.TP 19 +.B ARES_ECONNREFUSED +No name servers could be contacted. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.TP 19 +.B ARES_ENOSERVER +No query completed successfully; no DNS servers were configured on the channel. +.PP +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. +.PP +If a query completed successfully, the callback argument +.I abuf +points to a result buffer of length +.IR alen . +If the query did not complete successfully, +.I abuf +will usually be NULL and +.I alen +will usually be 0, but in some cases an unsuccessful query result may +be placed in +.IR abuf . + +The \fIares_search_dnsrec(3)\fP function behaves identically to +\fIares_search(3)\fP, but takes an initialized and filled DNS record object to +use for queries as the second argument +.I dnsrec +instead of a name, class and type. This object is used as the base for the +queries and must itself represent a valid query for a single name. Note that +the search domains will only be appended to the name in the question section; +RRs on the DNS record object will not be affected. Moreover, the +.I callback +argument is of type \fIares_callback_dnsrec\fP. This callback behaves +identically to \fIares_callback\fP, but is invoked with a parsed DNS record +object +.I dnsrec +rather than a raw buffer with length. Note that this object is read-only. + +The \fIares_search_dnsrec(3)\fP function returns an \fIares_status_t\fP response +code. This may be useful to know that the query was enqueued properly. The +response code does not reflect the result of the query, just the result of the +enqueuing of the query. + +.SH AVAILABILITY +\fBares_search_dnsrec(3)\fP was introduced in c-ares 1.28.0. + +.SH SEE ALSO +.BR ares_process (3), +.BR ares_dns_record (3) diff --git a/miniconda3/share/man/man3/ares_search_dnsrec.3 b/miniconda3/share/man/man3/ares_search_dnsrec.3 new file mode 100644 index 0000000000000000000000000000000000000000..86c2317c071144f34a1c73e3ef03e114a1906e10 --- /dev/null +++ b/miniconda3/share/man/man3/ares_search_dnsrec.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_search.3 diff --git a/miniconda3/share/man/man3/ares_send.3 b/miniconda3/share/man/man3/ares_send.3 new file mode 100644 index 0000000000000000000000000000000000000000..df3e3bbe4136b01ee48cf2a1c194c92e22d3c16d --- /dev/null +++ b/miniconda3/share/man/man3/ares_send.3 @@ -0,0 +1,156 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SEND 3 "25 July 1998" +.SH NAME +ares_send \- Initiate a DNS query +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_callback_dnsrec)(void *arg, ares_status_t status, + size_t timeouts, + const ares_dns_record_t *dnsrec); + +ares_status_t ares_send_dnsrec(ares_channel_t *channel, + const ares_dns_record_t *dnsrec, + ares_callback_dnsrec callback, + void *arg, unsigned short *qid); + +typedef void (*ares_callback)(void *arg, int status, + int timeouts, unsigned char *abuf, + int alen); + +void ares_send(ares_channel_t *channel, const unsigned char *qbuf, + int qlen, ares_callback callback, void *arg); + +.fi +.SH DESCRIPTION +The \fIares_send_dnsrec(3)\fP function initiates a DNS query formatted using the +\fIares_dns_record_t *\fP data structure created via +\fIares_dns_record_create(3)\fP in the +.IR dnsrec +parameter. The supplied callback in the +.IR callback +parameter also returns the response using a +\fIares_dns_record_t *\fP data structure. + +The \fIares_send(3)\fP function similarly initiates a DNS query, but instead uses +raw binary buffers with fully formatted DNS messages passed in the request via the +.IR qbuf +and +.IR qlen +parameters. The supplied callback in the +.IR callback +parameter also returns the raw binary DNS response in the +.IR abuf +and +.IR alen +parameters. This method should be considered deprecated in favor of +\fIares_send_dnsrec(3)\fP. + +Both functions take an initialized ares channel identified by +.IR channel . + +The \fIares_send_dnsrec(3)\fP also can be supplied an optional output parameter of +.IR qid +to populate the query id as it was placed on the wire. + +The \fIares_send_dnsrec(3)\fP function returns an \fIares_status_t\fP response +code. This may be useful to know that the query was enqueued properly. The +response code does not reflect the result of the query, just the result of the +enqueuing of the query. + +Completion or failure of the query may happen immediately (even before the +function returning), or may happen later as network events are processed. + +When the associated callback is called, it is called with a channel lock so care +must be taken to ensure any processing is minimal to prevent DNS channel stalls. + +The callback may be triggered from a different thread than the one which +called \fIares_send_dnsrec(3)\fP or \fIares_send(3)\fP. + +For integrators running their own event loops and not using \fBARES_OPT_EVENT_THREAD\fP, +care needs to be taken to ensure any file descriptor lists are updated immediately +within the eventloop when notified. + +The callback argument +.IR arg +is copied from the \fIares_send_dnsrec(3)\fP or \fIares_send(3)\fP +.IR arg +parameter. + +The callback argument +.I status +indicates whether the query succeeded and, if not, how it failed. It +may have any of the following values: +.TP 19 +.B ARES_SUCCESS +The query completed. +.TP 19 +.B ARES_EBADQUERY +The query buffer was poorly formed (was not long enough for a DNS +header or was too long for TCP transmission). +.TP 19 +.B ARES_ETIMEOUT +No name servers responded within the timeout period. +.TP 19 +.B ARES_ECONNREFUSED +No name servers could be contacted. +.TP 19 +.B ARES_ENOMEM +Memory was exhausted. +.TP 19 +.B ARES_ECANCELLED +The query was cancelled. +.TP 19 +.B ARES_EDESTRUCTION +The name service channel +.I channel +is being destroyed; the query will not be completed. +.TP 19 +.B ARES_ENOSERVER +The query will not be completed because no DNS servers were configured on the +channel. +.TP 19 +.B ARES_EBADQUERY +Misformatted DNS query. +.PP + +The callback argument +.I timeouts +reports how many times a query timed out during the execution of the +given request. + +If the query completed, the callback argument +.IR dnsrec +for \fIares_send_dnsrec(3)\fP or +.IR abuf +and +.IR alen +for \fIares_send(3)\fP will be non-NULL. + +Unless the flag +.B ARES_FLAG_NOCHECKRESP +was set at channel initialization time, \fIares_send_dnsrec(3)\fP and +\fIares_send(3)\fP will normally ignore responses whose questions do not match +the supplied questions, as well as responses with reply codes of +.BR SERVFAIL , +.BR NOTIMP , +and +.BR REFUSED . +Unlike other query functions in the ares library, however, +\fIares_send_dnsrec(3)\fP and \fIares_send(3)\fP do not inspect the header of +the reply packet to determine the error status, so a callback status of +.B ARES_SUCCESS +does not reflect as much about the response as for other query functions. + +.SH AVAILABILITY +\fBares_send_dnsrec(3)\fP was introduced in c-ares 1.28.0. + +.SH SEE ALSO +.BR ares_dns_record_create (3), +.BR ares_process (3), +.BR ares_search (3), +.BR ares_dns_record (3) diff --git a/miniconda3/share/man/man3/ares_send_dnsrec.3 b/miniconda3/share/man/man3/ares_send_dnsrec.3 new file mode 100644 index 0000000000000000000000000000000000000000..f5596f5cf049bc3091ea6d3622bc2738cf77c994 --- /dev/null +++ b/miniconda3/share/man/man3/ares_send_dnsrec.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_send.3 diff --git a/miniconda3/share/man/man3/ares_set_local_dev.3 b/miniconda3/share/man/man3/ares_set_local_dev.3 new file mode 100644 index 0000000000000000000000000000000000000000..621cf35184fe1028bd4ecc1b0844cd68ca0fd223 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_local_dev.3 @@ -0,0 +1,28 @@ +.\" +.\" Copyright 2010 by Ben Greear +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_LOCAL_DEV 3 "23 September 2024" +.SH NAME +ares_set_local_dev \- Bind to a specific network device when creating sockets. +.SH SYNOPSIS +.nf +#include + +void ares_set_local_dev(ares_channel_t *\fIchannel\fP, const char* \fIlocal_dev_name\fP) +.fi +.SH DESCRIPTION +The \fBares_set_local_dev\fP function causes all future sockets +to be bound to this device with SO_BINDTODEVICE. This forces communications +to go over a certain interface, which can be useful on multi-homed machines. +This option is only supported on Linux, the interface must not be already bound to the +socket or the current effective user must have CAP_NET_RAW capability in the current +network namespace for the option to work. If SO_BINDTODEVICE is not supported or the +setsockopt call fails (probably because of permissions), the error is +silently ignored. +.SH SEE ALSO +.BR ares_set_local_ip4 (3) +.BR ares_set_local_ip6 (3) +.BR network_namespaces (7) +.SH NOTES +This function was added in c-ares 1.7.4 diff --git a/miniconda3/share/man/man3/ares_set_local_ip4.3 b/miniconda3/share/man/man3/ares_set_local_ip4.3 new file mode 100644 index 0000000000000000000000000000000000000000..e311255b68dabef2f500a3324e49641f4ca04d3e --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_local_ip4.3 @@ -0,0 +1,21 @@ +.\" +.\" Copyright 2010 by Ben Greear +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_LOCAL_IP4 3 "30 June 2010" +.SH NAME +ares_set_local_ip4 \- Set local IPv4 address outgoing requests. +.SH SYNOPSIS +.nf +#include + +void ares_set_local_ip4(ares_channel_t *\fIchannel\fP, unsigned int \fIlocal_ip\fP) +.fi +.SH DESCRIPTION +The \fBares_set_local_ip4\fP function sets the IP address for outbound +requests. The parameter \fIlocal_ip\fP is specified in host byte order. This +allows users to specify outbound interfaces when used on multi-homed systems. +.SH SEE ALSO +.BR ares_set_local_ip6 (3) +.SH NOTES +This function was added in c-ares 1.7.4 diff --git a/miniconda3/share/man/man3/ares_set_local_ip6.3 b/miniconda3/share/man/man3/ares_set_local_ip6.3 new file mode 100644 index 0000000000000000000000000000000000000000..a43d28007ef87c7054e9ca0b4a35b914d76d68c4 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_local_ip6.3 @@ -0,0 +1,22 @@ +.\" +.\" Copyright 2010 by Ben Greear +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_LOCAL_IP6 3 "30 June 2010" +.SH NAME +ares_set_local_ip6 \- Set local IPv6 address outgoing requests. +.SH SYNOPSIS +.nf +#include + +void ares_set_local_ip6(ares_channel_t *\fIchannel\fP, const unsigned char* \fIlocal_ip6\fP) +.fi +.SH DESCRIPTION +The \fBares_set_local_ip6\fP function sets the IPv6 address for outbound IPv6 +requests. The parameter \fIlocal_ip6\fP is specified in network byte order. +This allows users to specify outbound interfaces when used on multi-homed +systems. The \fIlocal_ip6\fP argument must be 16 bytes in length. +.SH SEE ALSO +.BR ares_set_local_ip4 (3) +.SH NOTES +This function was added in c-ares 1.7.4 diff --git a/miniconda3/share/man/man3/ares_set_pending_write_cb.3 b/miniconda3/share/man/man3/ares_set_pending_write_cb.3 new file mode 100644 index 0000000000000000000000000000000000000000..3c7712a69d96e43991237de9754b6adf2cc6cb2a --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_pending_write_cb.3 @@ -0,0 +1,62 @@ +.\" +.\" Copyright 2024 by the c-ares project and its contributors +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_NOTIFY_PENDING_WRITE_CALLBACK 3 "13 Aug 2024" +.SH NAME +ares_set_pending_write_cb, ares_process_pending_write \- Function +for setting a callback which is triggered when there is potential pending data +which needs to be written. +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_pending_write_cb)(void *\fIdata\fP); + +void ares_set_pending_write_cb( + ares_channel_t *\fIchannel\fP, + ares_pending_write_cb \fIcallback\fP, + void *\fIuser_data\fP); + +void ares_process_pending_write(ares_channel_t *\fIchannel\fP); + +.fi + +.SH DESCRIPTION +The \fBares_set_pending_write_cb(3)\fP function sets a callback +function \fIcallback\fP in the given ares channel handle \fIchannel\fP that +is invoked whenever there is new pending TCP data to be written. Since TCP +is stream based, if there are multiple queries being enqueued back to back they +can be sent as one large buffer. Normally a \fBsend(2)\fP syscall operation +would be triggered for each query. + +When setting this callback, an event will be triggered when data is buffered, +but not written. This event is used to wake the caller's event loop which +should call \fBares_process_pending_write(3)\fP using the channel associated +with the callback. Each time the callback is triggered must result in a call +to \fBares_process_pending_write(3)\fP from the caller's event loop otherwise +stalls and timeouts may occur. The callback \fBmust not\fP call +\fBares_process_pending_write(3)\fP directly as otherwise it would invalidate +any advantage of this use-case. + +This is considered an optimization, especially when using TLS-based connections +which add additional overhead to the data stream. Due to the asyncronous nature +of c-ares, there is no way to identify when a caller may be finished enqueuing +queries via any of the possible public API calls such as +\fBares_getaddrinfo(3)\fP or \fBares_search_dnsrec(3)\fP, so this is an +enhancement to try to group query send operations together and will rely on the +singaling latency involved in waking the user's event loop. + +If no callback is set, data will be written immediately to the socket, thus +bypassing this optimization. + +This option cannot be used with \fIARES_OPT_EVENT_THREAD\fP passed to +\fBares_init_options(3)\fP since the user has no event loop. This optimization +is automatically enabled when using the Event Thread as it sets the callback +for its own internal signaling. + +.SH AVAILABILITY +This function was first introduced in c-ares version 1.34.0. + +.SH SEE ALSO +.BR ares_init_options (3) diff --git a/miniconda3/share/man/man3/ares_set_server_state_callback.3 b/miniconda3/share/man/man3/ares_set_server_state_callback.3 new file mode 100644 index 0000000000000000000000000000000000000000..04fbde4c7afa7640a9141cd87ade0581b357aa09 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_server_state_callback.3 @@ -0,0 +1,62 @@ +.\" +.\" Copyright 2024 by the c-ares project and its contributors +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_SERVER_STATE_CALLBACK 3 "26 Apr 2024" +.SH NAME +ares_set_server_state_callback \- Function for setting a server state callback +.SH SYNOPSIS +.nf +#include + +typedef void (*ares_server_state_callback)(const char *\fIserver_string\fP, + ares_bool_t \fIsuccess\fP, + int \fIflags\fP, + void *\fIdata\fP); + +void ares_set_server_state_callback(ares_channel_t *\fIchannel\fP, + ares_server_state_callback \fIcallback\fP, + void *\fIuser_data\fP); +.fi + +.SH DESCRIPTION +The \fBares_set_server_state_callback(3)\fP function sets a callback function +\fIcallback\fP in the given ares channel handle \fIchannel\fP that is invoked +whenever a query on the channel completes. This includes both successful and +unsuccessful queries (including hard errors and timeouts). The callback +function is invoked with a number of parameters describing the query, as +follows. + +The \fIserver_string\fP parameter indicates the DNS server that was used for +the query, given as a string with the same format returned by +\fBares_get_servers_csv(3)\fP. + +The \fIsuccess\fP parameter indicates whether the query succeeded or not. It is +set to \fBARES_TRUE\fP on success and \fBARES_FALSE\fP on failure. + +The \fIflags\fP parameter is a bitmask of flags describing various aspects of +the query (for example whether the query used UDP or TCP). These are described +below. + +The \fIdata\fP parameter is a reference to the custom user data \fIuser_data\fP +that was passed to \fBares_set_server_state_callback(3)\fP when setting the +server state callback. + +The server state callback can be used by applications to monitor the state of +the DNS servers used by an ares channel. For example, it can be used to track +metrics about the numbers and types of queries sent to each server or to +detect when a server is uncontactable or unhealthy. + +.SH FLAGS +.TP 5 +.B ARES_SERV_STATE_UDP +Indicates that the query was tried over UDP. +.TP 5 +.B ARES_SERV_STATE_TCP +Indicates that the query was tried over TCP. + +.SH AVAILABILITY +This function was first introduced in c-ares version 1.29.0. + +.SH SEE ALSO +.BR ares_get_servers_csv (3) diff --git a/miniconda3/share/man/man3/ares_set_servers.3 b/miniconda3/share/man/man3/ares_set_servers.3 new file mode 100644 index 0000000000000000000000000000000000000000..24ef7879e176124a98aa73dfdcc4ce074f16ab4a --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_servers.3 @@ -0,0 +1,86 @@ +.\" +.\" Copyright 2010 by Ben Greear +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_SERVERS 3 "5 March 2010" +.SH NAME +ares_set_servers, ares_set_servers_ports \- Initialize name server configuration +for an ares channel. (deprecated) +.SH SYNOPSIS +.nf +#include + +int ares_set_servers(ares_channel_t *\fIchannel\fP, + const struct ares_addr_node *\fIservers\fP) + +int ares_set_servers_ports(ares_channel_t *\fIchannel\fP, + const struct ares_addr_port_node *\fIservers\fP) +.fi +.SH DESCRIPTION +The \fBares_set_servers(3)\fP function initializes name servers configuration +for the channel data identified by +.IR channel , +from a +.IR servers +pointer to a linked list of ares_addr_node structs holding name servers +address data. +.PP +The name server linked list pointer argument may be the result of a previous +call to \fBares_get_servers(3)\fP or a linked list of \fBares_addr_node\fP structs +set up by other means. +.PP +The \fBares_set_servers_ports(3)\fP function also allows the specification of UDP and +TCP ports to be used for communication on a per-server basis. The provided +linked list argument may be the result of a previous call to +\fBares_get_servers_ports(3)\fP or a linked list of \fBares_addr_port_node\fP structs +set up by other means. +.PP +This function replaces any potentially previously configured name servers +with the ones given in the linked list. So, in order to configure a channel +with more than one name server all the desired ones must be specified in a +single list. Though not recommended, passing NULL will clear all configured +servers and make an inoperable channel, this may be advantageous for test +simulation but unlikely to be useful in production. +.PP +The function does not take ownership of the linked list argument. +The caller is responsible for freeing the linked list when no longer needed. +.PP +This function is capable of handling IPv4 and IPv6 name server +addresses simultaneously, rendering \fBares_init_options(3)\fP with +optmask \fBARES_OPT_SERVERS\fP functionally obsolete except for +IPv4-only name server usage. +.PP +As of v1.22.0 this function can +be called on an active channel with running queries, previously it would return +ARES_ENOTIMP. + +.SH RETURN VALUES +.B ares_set_servers(3) +may return any of the following values: +.TP 15 +.B ARES_SUCCESS +The name servers configuration was successfully initialized. +.TP 15 +.B ARES_ENOMEM +The process's available memory was exhausted. +.TP 15 +.B ARES_ENODATA +The channel data identified by +.IR channel +was invalid. +.TP 15 +.B ARES_ENOTINITIALIZED +c-ares library initialization not yet performed. +.SH SEE ALSO +.BR ares_set_servers_csv (3), +.BR ares_get_servers (3), +.BR ares_init_options (3), +.BR ares_dup (3) + +.SH NOTES +Deprecated functions as of c-ares 1.24.0 due to inability to set all available +server options. Use \fBares_set_servers_csv(3)\fP. + +.SH AVAILABILITY +\fBares_set_servers(3)\fP was added in c-ares 1.7.1; +\fBares_set_servers_ports(3)\fP was added in c-ares 1.11.0. diff --git a/miniconda3/share/man/man3/ares_set_servers_csv.3 b/miniconda3/share/man/man3/ares_set_servers_csv.3 new file mode 100644 index 0000000000000000000000000000000000000000..f1435143f567a4412067770fd8b4add56b591b99 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_servers_csv.3 @@ -0,0 +1,163 @@ +.\" +.\" Copyright 2010 by Ben Greear +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_SERVERS_CSV 3 "5 Dec 2023" +.SH NAME +ares_set_servers_csv, ares_set_servers_ports_csv, ares_get_servers_csv \- Set +or Get a list of DNS servers used for queries. +.SH SYNOPSIS +.nf +#include + +int ares_set_servers_csv(ares_channel_t *\fIchannel\fP, const char* \fIservers\fP) + +int ares_set_servers_ports_csv(ares_channel_t *\fIchannel\fP, const char* \fIservers\fP) + +char *ares_get_servers_csv(const ares_channel_t *\fIchannel\fP) +.fi +.SH DESCRIPTION +The \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fP functions set +the list of DNS servers that c-ares will query. As of v1.22.0 this function can +be called on an active channel with running queries, previously it would return +ARES_ENOTIMP. + +Though not recommended, passing NULL for servers will clear all configured +servers and make an inoperable channel, this may be advantageous for test +simulation but unlikely to be useful in production. + +The \fBares_get_servers_csv\fP retrieves the list of servers in comma delimited +format. + +The input and output format is a comma separated list of servers. Two formats +are available, the typical \fBresolv.conf(5)\fP \fInameserver\fP format, as +well as a \fIURI\fP format. Both formats can be used at the same time in the +provided CSV string. + +The \fInameserver\fP format is: +.nf + +ip[:port][%iface] + +.fi +.RS 4 +The \fBip\fP may be encapsulated in square brackets ([ ]), and must be if +using ipv6 and also specifying a port. + +The \fBport\fP is optional, and will default to 53 or the value specified in +\fBares_init_options(3)\fP. + +The \fBiface\fP is specific to IPv6 link-local servers (fe80::/10) and should +not otherwise be used. +.RE + +\fInameserver\fP format examples: +.nf + +192.168.1.100 +192.168.1.101:53 +[1:2:3::4]:53 +[fe80::1]:53%eth0 + +.fi +.PP + +The \fIURI\fP format is is made up of these defined schemes: +.RS 4 +\fIdns://\fP - Normal DNS server (UDP + TCP). We need to be careful not to +conflict with query params defined in RFC4501 since we'd technically be +extending this URI scheme. Port defaults to 53. + +\fIdns+tls://\fP - DNS over TLS. Port defaults to 853. + +\fIdns+https://\fP - DNS over HTTPS. Port defaults to 443. +.RE + +.PP +Query parameters are defined as below. Additional parameters may be defined +in the future. + +.RS 4 +\fItcpport\fP - TCP port to use, only for \fIdns://\fP scheme. The port +specified as part of the authority component of the URI will be used for both +UDP and TCP by default, this option will override the TCP port. + +\fIipaddr\fP - Only for \fIdns+tls://\fP and \fIdns+https://\fP. If the +authority component of the URI contains a hostname, this is used to specify the +ip address of the hostname. If not specified, will need to use a non-secure +server to perform a DNS lookup to retrieve this information. It is always +recommended to have both the ip address and fully qualified domain name +specified. + +\fIhostname\fP - Only for \fIdns+tls://\fP and \fIdns+https://\fP. If the +authority component of the URI contains an ip address, this is used to specify +the fully qualified domain name of the server. If not specified, will need to +use a non-secure server to perform a DNS reverse lookup to retrieve this +information. It is always recommended to have both the ip address and fully +qualified domain name specified. + +\fIdomain\fP - If specified, this server is a domain-specific server. Any +queries for this domain will be routed to this server. Multiple servers may be +tagged with the same domain. +.RE + +\fIURI\fP format Examples: +.nf + +dns://8.8.8.8 +dns://[2001:4860:4860::8888] +dns://[fe80::b542:84df:1719:65e3%en0] +dns://192.168.1.1:55 +dns://192.168.1.1?tcpport=1153 +dns://10.0.1.1?domain=myvpn.com +dns+tls://8.8.8.8?hostname=dns.google +dns+tls://one.one.one.one?ipaddr=1.1.1.1 + +.fi + +\fBNOTE\fP: While we are defining the scheme for things like domain-specific +servers, DNS over TLS and DNS over HTTPS, the underlying implementations for +those features do not yet exist and therefore will result in errors if they are +attempted to be used. + +.PP +As of c-ares 1.24.0, \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fP +are identical. Prior versions would simply omit ports in \fBares_set_servers_csv\fP +but due to the addition of link local interface support, this difference was +removed. + +.SH EXAMPLE +.nf +192.168.1.100,[fe80::1]:53%eth0,dns://192.168.1.1?tcpport=1153 +.fi + +.SH RETURN VALUES +.B ares_set_servers_csv(3) +and +.B ares_set_servers_ports_csv(3) +may return any of the following values: +.TP 15 +.B ARES_SUCCESS +The name servers configuration was successfully initialized. +.TP 15 +.B ARES_ENOMEM +The process's available memory was exhausted. +.TP 15 +.B ARES_ENODATA +The channel data identified by +.IR channel +was invalid. +.TP 15 +.B ARES_ENOTINITIALIZED +c-ares library initialization not yet performed. +.PP +.B ares_get_servers_csv(3) +returns a string representing the servers configured which must be freed with +\fBares_free_string(3)\fP. If it returns NULL, this is an out of memory condition. +.SH SEE ALSO +.BR ares_set_servers (3) +.SH AVAILABILITY +\fBares_set_servers_csv\fP was added in c-ares 1.7.2 +\fBares_set_servers_ports_csv\fP was added in c-ares 1.11.0. +\fBares_get_servers_csv\fP was added in c-ares 1.24.0. +\fIURI\fP support was added in c-ares 1.34.0. diff --git a/miniconda3/share/man/man3/ares_set_servers_ports.3 b/miniconda3/share/man/man3/ares_set_servers_ports.3 new file mode 100644 index 0000000000000000000000000000000000000000..5b08f58091349f5e7fca26f246a3ba663a4e9f7d --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_servers_ports.3 @@ -0,0 +1,4 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.so man3/ares_set_servers.3 diff --git a/miniconda3/share/man/man3/ares_set_servers_ports_csv.3 b/miniconda3/share/man/man3/ares_set_servers_ports_csv.3 new file mode 100644 index 0000000000000000000000000000000000000000..77fd3bbae9f5543034cd677874e98698f2741692 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_servers_ports_csv.3 @@ -0,0 +1,4 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.so man3/ares_set_servers_csv.3 diff --git a/miniconda3/share/man/man3/ares_set_socket_callback.3 b/miniconda3/share/man/man3/ares_set_socket_callback.3 new file mode 100644 index 0000000000000000000000000000000000000000..d94b9885357a5e543193d38793714f77ee28438b --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_socket_callback.3 @@ -0,0 +1,34 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_SOCKET_CALLBACK 3 "20 Nov 2009" +.SH NAME +ares_set_socket_callback \- Set a socket creation callback +.SH SYNOPSIS +.nf +#include + +typedef int (*ares_sock_create_callback)(ares_socket_t \fIsocket_fd\fP, + int \fItype\fP, + void *\fIuserdata\fP) + +void ares_set_socket_callback(ares_channel_t *\fIchannel\fP, + ares_sock_create_callback \fIcallback\fP, + void *\fIuserdata\fP) +.PP +.B cc file.c -lcares +.fi +.SH DESCRIPTION +.PP +This function sets a \fIcallback\fP in the given ares channel handle. This +callback function will be invoked after the socket has been created, and +connected to the remote server. The callback must return ARES_SUCCESS if +things are fine, or return -1 to signal an error. A returned error will +abort the ares operation. +.SH SEE ALSO +.BR ares_init_options (3), +.BR ares_set_socket_configure_callback (3) +.SH AVAILABILITY +ares_set_socket_callback(3) was added in c-ares 1.6.0 + diff --git a/miniconda3/share/man/man3/ares_set_socket_configure_callback.3 b/miniconda3/share/man/man3/ares_set_socket_configure_callback.3 new file mode 100644 index 0000000000000000000000000000000000000000..d26e79f43f631a16652118e0b32ed7f71d77371c --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_socket_configure_callback.3 @@ -0,0 +1,34 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.TH ARES_SET_SOCKET_CONFIGURE_CALLBACK 3 "6 Feb 2016" +.SH NAME +ares_set_socket_configure_callback \- Set a socket configuration callback +.SH SYNOPSIS +.nf +#include + +typedef int (*ares_sock_config_callback)(ares_socket_t \fIsocket_fd\fP, + int \fItype\fP, + void *\fIuserdata\fP) + +void ares_set_socket_configure_callback(ares_channel_t *\fIchannel\fP, + ares_sock_config_callback \fIcallback\fP, + void *\fIuserdata\fP) +.fi +.SH DESCRIPTION +.PP +This function sets a \fIcallback\fP in the given ares channel handle. Cannot be +used when \fBARES_OPT_EVENT_THREAD\fP is passed to \fIares_init_options(3)\fP. + +This callback function will be invoked after the socket has been created, but +before it has been connected to the remote server, which is an ideal time +to configure various socket options. The callback must return ARES_SUCCESS +if things are fine, or return -1 to signal an error. A returned error will +abort the ares operation. +.SH SEE ALSO +.BR ares_init_options (3), +.BR ares_set_socket_callback (3) +.SH AVAILABILITY +ares_set_socket_configure_callback(3) was added in c-ares 1.11.0 + diff --git a/miniconda3/share/man/man3/ares_set_socket_functions.3 b/miniconda3/share/man/man3/ares_set_socket_functions.3 new file mode 100644 index 0000000000000000000000000000000000000000..8a903dc6521607699399a0288d05d7a337b48a79 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_socket_functions.3 @@ -0,0 +1,334 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.TH ARES_SET_SOCKET_FUNCTIONS 3 "8 Oct 2024" +.SH NAME +ares_set_socket_functions, ares_set_socket_functions_ex \- Set socket io callbacks +.SH SYNOPSIS +.nf +#include + +typedef enum { + ARES_SOCKFUNC_FLAG_NONBLOCKING = 1 << 0 +} ares_sockfunc_flags_t; + +typedef enum { + ARES_SOCKET_OPT_SENDBUF_SIZE, + ARES_SOCKET_OPT_RECVBUF_SIZE, + ARES_SOCKET_OPT_BIND_DEVICE, + ARES_SOCKET_OPT_TCP_FASTOPEN +} ares_socket_opt_t; + +typedef enum { + ARES_SOCKET_CONN_TCP_FASTOPEN = 1 << 0 +} ares_socket_connect_flags_t; + +typedef enum { + ARES_SOCKET_BIND_TCP = 1 << 0, + ARES_SOCKET_BIND_CLIENT = 1 << 1 +} ares_socket_bind_flags_t; + +struct ares_socket_functions_ex { + unsigned int version; /* ABI Version: must be "1" */ + unsigned int flags; + + ares_socket_t (*asocket)(int domain, int type, int protocol, void *user_data); + int (*aclose)(ares_socket_t sock, void *user_data); + int (*asetsockopt)(ares_socket_t sock, ares_socket_opt_t opt, const void *val, + ares_socklen_t val_size, void *user_data); + int (*aconnect)(ares_socket_t sock, const struct sockaddr *address, + ares_socklen_t address_len, unsigned int flags, + void *user_data); + ares_ssize_t (*arecvfrom)(ares_socket_t sock, void *buffer, size_t length, + int flags, struct sockaddr *address, + ares_socklen_t *address_len, void *user_data); + ares_ssize_t (*asendto)(ares_socket_t sock, const void *buffer, size_t length, + int flags, const struct sockaddr *address, + ares_socklen_t address_len, void *user_data); + int (*agetsockname)(ares_socket_t sock, struct sockaddr *address, + ares_socklen_t *address_len, void *user_data); + int (*abind)(ares_socket_t sock, unsigned int flags, + const struct sockaddr *address, socklen_t address_len, + void *user_data); + unsigned int (*aif_nametoindex)(const char *ifname, void *user_data); + const char *(*aif_indextoname)(unsigned int ifindex, char *ifname_buf, + size_t ifname_buf_len, void *user_data); +}; + +ares_status_t ares_set_socket_functions_ex(ares_channel_t *channel, + const struct ares_socket_functions_ex *funcs, void *user_data); + + +struct ares_socket_functions { + ares_socket_t (*\fIasocket\fP)(int, int, int, void *); + int (*\fIaclose\fP)(ares_socket_t, void *); + int (*\fIaconnect\fP)(ares_socket_t, const struct sockaddr *, ares_socklen_t, void *); + ares_ssize_t (*\fIarecvfrom\fP)(ares_socket_t, void *, size_t, int, + struct sockaddr *, ares_socklen_t *, void *); + ares_ssize_t (*\fIasendv\fP)(ares_socket_t, const struct iovec *, int, void *); +}; + +void ares_set_socket_functions(ares_channel_t *\fIchannel\fP, + const struct ares_socket_functions * \fIfunctions\fP, + void *\fIuser_data\fP); +.fi +.SH DESCRIPTION +.PP + +\fBares_set_socket_functions_ex(3)\fP sets a set of callback \fIfunctions\fP in +the given ares channel handle. Cannot be used when \fBARES_OPT_EVENT_THREAD\fP +is passed to \fIares_init_options(3)\fP. This function replaces the now +deprecated \fBares_set_socket_functions(3)\fP call. + +These callback functions will be invoked to create/destroy socket objects and +perform io, instead of the normal system calls. A client application can +override normal network operation fully through this functionality, and provide +its own transport layer. + +Some callbacks may be optional and are documented as such below, but failing +to implement such callbacks will disable certain features within c-ares. It +is strongly recommended to implement all callbacks. + +All callback functions are expected to operate like their system equivalents, +and to set \fBerrno(2)\fP or \fBWSASetLastError(2)\fP to an appropriate error +code on failure. It is strongly recommended that io callbacks are implemented +to be asynchronous and indicated as such in the \fIflags\fP member. The io +callbacks can return error codes of \fBEAGAIN\fP, \fBEWOULDBLOCK\fP, or +\fBWSAEWOULDBLOCK\fP when they would otherwise block. + +The \fIuser_data\fP value is provided to each callback function invocation to +serve as context. + +The \fBares_set_socket_functions_ex(3)\fP must provide the following structure +members and callbacks (which are different from the +\fBares_set_socket_functions(3)\fP members and callbacks): + +.RS 4 +.TP 8 +.B unsigned int \fIversion\fP +.br +ABI Version of structure. Must be set to a value of "1". + +.TP 8 +.B unsigned int \fIflags\fP +.br +Flags available are specified in \fIares_sockfunc_flags_t\fP. + +.TP 8 +.B ares_socket_t (*\fIasocket\fP)(int \fIdomain\fP, int \fItype\fP, int \fIprotocol\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Creates an endpoint for communication and returns a descriptor. \fIdomain\fP, +\fItype\fP, and \fIprotocol\fP each correspond to the parameters of +\fBsocket(2)\fP. Returns a handle to the newly created socket, or +\fBARES_SOCKET_BAD\fP on error. + +.TP 8 +.B int (*\fIaclose\fP)(ares_socket_t \fIfd\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Closes the socket endpoint indicated by \fIfd\fP. See \fBclose(2)\fP. + +.TP 8 +.B int (*\fIasetsockopt\fP)(ares_socket_t \fIfd\fP, ares_socket_opt_t \fIopt\fP, const void * \fIval\fP, ares_socklen_t \fIval_size\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Set socket option. This shares a similar syntax to the BSD \fIsetsockopt(2)\fP +call, however c-ares uses different options for portability. The value is +a pointer to the desired value, and each option has its own data type listed +in the options below defined in \fIares_socket_opt_t\fP. + +.TP 8 +.B int (*\fIaconnect\fP)(ares_socket_t \fIfd\fP, const struct sockaddr * \fIaddr\fP, ares_socklen_t \fIaddr_len\fP, unsigned int \fIflags\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Initiate a connection to the address indicated by \fIaddr\fP on +a socket. Additional flags controlling behavior are in +\fIares_socket_connect_flags_t\fP. See \fBconnect(2)\fP. + +.TP 8 +.B ares_ssize_t (*\fIarecvfrom\fP)(ares_socket_t \fIfd\fP, void * \fIbuffer\fP, size_t \fIbuf_size\fP, int \fIflags\fP, struct sockaddr * \fIaddr\fP, ares_socklen_t * \fIaddr_len\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Receives data from remote socket endpoint, if available. If the +\fIaddr\fP parameter is not NULL and the connection protocol provides the source +address, the callback should fill this in. The \fIflags\fP parameter is +currently unused. See \fBrecvfrom(2)\fP. + +.TP 8 +.B ares_ssize_t (*\fIasendto\fP)(ares_socket_t \fIfd\fP, const void * \fIbuffer\fP, size_t \fIlength\fP, int \fIflags\fP, const struct sockaddr * \fIaddress\fP, ares_socklen_t \fIaddress_len\fP, void * \fIuser_data\fP) +.br +\fIREQUIRED\fP. Send data, as provided by the \fIbuffer\fP, to the socket +endpoint. The \fIflags\fP member may be used on systems that have +\fBMSG_NOSIGNAL\fP defined but is otherwise unused. An \fIaddress\fP is +provided primarily to support TCP FastOpen scenarios, which will be NULL in +other circumstances. See \fBsendto(2)\fP. + +.TP 8 +.B int (*\fIagetsockname\fP)(ares_socket_t \fIfd\fP, struct sockaddr * \fIaddress\fP, ares_socklen_t * \fIaddress_len\fP, void * \fIuser_data\fP) +.br +\fIOptional\fP. Retrieve the local address of a socket and store it into the provided +\fIaddress\fP buffer. May impact DNS Cookies if not provided. See +\fBgetsockname(2)\fP. + +.TP 8 +.B int (*\fIabind\fP)(ares_socket_t \fIfd\fP, unsigned int \fIflags\fP, const struct sockaddr * \fIaddress\fP, ares_socklen_t \fIaddress_len\fP, void * \fIuser_data\fP) +.br +\fIOptional\fP. Bind the socket to an address. This can be used for client +connections to bind the source address for packets before connect, or +for server connections to bind to an address and port before listening. +Currently c-ares only supports client connections. \fIflags\fP from +\fIares_socket_bind_flags_t\fP can be specified. See \fBbind(2)\fP. + +.TP 8 +.B unsigned int (*\fIaif_nametoindex\fP)(const char * \fIifname\fP, void * \fIuser_data\fP) +.br +\fIOptional\fP. Convert an interface name into the interface index. If this +callback is not specified, then IPv6 Link-Local DNS servers cannot be used. +See \fBif_nametoindex(2)\fP. + +.TP 8 +.B const char * (*\fIaif_indextoname\fP)(unsigned int \fIifindex\fP, char * \fIifname_buf\fP, size_t \fIifname_buf_len\fP, void * \fIuser_data\fP) +.br +\fIOptional\fP. Convert an interface index into the interface name. If this +callback is not specified, then IPv6 Link-Local DNS servers cannot be used. +\fIifname_buf\fP must be at least \fBIF_NAMESIZE\fP or \fBIFNAMSIZ\fP in size. +See \fBif_indextoname(2)\fP. +.RE + +.PP +\fBares_sockfunc_flags_t\fP values: + +.RS 4 +.TP 8 +.B \fIARES_SOCKFUNC_FLAG_NONBLOCKING\fP +.br +Used to indicate the implementation of the io functions are asynchronous. +.RE + +.PP +\fBares_socket_opt_t\fP values: + +.RS 4 +.TP 8 +.B \fIARES_SOCKET_OPT_SENDBUF_SIZE\fP +.br +Set the Send Buffer size. Value is a pointer to an int. (SO_SNDBUF). + +.TP 8 +.B \fIARES_SOCKET_OPT_RECVBUF_SIZE\fP +.br +Set the Receive Buffer size. Value is a pointer to an int. (SO_RCVBUF). + +.TP 8 +.B \fIARES_SOCKET_OPT_BIND_DEVICE\fP +.br +Set the network interface to use as the source for communication. Value is a C +string. (SO_BINDTODEVICE) + +.TP 8 +.B \fIARES_SOCKET_OPT_TCP_FASTOPEN\fP +.br +Enable TCP Fast Open. Value is a pointer to an \fIares_bool_t\fP. On some +systems this could be a no-op if it is known it is on by default and +return success. Other systems may be a no-op if known the system does +not support the feature and returns failure with errno set to \fBENOSYS\fP or +\fBWSASetLastError(WSAEOPNOTSUPP);\fP. +.RE + +.PP +\fBares_socket_connect_flags_t\fP values: +.RS 4 +.TP 8 +.B \fIARES_SOCKET_CONN_TCP_FASTOPEN\fP +.br +Connect using TCP Fast Open. +.RE + +.PP +\fBares_socket_bind_flags_t\fP values: + +.RS 4 +.TP 8 +.B \fIARES_SOCKET_BIND_TCP\fP +.br +Bind is for a TCP connection. + +.TP 19 +.B \fIARES_SOCKET_BIND_CLIENT\fP +.br +Bind is for a client connection, not server. +.RE + +.PP + +\fBares_set_socket_functions(3)\fP sets a set of callback \fIfunctions\fP in the +given ares channel handle. Cannot be used when \fBARES_OPT_EVENT_THREAD\fP is +passed to \fIares_init_options(3)\fP. This function is deprecated as of +c-ares 1.34.0 in favor of \fIares_set_socket_functions_ex(3)\fP. + +\fBares_set_socket_functions(3)\fP allows you to choose to only implement +some of the socket functions, and provide NULL to any others and c-ares will use +its built-in system functions in that case. + +.PP +All callback functions are expected to operate like their system equivalents, +and to set \fBerrno(2)\fP or \fBWSASetLastError(2)\fP to an appropriate error +code on failure. It is strongly recommended all io functions behave +asynchronously and return error codes of \fBEAGAIN\fP, \fBEWOULDBLOCK\fP, or +\fBWSAEWOULDBLOCK\fP when they would otherwise block. + +.PP +The \fIuser_data\fP value is provided to each callback function invocation to +serve as context. +.PP +The \fBares_set_socket_functions(3)\fP must provide the following callbacks (which +are different from the \fBares_set_socket_functions_ex(3)\fP callbacks): + +.RS 4 +.TP 8 +.B ares_socket_t (*\fIasocket\fP)(int \fIdomain\fP, int \fItype\fP, int \fIprotocol\fP, void * \fIuser_data\fP) +.br +Creates an endpoint for communication and returns a descriptor. \fIdomain\fP, \fItype\fP, and \fIprotocol\fP +each correspond to the parameters of \fBsocket(2)\fP. Returns ahandle to the +newly created socket, or ARES_SOCKET_BAD on error. + +.TP 8 +.B int (*\fIaclose\fP)(ares_socket_t \fIfd\fP, void * \fIuser_data\fP) +.br +Closes the socket endpoint indicated by \fIfd\fP. See \fBclose(2)\fP. + +.TP 8 +.B int (*\fIaconnect\fP)(ares_socket_t \fIfd\fP, const struct sockaddr * \fIaddr\fP, ares_socklen_t \fIaddr_len\fP, void * \fIuser_data\fP) +.br +Initiate a connection to the address indicated by \fIaddr\fP on a socket. See +\fBconnect(2)\fP + +.TP 8 +.B ares_ssize_t (*\fIarecvfrom\fP)(ares_socket_t \fIfd\fP, void * \fIbuffer\fP, size_t \fIbuf_size\fP, int \fIflags\fP, struct sockaddr * \fIaddr\fP, ares_socklen_t * \fIaddr_len\fP, void * \fIuser_data\fP) +.br +Receives data from remote socket endpoint, if available. If the \fIaddr\fP +parameter is not NULL and the connection protocol provides the source address, +the callback should fill this in. See \fBrecvfrom(2)\fP + +.TP 8 +.B ares_ssize_t (*\fIasendv\fP)(ares_socket_t \fIfd\fP, const struct iovec * \fIdata\fP, int \fIlen\fP, void * \fIuser_data\fP) +.br +Send data, as provided by the iovec array \fIdata\fP, to the socket endpoint. +See \fBwritev(2)\fP +.RE + +.PP +The \fBares_set_socket_functions(3)\fP struct provided is not copied but directly +referenced, and must thus remain valid through out the channels and any created +socket's lifetime. However, the \fBares_set_socket_functions_ex(3)\fP struct is +duplicated and does not need to survive past the call to the function. + +.SH AVAILABILITY +ares_socket_functions added in c-ares 1.13.0, ares_socket_functions_ex added in +c-ares 1.34.0 +.SH SEE ALSO +.BR ares_init_options (3), +.BR socket (2), +.BR close (2), +.BR connect (2), +.BR recvfrom (2), +.BR sendto (2), +.BR bind (2), +.BR getsockname (2), +.BR setsockopt (2), +.BR writev (2) diff --git a/miniconda3/share/man/man3/ares_set_socket_functions_ex.3 b/miniconda3/share/man/man3/ares_set_socket_functions_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..a0f02456c320cba92e045b74b976bfd340372da6 --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_socket_functions_ex.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2024 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_set_socket_functions.3 diff --git a/miniconda3/share/man/man3/ares_set_sortlist.3 b/miniconda3/share/man/man3/ares_set_sortlist.3 new file mode 100644 index 0000000000000000000000000000000000000000..eb7bf6dc9addf3c866b150a089e8a5dc0b6cbe3f --- /dev/null +++ b/miniconda3/share/man/man3/ares_set_sortlist.3 @@ -0,0 +1,49 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_SET_SORTLIST 3 "23 November 2015" +.SH NAME +ares_set_sortlist \- Initialize an ares_channel_t *sortlist configuration +.SH SYNOPSIS +.nf +#include + +int ares_set_sortlist(ares_channel_t *\fIchannel\fP, const char *\fIsortstr\fP) +.fi +.SH DESCRIPTION +The \fBares_set_sortlist(3)\fP function initializes an address sortlist configuration +for the channel data identified by +.IR channel , +so that addresses returned by \fBares_gethostbyname(3)\fP are sorted according to the +sortlist. The provided +.IR sortstr +string that holds a space separated list of IP-address-netmask pairs. The +netmask is optional but follows the address after a slash if present. For example, +"130.155.160.0/255.255.240.0 130.155.0.0". + +This function replaces any potentially previously configured address sortlist +with the ones given in the configuration string. + +.SH RETURN VALUES +.B ares_set_sortlist(3) +may return any of the following values: +.TP 15 +.B ARES_SUCCESS +The sortlist configuration was successfully initialized. +.TP 15 +.B ARES_ENOMEM +The process's available memory was exhausted. +.TP 15 +.B ARES_ENODATA +The channel data identified by +.IR channel +was invalid. +.TP 15 +.B ARES_ENOTINITIALIZED +c-ares library initialization not yet performed. +.SH SEE ALSO +.BR ares_init_options (3), +.BR ares_dup (3) +.SH AVAILABILITY +ares_set_sortlist(3) was added in c-ares 1.11.0 diff --git a/miniconda3/share/man/man3/ares_strerror.3 b/miniconda3/share/man/man3/ares_strerror.3 new file mode 100644 index 0000000000000000000000000000000000000000..895af5f3e97311671750454823a77cf6df274f60 --- /dev/null +++ b/miniconda3/share/man/man3/ares_strerror.3 @@ -0,0 +1,22 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_STRERROR 3 "25 July 1998" +.SH NAME +ares_strerror \- Get the description of an ares library error code +.SH SYNOPSIS +.nf +#include + +const char *ares_strerror(int \fIcode\fP) +.fi +.SH DESCRIPTION +The +.B ares_strerror +function gets the description of the ares library error code +.IR code , +returning the result as a NUL-terminated C string. +.SH NOTES +This function is not compatible with ares, it takes a different set of +arguments. diff --git a/miniconda3/share/man/man3/ares_svcb_param_t.3 b/miniconda3/share/man/man3/ares_svcb_param_t.3 new file mode 100644 index 0000000000000000000000000000000000000000..4587b9a586ef8e8d7620d0e202aaa1dde520b5ab --- /dev/null +++ b/miniconda3/share/man/man3/ares_svcb_param_t.3 @@ -0,0 +1,4 @@ +.\" +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.so man3/ares_dns_mapping.3 diff --git a/miniconda3/share/man/man3/ares_threadsafety.3 b/miniconda3/share/man/man3/ares_threadsafety.3 new file mode 100644 index 0000000000000000000000000000000000000000..d9c38d801ef483b24c5ac9e86d92b28abebf8725 --- /dev/null +++ b/miniconda3/share/man/man3/ares_threadsafety.3 @@ -0,0 +1,44 @@ +.\" +.\" Copyright 2023 by the c-ares project and its contributors +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_THREADSAFETY 3 "26 November 2023" +.SH NAME +ares_threadsafety \- Query if c-ares was built with thread-safety +.SH SYNOPSIS +.nf +#include + +ares_bool_t ares_threadsafety(void); +.fi +.SH DESCRIPTION +The \fBares_threadsafety(3)\fP function returns if the library was built with +thread safety enabled or not. + +As of c-ares 1.23.0, this simply means that every public function which +references an \fIares_channel_t\fP object will lock the channel on entry and +release the lock on exit of the function. This will prevent concurrent +thread access to the channel, thus ensuring no corruption can occur. + +As of c-ares 1.26.0, this also indicates if \fBARES_OPT_EVENT_THREAD\fP can +be passed to \fIares_init_options(3)\fP. + +.SH RETURN VALUES +\fIares_threadsafety(3)\fP can return any of the following values: +.TP 14 +.B ARES_TRUE +Built with thread safety. +.TP 14 +.B ARES_FALSE +Built without thread safety +.TP 14 + +.SH AVAILABILITY +This function was first introduced in c-ares version 1.23.0. +.SH SEE ALSO +.BR ares_init (3), +.BR ares_init_options (3), +.BR ares_destroy (3), +.BR ares_dup (3), +.BR ares_library_init (3), +.BR ares_set_servers (3) diff --git a/miniconda3/share/man/man3/ares_timeout.3 b/miniconda3/share/man/man3/ares_timeout.3 new file mode 100644 index 0000000000000000000000000000000000000000..bdcd6916802896d7f5c2d3a77fc243fecafcb163 --- /dev/null +++ b/miniconda3/share/man/man3/ares_timeout.3 @@ -0,0 +1,31 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_TIMEOUT 3 "25 July 1998" +.SH NAME +ares_timeout \- return maximum time to wait +.SH SYNOPSIS +.nf +#include + +struct timeval *ares_timeout(const ares_channel_t *\fIchannel\fP, + struct timeval *\fImaxtv\fP, + struct timeval *\fItv\fP) +.fi +.SH DESCRIPTION +The \fBares_timeout(3)\fP function determines the maximum time for which the +caller should wait before invoking \fIares_process(3)\fP to process timeouts. +The parameter \fImaxtv\fP specifies a existing maximum timeout, or \fBNULL\fP +if the caller does not wish to apply a maximum timeout. The parameter +\fItv\fP must point to a writable buffer of type \fBstruct timeval\fP It is +valid for \fImaxtv\fP and \fItv\fP to have the same value. + +If no queries have timeouts pending sooner than the given maximum timeout, +\fBares_timeout(3)\fP returns the value of \fImaxtv\fP; otherwise +\fBares_timeout(3)\fP stores the appropriate timeout value into the buffer +pointed to by \fItv\fP and returns the value of \fItv\fP. +.SH SEE ALSO +.BR ares_fds (3), +.BR ares_process (3), +.BR ares_process_fd (3) diff --git a/miniconda3/share/man/man3/ares_tlsa_match_t.3 b/miniconda3/share/man/man3/ares_tlsa_match_t.3 new file mode 100644 index 0000000000000000000000000000000000000000..b93e4cd4e37fa8f207561d8c076cada994bc5864 --- /dev/null +++ b/miniconda3/share/man/man3/ares_tlsa_match_t.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_dns_rr.3 diff --git a/miniconda3/share/man/man3/ares_tlsa_selector_t.3 b/miniconda3/share/man/man3/ares_tlsa_selector_t.3 new file mode 100644 index 0000000000000000000000000000000000000000..b93e4cd4e37fa8f207561d8c076cada994bc5864 --- /dev/null +++ b/miniconda3/share/man/man3/ares_tlsa_selector_t.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_dns_rr.3 diff --git a/miniconda3/share/man/man3/ares_tlsa_usage_t.3 b/miniconda3/share/man/man3/ares_tlsa_usage_t.3 new file mode 100644 index 0000000000000000000000000000000000000000..b93e4cd4e37fa8f207561d8c076cada994bc5864 --- /dev/null +++ b/miniconda3/share/man/man3/ares_tlsa_usage_t.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) 2023 The c-ares project and its contributors. +.\" SPDX-License-Identifier: MIT +.so man3/ares_dns_rr.3 diff --git a/miniconda3/share/man/man3/ares_version.3 b/miniconda3/share/man/man3/ares_version.3 new file mode 100644 index 0000000000000000000000000000000000000000..c85be42bdbac837eb80920d748eca6a8ec6a4104 --- /dev/null +++ b/miniconda3/share/man/man3/ares_version.3 @@ -0,0 +1,24 @@ +.\" +.\" Copyright 2004 by Daniel Stenberg +.\" SPDX-License-Identifier: MIT +.\" +.TH ARES_VERSION 3 "29 January 2004" +.SH NAME +ares_version \- Get the version number of the library +.SH SYNOPSIS +.nf +#include + +const char *ares_version(int *\fIversion\fP) +.fi +.SH DESCRIPTION +The \fBares_version(3)\fP function gets the library version as a string and +optionally as an integer stored in the \fIversion\fP argument. If you pass a +NULL, no integer is attempted to be returned. + +The integer is built up as 24bit number, with 8 separate bits used for major +number, minor number and patch number. This makes a version string such as +1.2.3 will be returned as the hexadecimal number 0x010203 (decimal 66051). +.SH "SEE ALSO" +.BR ares_init (3), +.BR ares_library_init (3) diff --git a/miniconda3/share/man/man3/bind_textdomain_codeset.3 b/miniconda3/share/man/man3/bind_textdomain_codeset.3 new file mode 100644 index 0000000000000000000000000000000000000000..d3a66c8b5c7e2b8cfb9661c76de7a27486545953 --- /dev/null +++ b/miniconda3/share/man/man3/bind_textdomain_codeset.3 @@ -0,0 +1,72 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH BIND_TEXTDOMAIN_CODESET 3 "November 2024" "GNU gettext 0.25.1" +.SH NAME +bind_textdomain_codeset \- set encoding of message translations +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * bind_textdomain_codeset (const char * " domainname , +.BI " const char * " codeset ); +.fi +.SH DESCRIPTION +The \fBbind_textdomain_codeset\fP function sets the output codeset for message +catalogs for domain \fIdomainname\fP. +.PP +A message domain is a set of translatable \fImsgid\fP messages. Usually, +every software package has its own message domain. +.PP +By default, the \fBgettext\fP family of functions returns translated messages +in the locale's character encoding, which can be retrieved as +\fBnl_langinfo (CODESET)\fP. The need for calling \fBbind_textdomain_codeset\fP +arises for programs which store strings in a locale independent way (e.g.\& +UTF-8) and want to avoid an extra character set conversion on the returned +translated messages. +.PP +\fIdomainname\fP must be a non-empty string. +.PP +If \fIcodeset\fP is not NULL, it must be a valid encoding name which can be +used for the \fBiconv_open\fP function. The \fBbind_textdomain_codeset\fP +function sets the output codeset for message catalogs belonging to domain +\fIdomainname\fP to \fIcodeset\fP. The function makes copies of the argument +strings as needed. +.PP +If \fIcodeset\fP is NULL, the function returns the previously set codeset for +domain \fIdomainname\fP. The default is NULL, denoting the locale's character +encoding. +.SH "RETURN VALUE" +If successful, the \fBbind_textdomain_codeset\fP function returns the current +codeset for domain \fIdomainname\fP, after possibly changing it. The resulting +string is valid until the next \fBbind_textdomain_codeset\fP call for the same +\fIdomainname\fP and must not be modified or freed. If a memory allocation +failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and returns NULL. If no +codeset has been set for domain \fIdomainname\fP, it returns NULL. +.SH ERRORS +The following error can occur, among others: +.TP +.B ENOMEM +Not enough memory available. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.SH "SEE ALSO" +.BR gettext (3), +.BR dgettext (3), +.BR dcgettext (3), +.BR ngettext (3), +.BR dngettext (3), +.BR dcngettext (3), +.BR textdomain (3), +.BR nl_langinfo (3), +.BR iconv_open (3) diff --git a/miniconda3/share/man/man3/bindtextdomain.3 b/miniconda3/share/man/man3/bindtextdomain.3 new file mode 100644 index 0000000000000000000000000000000000000000..4ee7a30d728396ebc6ee4e64ca14d9863370f2bf --- /dev/null +++ b/miniconda3/share/man/man3/bindtextdomain.3 @@ -0,0 +1,69 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH BINDTEXTDOMAIN 3 "May 2001" "GNU gettext 0.25.1" +.SH NAME +bindtextdomain \- set directory containing message catalogs +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * bindtextdomain (const char * " domainname ", const char * " dirname ); +.fi +.SH DESCRIPTION +The \fBbindtextdomain\fP function sets the base directory of the hierarchy +containing message catalogs for a given message domain. +.PP +A message domain is a set of translatable \fImsgid\fP messages. Usually, +every software package has its own message domain. The need for calling +\fBbindtextdomain\fP arises because packages are not always installed with +the same prefix as the header and the libc/libintl libraries. +.PP +Message catalogs will be expected at the pathnames +\fIdirname\fP/\fIlocale\fP/\fIcategory\fP/\fIdomainname\fP.mo, +where \fIlocale\fP is a locale name and \fIcategory\fP is a locale facet such +as \fBLC_MESSAGES\fP. +.PP +\fIdomainname\fP must be a non-empty string. +.PP +If \fIdirname\fP is not NULL, the base directory for message catalogs belonging +to domain \fIdomainname\fP is set to \fIdirname\fP. The function makes copies +of the argument strings as needed. If the program wishes to call the +\fBchdir\fP function, it is important that \fIdirname\fP be an absolute +pathname; otherwise it cannot be guaranteed that the message catalogs will +be found. +.PP +If \fIdirname\fP is NULL, the function returns the previously set base +directory for domain \fIdomainname\fP. +.SH "RETURN VALUE" +If successful, the \fBbindtextdomain\fP function returns the current base +directory for domain \fIdomainname\fP, after possibly changing it. The +resulting string is valid until the next \fBbindtextdomain\fP call for the +same \fIdomainname\fP and must not be modified or freed. If a memory allocation +failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and returns NULL. +.SH ERRORS +The following error can occur, among others: +.TP +.B ENOMEM +Not enough memory available. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.SH "SEE ALSO" +.BR gettext (3), +.BR dgettext (3), +.BR dcgettext (3), +.BR ngettext (3), +.BR dngettext (3), +.BR dcngettext (3), +.BR textdomain (3), +.BR realpath (3) diff --git a/miniconda3/share/man/man3/constants.h.3 b/miniconda3/share/man/man3/constants.h.3 new file mode 100644 index 0000000000000000000000000000000000000000..1b29f28c9891d84b3a2c4c232e9bba7bf8764e51 --- /dev/null +++ b/miniconda3/share/man/man3/constants.h.3 @@ -0,0 +1,47 @@ +.TH "constants.h" 3 "August 2021" "Brotli" \" -*- nroff -*- +.ad l +.nh +.SH NAME +constants.h \- Common constants used in decoder and encoder API\&. + +.SH SYNOPSIS +.br +.PP +.SS "Macros" + +.in +1c +.ti -1c +.RI "#define \fBBROTLI_LARGE_MAX_DISTANCE_BITS\fP 62U" +.br +.RI "\fIThe theoretical maximum number of distance bits specified for large window brotli, for 64-bit encoders and decoders\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_LARGE_MAX_WBITS\fP 30" +.br +.RI "\fIThe maximum supported large brotli window bits by the encoder and decoder\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MAX_NPOSTFIX\fP 3" +.br +.RI "\fIMaximal number of 'postfix' bits\&. \fP" +.in -1c +.SH "Detailed Description" +.PP +Common constants used in decoder and encoder API\&. + + +.SH "Macro Definition Documentation" +.PP +.SS "#define BROTLI_LARGE_MAX_DISTANCE_BITS 62U" + +.PP +The theoretical maximum number of distance bits specified for large window brotli, for 64-bit encoders and decoders\&. Even when in practice 32-bit encoders and decoders only support up to 30 max distance bits, the value is set to 62 because it affects the large window brotli file format\&. Specifically, it affects the encoding of simple huffman tree for distances, see Specification RFC 7932 chapter 3\&.4\&. +.SS "#define BROTLI_LARGE_MAX_WBITS 30" + +.PP +The maximum supported large brotli window bits by the encoder and decoder\&. Large window brotli allows up to 62 bits, however the current encoder and decoder, designed for 32-bit integers, only support up to 30 bits maximum\&. +.SS "#define BROTLI_MAX_NPOSTFIX 3" + +.PP +Maximal number of 'postfix' bits\&. Number of 'postfix' bits is stored as 2 bits in meta-block header\&. +.SH "Author" +.PP +Generated automatically by Doxygen for Brotli from the source code\&. diff --git a/miniconda3/share/man/man3/dcgettext.3 b/miniconda3/share/man/man3/dcgettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..9082c86be87d8177066087cdd5d3ed3d97edbd6e --- /dev/null +++ b/miniconda3/share/man/man3/dcgettext.3 @@ -0,0 +1 @@ +.so man3/gettext.3 diff --git a/miniconda3/share/man/man3/dcngettext.3 b/miniconda3/share/man/man3/dcngettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..5fcf629c8168b6a7203567083dd1b920ce8ca003 --- /dev/null +++ b/miniconda3/share/man/man3/dcngettext.3 @@ -0,0 +1 @@ +.so man3/ngettext.3 diff --git a/miniconda3/share/man/man3/decode.h.3 b/miniconda3/share/man/man3/decode.h.3 new file mode 100644 index 0000000000000000000000000000000000000000..30929e9721a28f97cc358fd905d36f0afaf276b6 --- /dev/null +++ b/miniconda3/share/man/man3/decode.h.3 @@ -0,0 +1,505 @@ +.TH "decode.h" 3 "August 2021" "Brotli" \" -*- nroff -*- +.ad l +.nh +.SH NAME +decode.h \- API for Brotli decompression\&. + +.SH SYNOPSIS +.br +.PP +.SS "Macros" + +.in +1c +.ti -1c +.RI "#define \fBBROTLI_DECODER_ERROR_CODES_LIST\fP(BROTLI_ERROR_CODE, SEPARATOR) " +.br +.RI "\fITemplate that evaluates items of \fBBrotliDecoderErrorCode\fP\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_LAST_ERROR_CODE\fP BROTLI_DECODER_ERROR_UNREACHABLE" +.br +.RI "\fIThe value of the last error code, negative integer\&. \fP" +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void(* \fBbrotli_decoder_metadata_chunk_func\fP) (void *opaque, const uint8_t *data, size_t size)" +.br +.RI "\fICallback to fire on metadata block chunk becomes available\&. \fP" +.ti -1c +.RI "typedef void(* \fBbrotli_decoder_metadata_start_func\fP) (void *opaque, size_t size)" +.br +.RI "\fICallback to fire on metadata block start\&. \fP" +.ti -1c +.RI "typedef enum \fBBrotliDecoderParameter\fP \fBBrotliDecoderParameter\fP" +.br +.RI "\fIOptions to be used with \fBBrotliDecoderSetParameter\fP\&. \fP" +.ti -1c +.RI "typedef struct BrotliDecoderStateStruct \fBBrotliDecoderState\fP" +.br +.RI "\fIOpaque structure that holds decoder state\&. \fP" +.in -1c +.SS "Enumerations" +.SS "Functions" + +.in +1c +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderAttachDictionary\fP (\fBBrotliDecoderState\fP *state, BrotliSharedDictionaryType type, size_t data_size, const uint8_t data[data_size])" +.br +.RI "\fIAdds LZ77 prefix dictionary, adds or replaces built-in static dictionary and transforms\&. \fP" +.ti -1c +.RI "\fBBrotliDecoderState\fP * \fBBrotliDecoderCreateInstance\fP (\fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void *opaque)" +.br +.RI "\fICreates an instance of \fBBrotliDecoderState\fP and initializes it\&. \fP" +.ti -1c +.RI "\fBBrotliDecoderResult\fP \fBBrotliDecoderDecompress\fP (size_t encoded_size, const uint8_t encoded_buffer[encoded_size], size_t *decoded_size, uint8_t decoded_buffer[*decoded_size])" +.br +.RI "\fIPerforms one-shot memory-to-memory decompression\&. \fP" +.ti -1c +.RI "\fBBrotliDecoderResult\fP \fBBrotliDecoderDecompressStream\fP (\fBBrotliDecoderState\fP *state, size_t *available_in, const uint8_t **next_in, size_t *available_out, uint8_t **next_out, size_t *total_out)" +.br +.RI "\fIDecompresses the input stream to the output stream\&. \fP" +.ti -1c +.RI "void \fBBrotliDecoderDestroyInstance\fP (\fBBrotliDecoderState\fP *state)" +.br +.RI "\fIDeinitializes and frees \fBBrotliDecoderState\fP instance\&. \fP" +.ti -1c +.RI "const char * \fBBrotliDecoderErrorString\fP (\fBBrotliDecoderErrorCode\fP c)" +.br +.RI "\fIConverts error code to a c-string\&. \fP" +.ti -1c +.RI "\fBBrotliDecoderErrorCode\fP \fBBrotliDecoderGetErrorCode\fP (const \fBBrotliDecoderState\fP *state)" +.br +.RI "\fIAcquires a detailed error code\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderHasMoreOutput\fP (const \fBBrotliDecoderState\fP *state)" +.br +.RI "\fIChecks if decoder has more output\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderIsFinished\fP (const \fBBrotliDecoderState\fP *state)" +.br +.RI "\fIChecks if decoder instance reached the final state\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderIsUsed\fP (const \fBBrotliDecoderState\fP *state)" +.br +.RI "\fIChecks if instance has already consumed input\&. \fP" +.ti -1c +.RI "void \fBBrotliDecoderSetMetadataCallbacks\fP (\fBBrotliDecoderState\fP *state, \fBbrotli_decoder_metadata_start_func\fP start_func, \fBbrotli_decoder_metadata_chunk_func\fP chunk_func, void *opaque)" +.br +.RI "\fISets callback for receiving metadata blocks\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderSetParameter\fP (\fBBrotliDecoderState\fP *state, \fBBrotliDecoderParameter\fP param, uint32_t value)" +.br +.RI "\fISets the specified parameter to the given decoder instance\&. \fP" +.ti -1c +.RI "const uint8_t * \fBBrotliDecoderTakeOutput\fP (\fBBrotliDecoderState\fP *state, size_t *size)" +.br +.RI "\fIAcquires pointer to internal output buffer\&. \fP" +.ti -1c +.RI "uint32_t \fBBrotliDecoderVersion\fP (void)" +.br +.RI "\fIGets a decoder library version\&. \fP" +.in -1c +.SH "Detailed Description" +.PP +API for Brotli decompression\&. + + +.SH "Macro Definition Documentation" +.PP +.SS "#define BROTLI_DECODER_ERROR_CODES_LIST(BROTLI_ERROR_CODE, SEPARATOR)" + +.PP +Template that evaluates items of \fBBrotliDecoderErrorCode\fP\&. Example: +.PP +.nf +// Log Brotli error code\&. +switch (brotliDecoderErrorCode) { +#define CASE_(PREFIX, NAME, CODE) \ + case BROTLI_DECODER ## PREFIX ## NAME: \ + LOG(INFO) << "error code:" << #NAME; \ + break; +#define NEWLINE_ +BROTLI_DECODER_ERROR_CODES_LIST(CASE_, NEWLINE_) +#undef CASE_ +#undef NEWLINE_ + default: LOG(FATAL) << "unknown brotli error code"; +} + +.fi +.PP + +.SS "#define BROTLI_LAST_ERROR_CODE BROTLI_DECODER_ERROR_UNREACHABLE" + +.PP +The value of the last error code, negative integer\&. All other error code values are in the range from \fBBROTLI_LAST_ERROR_CODE\fP to \fC-1\fP\&. There are also 4 other possible non-error codes \fC0\fP \&.\&. \fC3\fP in \fBBrotliDecoderErrorCode\fP enumeration\&. +.SH "Typedef Documentation" +.PP +.SS "typedef void(* brotli_decoder_metadata_chunk_func) (void *opaque, const uint8_t *data, size_t size)" + +.PP +Callback to fire on metadata block chunk becomes available\&. This function can be invoked multiple times per metadata block; block should be considered finished when sum of \fCsize\fP matches the announced metadata block size\&. Chunks contents pointed by \fCdata\fP are transient and shouln not be accessed after leaving the callback\&. +.PP +\fBParameters:\fP +.RS 4 +\fIopaque\fP callback handle +.br +\fIdata\fP pointer to metadata contents +.br +\fIsize\fP size of metadata block chunk, at least \fC1\fP +.RE +.PP + +.SS "typedef void(* brotli_decoder_metadata_start_func) (void *opaque, size_t size)" + +.PP +Callback to fire on metadata block start\&. After this callback is fired, if \fCsize\fP is not \fC0\fP, it is followed by \fBbrotli_decoder_metadata_chunk_func\fP as more metadata block contents become accessible\&. +.PP +\fBParameters:\fP +.RS 4 +\fIopaque\fP callback handle +.br +\fIsize\fP size of metadata block +.RE +.PP + +.SS "typedef enum \fBBrotliDecoderParameter\fP \fBBrotliDecoderParameter\fP" + +.PP +Options to be used with \fBBrotliDecoderSetParameter\fP\&. +.SS "typedef struct BrotliDecoderStateStruct \fBBrotliDecoderState\fP" + +.PP +Opaque structure that holds decoder state\&. Allocated and initialized with \fBBrotliDecoderCreateInstance\fP\&. Cleaned up and deallocated with \fBBrotliDecoderDestroyInstance\fP\&. +.SH "Enumeration Type Documentation" +.PP +.SS "enum \fBBrotliDecoderErrorCode\fP" + +.PP +Error code for detailed logging / production debugging\&. See \fBBrotliDecoderGetErrorCode\fP and \fBBROTLI_LAST_ERROR_CODE\fP\&. +.SS "enum \fBBrotliDecoderParameter\fP" + +.PP +Options to be used with \fBBrotliDecoderSetParameter\fP\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIBROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION \fP\fP +Disable 'canny' ring buffer allocation strategy\&. Ring buffer is allocated according to window size, despite the real size of the content\&. +.TP +\fB\fIBROTLI_DECODER_PARAM_LARGE_WINDOW \fP\fP +Flag that determines if 'Large Window Brotli' is used\&. +.SS "enum \fBBrotliDecoderResult\fP" + +.PP +Result type for \fBBrotliDecoderDecompress\fP and \fBBrotliDecoderDecompressStream\fP functions\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIBROTLI_DECODER_RESULT_ERROR \fP\fP +Decoding error, e\&.g\&. corrupted input or memory allocation problem\&. +.TP +\fB\fIBROTLI_DECODER_RESULT_SUCCESS \fP\fP +Decoding successfully completed\&. +.TP +\fB\fIBROTLI_DECODER_RESULT_NEEDS_MORE_INPUT \fP\fP +Partially done; should be called again with more input\&. +.TP +\fB\fIBROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT \fP\fP +Partially done; should be called again with more output\&. +.SH "Function Documentation" +.PP +.SS "\fBBROTLI_BOOL\fP BrotliDecoderAttachDictionary (\fBBrotliDecoderState\fP * state, BrotliSharedDictionaryType type, size_t data_size, const uint8_t data[data_size])" + +.PP +Adds LZ77 prefix dictionary, adds or replaces built-in static dictionary and transforms\&. Attached dictionary ownership is not transferred\&. Data provided to this method should be kept accessible until decoding is finished and decoder instance is destroyed\&. +.PP +\fBNote:\fP +.RS 4 +Dictionaries can NOT be attached after actual decoding is started\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.br +\fItype\fP dictionary data format +.br +\fIdata_size\fP length of memory region pointed by \fCdata\fP +.br +\fIdata\fP dictionary data in format corresponding to \fCtype\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP if dictionary is corrupted, or dictionary count limit is reached +.PP +\fBBROTLI_TRUE\fP if dictionary is accepted / attached +.RE +.PP + +.SS "\fBBrotliDecoderState\fP* BrotliDecoderCreateInstance (\fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void * opaque)" + +.PP +Creates an instance of \fBBrotliDecoderState\fP and initializes it\&. The instance can be used once for decoding and should then be destroyed with \fBBrotliDecoderDestroyInstance\fP, it cannot be reused for a new decoding session\&. +.PP +\fCalloc_func\fP and \fCfree_func\fP \fBMUST\fP be both zero or both non-zero\&. In the case they are both zero, default memory allocators are used\&. \fCopaque\fP is passed to \fCalloc_func\fP and \fCfree_func\fP when they are called\&. \fCfree_func\fP has to return without doing anything when asked to free a NULL pointer\&. +.PP +\fBParameters:\fP +.RS 4 +\fIalloc_func\fP custom memory allocation function +.br +\fIfree_func\fP custom memory free function +.br +\fIopaque\fP custom memory manager handle +.RE +.PP +\fBReturns:\fP +.RS 4 +\fC0\fP if instance can not be allocated or initialized +.PP +pointer to initialized \fBBrotliDecoderState\fP otherwise +.RE +.PP + +.SS "\fBBrotliDecoderResult\fP BrotliDecoderDecompress (size_t encoded_size, const uint8_t encoded_buffer[encoded_size], size_t * decoded_size, uint8_t decoded_buffer[*decoded_size])" + +.PP +Performs one-shot memory-to-memory decompression\&. Decompresses the data in \fCencoded_buffer\fP into \fCdecoded_buffer\fP, and sets \fC*decoded_size\fP to the decompressed length\&. +.PP +\fBParameters:\fP +.RS 4 +\fIencoded_size\fP size of \fCencoded_buffer\fP +.br +\fIencoded_buffer\fP compressed data buffer with at least \fCencoded_size\fP addressable bytes +.br +\fIdecoded_size\fP \fBin:\fP size of \fCdecoded_buffer\fP; +.br + \fBout:\fP length of decompressed data written to \fCdecoded_buffer\fP +.br +\fIdecoded_buffer\fP decompressed data destination buffer +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_DECODER_RESULT_ERROR\fP if input is corrupted, memory allocation failed, or \fCdecoded_buffer\fP is not large enough; +.PP +\fBBROTLI_DECODER_RESULT_SUCCESS\fP otherwise +.RE +.PP + +.SS "\fBBrotliDecoderResult\fP BrotliDecoderDecompressStream (\fBBrotliDecoderState\fP * state, size_t * available_in, const uint8_t ** next_in, size_t * available_out, uint8_t ** next_out, size_t * total_out)" + +.PP +Decompresses the input stream to the output stream\&. The values \fC*available_in\fP and \fC*available_out\fP must specify the number of bytes addressable at \fC*next_in\fP and \fC*next_out\fP respectively\&. When \fC*available_out\fP is \fC0\fP, \fCnext_out\fP is allowed to be \fCNULL\fP\&. +.PP +After each call, \fC*available_in\fP will be decremented by the amount of input bytes consumed, and the \fC*next_in\fP pointer will be incremented by that amount\&. Similarly, \fC*available_out\fP will be decremented by the amount of output bytes written, and the \fC*next_out\fP pointer will be incremented by that amount\&. +.PP +\fCtotal_out\fP, if it is not a null-pointer, will be set to the number of bytes decompressed since the last \fCstate\fP initialization\&. +.PP +\fBNote:\fP +.RS 4 +Input is never overconsumed, so \fCnext_in\fP and \fCavailable_in\fP could be passed to the next consumer after decoding is complete\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.br +\fIavailable_in\fP \fBin:\fP amount of available input; +.br + \fBout:\fP amount of unused input +.br +\fInext_in\fP pointer to the next compressed byte +.br +\fIavailable_out\fP \fBin:\fP length of output buffer; +.br + \fBout:\fP remaining size of output buffer +.br +\fInext_out\fP output buffer cursor; can be \fCNULL\fP if \fCavailable_out\fP is \fC0\fP +.br +\fItotal_out\fP number of bytes decompressed so far; can be \fCNULL\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_DECODER_RESULT_ERROR\fP if input is corrupted, memory allocation failed, arguments were invalid, etc\&.; use \fBBrotliDecoderGetErrorCode\fP to get detailed error code +.PP +\fBBROTLI_DECODER_RESULT_NEEDS_MORE_INPUT\fP decoding is blocked until more input data is provided +.PP +\fBBROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT\fP decoding is blocked until more output space is provided +.PP +\fBBROTLI_DECODER_RESULT_SUCCESS\fP decoding is finished, no more input might be consumed and no more output will be produced +.RE +.PP + +.SS "void BrotliDecoderDestroyInstance (\fBBrotliDecoderState\fP * state)" + +.PP +Deinitializes and frees \fBBrotliDecoderState\fP instance\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance to be cleaned up and deallocated +.RE +.PP + +.SS "\fBBrotliDecoderErrorCode\fP BrotliDecoderGetErrorCode (const \fBBrotliDecoderState\fP * state)" + +.PP +Acquires a detailed error code\&. Should be used only after \fBBrotliDecoderDecompressStream\fP returns \fBBROTLI_DECODER_RESULT_ERROR\fP\&. +.PP +See also \fBBrotliDecoderErrorString\fP +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +last saved error code +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliDecoderHasMoreOutput (const \fBBrotliDecoderState\fP * state)" + +.PP +Checks if decoder has more output\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_TRUE\fP, if decoder has some unconsumed output +.PP +\fBBROTLI_FALSE\fP otherwise +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliDecoderIsFinished (const \fBBrotliDecoderState\fP * state)" + +.PP +Checks if decoder instance reached the final state\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_TRUE\fP if decoder is in a state where it reached the end of the input and produced all of the output +.PP +\fBBROTLI_FALSE\fP otherwise +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliDecoderIsUsed (const \fBBrotliDecoderState\fP * state)" + +.PP +Checks if instance has already consumed input\&. Instance that returns \fBBROTLI_FALSE\fP is considered 'fresh' and could be reused\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_TRUE\fP if decoder has already used some input bytes +.PP +\fBBROTLI_FALSE\fP otherwise +.RE +.PP + +.SS "void BrotliDecoderSetMetadataCallbacks (\fBBrotliDecoderState\fP * state, \fBbrotli_decoder_metadata_start_func\fP start_func, \fBbrotli_decoder_metadata_chunk_func\fP chunk_func, void * opaque)" + +.PP +Sets callback for receiving metadata blocks\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.br +\fIstart_func\fP callback on metadata block start +.br +\fIchunk_func\fP callback on metadata block chunk +.br +\fIopaque\fP callback handle +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliDecoderSetParameter (\fBBrotliDecoderState\fP * state, \fBBrotliDecoderParameter\fP param, uint32_t value)" + +.PP +Sets the specified parameter to the given decoder instance\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.br +\fIparam\fP parameter to set +.br +\fIvalue\fP new parameter value +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP if parameter is unrecognized, or value is invalid +.PP +\fBBROTLI_TRUE\fP if value is accepted +.RE +.PP + +.SS "const uint8_t* BrotliDecoderTakeOutput (\fBBrotliDecoderState\fP * state, size_t * size)" + +.PP +Acquires pointer to internal output buffer\&. This method is used to make language bindings easier and more efficient: +.IP "1." 4 +push data to \fBBrotliDecoderDecompressStream\fP, until \fBBROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT\fP is reported +.IP "2." 4 +use \fBBrotliDecoderTakeOutput\fP to peek bytes and copy to language-specific entity +.PP +.PP +Also this could be useful if there is an output stream that is able to consume all the provided data (e\&.g\&. when data is saved to file system)\&. +.PP +\fBAttention:\fP +.RS 4 +After every call to \fBBrotliDecoderTakeOutput\fP \fC*size\fP bytes of output are considered consumed for all consecutive calls to the instance methods; returned pointer becomes invalidated as well\&. +.RE +.PP +\fBNote:\fP +.RS 4 +Decoder output is not guaranteed to be contiguous\&. This means that after the size-unrestricted call to \fBBrotliDecoderTakeOutput\fP, immediate next call to \fBBrotliDecoderTakeOutput\fP may return more data\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance +.br +\fIsize\fP \fBin:\fP number of bytes caller is ready to take, \fC0\fP if any amount could be handled; +.br + \fBout:\fP amount of data pointed by returned pointer and considered consumed; +.br + out value is never greater than in value, unless it is \fC0\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +pointer to output data +.RE +.PP + +.SS "uint32_t BrotliDecoderVersion (void)" + +.PP +Gets a decoder library version\&. Look at BROTLI_MAKE_HEX_VERSION for more information\&. +.SH "Author" +.PP +Generated automatically by Doxygen for Brotli from the source code\&. diff --git a/miniconda3/share/man/man3/dgettext.3 b/miniconda3/share/man/man3/dgettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..9082c86be87d8177066087cdd5d3ed3d97edbd6e --- /dev/null +++ b/miniconda3/share/man/man3/dgettext.3 @@ -0,0 +1 @@ +.so man3/gettext.3 diff --git a/miniconda3/share/man/man3/dngettext.3 b/miniconda3/share/man/man3/dngettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..5fcf629c8168b6a7203567083dd1b920ce8ca003 --- /dev/null +++ b/miniconda3/share/man/man3/dngettext.3 @@ -0,0 +1 @@ +.so man3/ngettext.3 diff --git a/miniconda3/share/man/man3/encode.h.3 b/miniconda3/share/man/man3/encode.h.3 new file mode 100644 index 0000000000000000000000000000000000000000..49173aa663ac83d8e2a61ed30e311a3d092751a4 --- /dev/null +++ b/miniconda3/share/man/man3/encode.h.3 @@ -0,0 +1,635 @@ +.TH "encode.h" 3 "August 2021" "Brotli" \" -*- nroff -*- +.ad l +.nh +.SH NAME +encode.h \- API for Brotli compression\&. + +.SH SYNOPSIS +.br +.PP +.SS "Macros" + +.in +1c +.ti -1c +.RI "#define \fBBROTLI_DEFAULT_MODE\fP \fBBROTLI_MODE_GENERIC\fP" +.br +.RI "\fIDefault value for \fBBROTLI_PARAM_MODE\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_DEFAULT_QUALITY\fP 11" +.br +.RI "\fIDefault value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_DEFAULT_WINDOW\fP 22" +.br +.RI "\fIDefault value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_LARGE_MAX_WINDOW_BITS\fP 30" +.br +.RI "\fIMaximal value for \fBBROTLI_PARAM_LGWIN\fP parameter in 'Large Window Brotli' (32-bit)\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MAX_INPUT_BLOCK_BITS\fP 24" +.br +.RI "\fIMaximal value for \fBBROTLI_PARAM_LGBLOCK\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MAX_QUALITY\fP 11" +.br +.RI "\fIMaximal value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MAX_WINDOW_BITS\fP 24" +.br +.RI "\fIMaximal value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MIN_INPUT_BLOCK_BITS\fP 16" +.br +.RI "\fIMinimal value for \fBBROTLI_PARAM_LGBLOCK\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MIN_QUALITY\fP 0" +.br +.RI "\fIMinimal value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_MIN_WINDOW_BITS\fP 10" +.br +.RI "\fIMinimal value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. \fP" +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef enum \fBBrotliEncoderMode\fP \fBBrotliEncoderMode\fP" +.br +.RI "\fIOptions for \fBBROTLI_PARAM_MODE\fP parameter\&. \fP" +.ti -1c +.RI "typedef enum \fBBrotliEncoderOperation\fP \fBBrotliEncoderOperation\fP" +.br +.RI "\fIOperations that can be performed by streaming encoder\&. \fP" +.ti -1c +.RI "typedef enum \fBBrotliEncoderParameter\fP \fBBrotliEncoderParameter\fP" +.br +.RI "\fIOptions to be used with \fBBrotliEncoderSetParameter\fP\&. \fP" +.ti -1c +.RI "typedef struct BrotliEncoderStateStruct \fBBrotliEncoderState\fP" +.br +.RI "\fIOpaque structure that holds encoder state\&. \fP" +.in -1c +.SS "Enumerations" +.SS "Functions" + +.in +1c +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderAttachPreparedDictionary\fP (\fBBrotliEncoderState\fP *state, const BrotliEncoderPreparedDictionary *dictionary)" +.br +.RI "\fIAttaches a prepared dictionary of any type to the encoder\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderCompress\fP (int quality, int lgwin, \fBBrotliEncoderMode\fP mode, size_t input_size, const uint8_t input_buffer[input_size], size_t *encoded_size, uint8_t encoded_buffer[*encoded_size])" +.br +.RI "\fIPerforms one-shot memory-to-memory compression\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderCompressStream\fP (\fBBrotliEncoderState\fP *state, \fBBrotliEncoderOperation\fP op, size_t *available_in, const uint8_t **next_in, size_t *available_out, uint8_t **next_out, size_t *total_out)" +.br +.RI "\fICompresses input stream to output stream\&. \fP" +.ti -1c +.RI "\fBBrotliEncoderState\fP * \fBBrotliEncoderCreateInstance\fP (\fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void *opaque)" +.br +.RI "\fICreates an instance of \fBBrotliEncoderState\fP and initializes it\&. \fP" +.ti -1c +.RI "void \fBBrotliEncoderDestroyInstance\fP (\fBBrotliEncoderState\fP *state)" +.br +.RI "\fIDeinitializes and frees \fBBrotliEncoderState\fP instance\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderHasMoreOutput\fP (\fBBrotliEncoderState\fP *state)" +.br +.RI "\fIChecks if encoder has more output\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderIsFinished\fP (\fBBrotliEncoderState\fP *state)" +.br +.RI "\fIChecks if encoder instance reached the final state\&. \fP" +.ti -1c +.RI "size_t \fBBrotliEncoderMaxCompressedSize\fP (size_t input_size)" +.br +.RI "\fICalculates the output size bound for the given \fCinput_size\fP\&. \fP" +.ti -1c +.RI "BrotliEncoderPreparedDictionary * \fBBrotliEncoderPrepareDictionary\fP (BrotliSharedDictionaryType type, size_t data_size, const uint8_t data[data_size], int quality, \fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void *opaque)" +.br +.RI "\fIPrepares a shared dictionary from the given file format for the encoder\&. \fP" +.ti -1c +.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderSetParameter\fP (\fBBrotliEncoderState\fP *state, \fBBrotliEncoderParameter\fP param, uint32_t value)" +.br +.RI "\fISets the specified parameter to the given encoder instance\&. \fP" +.ti -1c +.RI "const uint8_t * \fBBrotliEncoderTakeOutput\fP (\fBBrotliEncoderState\fP *state, size_t *size)" +.br +.RI "\fIAcquires pointer to internal output buffer\&. \fP" +.ti -1c +.RI "uint32_t \fBBrotliEncoderVersion\fP (void)" +.br +.RI "\fIGets an encoder library version\&. \fP" +.in -1c +.SH "Detailed Description" +.PP +API for Brotli compression\&. + + +.SH "Macro Definition Documentation" +.PP +.SS "#define BROTLI_DEFAULT_MODE \fBBROTLI_MODE_GENERIC\fP" + +.PP +Default value for \fBBROTLI_PARAM_MODE\fP parameter\&. +.SS "#define BROTLI_DEFAULT_QUALITY 11" + +.PP +Default value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. +.SS "#define BROTLI_DEFAULT_WINDOW 22" + +.PP +Default value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. +.SS "#define BROTLI_MAX_INPUT_BLOCK_BITS 24" + +.PP +Maximal value for \fBBROTLI_PARAM_LGBLOCK\fP parameter\&. +.SS "#define BROTLI_MAX_QUALITY 11" + +.PP +Maximal value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. +.SS "#define BROTLI_MAX_WINDOW_BITS 24" + +.PP +Maximal value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. +.PP +\fBNote:\fP +.RS 4 +equal to \fCBROTLI_MAX_DISTANCE_BITS\fP constant\&. +.RE +.PP + +.SS "#define BROTLI_MIN_INPUT_BLOCK_BITS 16" + +.PP +Minimal value for \fBBROTLI_PARAM_LGBLOCK\fP parameter\&. +.SS "#define BROTLI_MIN_QUALITY 0" + +.PP +Minimal value for \fBBROTLI_PARAM_QUALITY\fP parameter\&. +.SS "#define BROTLI_MIN_WINDOW_BITS 10" + +.PP +Minimal value for \fBBROTLI_PARAM_LGWIN\fP parameter\&. +.SH "Typedef Documentation" +.PP +.SS "typedef enum \fBBrotliEncoderMode\fP \fBBrotliEncoderMode\fP" + +.PP +Options for \fBBROTLI_PARAM_MODE\fP parameter\&. +.SS "typedef enum \fBBrotliEncoderOperation\fP \fBBrotliEncoderOperation\fP" + +.PP +Operations that can be performed by streaming encoder\&. +.SS "typedef enum \fBBrotliEncoderParameter\fP \fBBrotliEncoderParameter\fP" + +.PP +Options to be used with \fBBrotliEncoderSetParameter\fP\&. +.SS "typedef struct BrotliEncoderStateStruct \fBBrotliEncoderState\fP" + +.PP +Opaque structure that holds encoder state\&. Allocated and initialized with \fBBrotliEncoderCreateInstance\fP\&. Cleaned up and deallocated with \fBBrotliEncoderDestroyInstance\fP\&. +.SH "Enumeration Type Documentation" +.PP +.SS "enum \fBBrotliEncoderMode\fP" + +.PP +Options for \fBBROTLI_PARAM_MODE\fP parameter\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIBROTLI_MODE_GENERIC \fP\fP +Default compression mode\&. In this mode compressor does not know anything in advance about the properties of the input\&. +.TP +\fB\fIBROTLI_MODE_TEXT \fP\fP +Compression mode for UTF-8 formatted text input\&. +.TP +\fB\fIBROTLI_MODE_FONT \fP\fP +Compression mode used in WOFF 2\&.0\&. +.SS "enum \fBBrotliEncoderOperation\fP" + +.PP +Operations that can be performed by streaming encoder\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIBROTLI_OPERATION_PROCESS \fP\fP +Process input\&. Encoder may postpone producing output, until it has processed enough input\&. +.TP +\fB\fIBROTLI_OPERATION_FLUSH \fP\fP +Produce output for all processed input\&. Actual flush is performed when input stream is depleted and there is enough space in output stream\&. This means that client should repeat \fBBROTLI_OPERATION_FLUSH\fP operation until \fCavailable_in\fP becomes \fC0\fP, and \fBBrotliEncoderHasMoreOutput\fP returns \fBBROTLI_FALSE\fP\&. If output is acquired via \fBBrotliEncoderTakeOutput\fP, then operation should be repeated after output buffer is drained\&. +.PP +\fBWarning:\fP +.RS 4 +Until flush is complete, client \fBSHOULD\fP \fBNOT\fP swap, reduce or extend input stream\&. +.RE +.PP +When flush is complete, output data will be sufficient for decoder to reproduce all the given input\&. +.TP +\fB\fIBROTLI_OPERATION_FINISH \fP\fP +Finalize the stream\&. Actual finalization is performed when input stream is depleted and there is enough space in output stream\&. This means that client should repeat \fBBROTLI_OPERATION_FINISH\fP operation until \fCavailable_in\fP becomes \fC0\fP, and \fBBrotliEncoderHasMoreOutput\fP returns \fBBROTLI_FALSE\fP\&. If output is acquired via \fBBrotliEncoderTakeOutput\fP, then operation should be repeated after output buffer is drained\&. +.PP +\fBWarning:\fP +.RS 4 +Until finalization is complete, client \fBSHOULD\fP \fBNOT\fP swap, reduce or extend input stream\&. +.RE +.PP +Helper function \fBBrotliEncoderIsFinished\fP checks if stream is finalized and output fully dumped\&. +.PP +Adding more input data to finalized stream is impossible\&. +.TP +\fB\fIBROTLI_OPERATION_EMIT_METADATA \fP\fP +Emit metadata block to stream\&. Metadata is opaque to Brotli: neither encoder, nor decoder processes this data or relies on it\&. It may be used to pass some extra information from encoder client to decoder client without interfering with main data stream\&. +.PP +\fBNote:\fP +.RS 4 +Encoder may emit empty metadata blocks internally, to pad encoded stream to byte boundary\&. +.RE +.PP +\fBWarning:\fP +.RS 4 +Until emitting metadata is complete client \fBSHOULD\fP \fBNOT\fP swap, reduce or extend input stream\&. +.PP +The whole content of input buffer is considered to be the content of metadata block\&. Do \fBNOT\fP \fIappend\fP metadata to input stream, before it is depleted with other operations\&. +.RE +.PP +Stream is soft-flushed before metadata block is emitted\&. Metadata block \fBMUST\fP be no longer than than 16MiB\&. +.SS "enum \fBBrotliEncoderParameter\fP" + +.PP +Options to be used with \fBBrotliEncoderSetParameter\fP\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIBROTLI_PARAM_MODE \fP\fP +Tune encoder for specific input\&. \fBBrotliEncoderMode\fP enumerates all available values\&. +.TP +\fB\fIBROTLI_PARAM_QUALITY \fP\fP +The main compression speed-density lever\&. The higher the quality, the slower the compression\&. Range is from \fBBROTLI_MIN_QUALITY\fP to \fBBROTLI_MAX_QUALITY\fP\&. +.TP +\fB\fIBROTLI_PARAM_LGWIN \fP\fP +Recommended sliding LZ77 window size\&. Encoder may reduce this value, e\&.g\&. if input is much smaller than window size\&. +.PP +Window size is \fC(1 << value) - 16\fP\&. +.PP +Range is from \fBBROTLI_MIN_WINDOW_BITS\fP to \fBBROTLI_MAX_WINDOW_BITS\fP\&. +.TP +\fB\fIBROTLI_PARAM_LGBLOCK \fP\fP +Recommended input block size\&. Encoder may reduce this value, e\&.g\&. if input is much smaller than input block size\&. +.PP +Range is from \fBBROTLI_MIN_INPUT_BLOCK_BITS\fP to \fBBROTLI_MAX_INPUT_BLOCK_BITS\fP\&. +.PP +\fBNote:\fP +.RS 4 +Bigger input block size allows better compression, but consumes more memory\&. +.br + The rough formula of memory used for temporary input storage is \fC3 << lgBlock\fP\&. +.RE +.PP + +.TP +\fB\fIBROTLI_PARAM_DISABLE_LITERAL_CONTEXT_MODELING \fP\fP +Flag that affects usage of 'literal context modeling' format feature\&. This flag is a 'decoding-speed vs compression ratio' trade-off\&. +.TP +\fB\fIBROTLI_PARAM_SIZE_HINT \fP\fP +Estimated total input size for all \fBBrotliEncoderCompressStream\fP calls\&. The default value is 0, which means that the total input size is unknown\&. +.TP +\fB\fIBROTLI_PARAM_LARGE_WINDOW \fP\fP +Flag that determines if 'Large Window Brotli' is used\&. +.TP +\fB\fIBROTLI_PARAM_NPOSTFIX \fP\fP +Recommended number of postfix bits (NPOSTFIX)\&. Encoder may change this value\&. +.PP +Range is from 0 to \fBBROTLI_MAX_NPOSTFIX\fP\&. +.TP +\fB\fIBROTLI_PARAM_NDIRECT \fP\fP +Recommended number of direct distance codes (NDIRECT)\&. Encoder may change this value\&. +.PP +Range is from 0 to (15 << NPOSTFIX) in steps of (1 << NPOSTFIX)\&. +.TP +\fB\fIBROTLI_PARAM_STREAM_OFFSET \fP\fP +Number of bytes of input stream already processed by a different instance\&. +.PP +\fBNote:\fP +.RS 4 +It is important to configure all the encoder instances with same parameters (except this one) in order to allow all the encoded parts obey the same restrictions implied by header\&. +.RE +.PP +If offset is not 0, then stream header is omitted\&. In any case output start is byte aligned, so for proper streams stitching 'predecessor' stream must be flushed\&. +.PP +Range is not artificially limited, but all the values greater or equal to maximal window size have the same effect\&. Values greater than 2**30 are not allowed\&. +.SH "Function Documentation" +.PP +.SS "\fBBROTLI_BOOL\fP BrotliEncoderAttachPreparedDictionary (\fBBrotliEncoderState\fP * state, const BrotliEncoderPreparedDictionary * dictionary)" + +.PP +Attaches a prepared dictionary of any type to the encoder\&. Can be used multiple times to attach multiple dictionaries\&. The dictionary type was determined by BrotliEncoderPrepareDictionary\&. Multiple raw prefix dictionaries and/or max 1 serialized dictionary with custom words can be attached\&. +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP in case of error +.PP +\fBBROTLI_TRUE\fP otherwise +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliEncoderCompress (int quality, int lgwin, \fBBrotliEncoderMode\fP mode, size_t input_size, const uint8_t input_buffer[input_size], size_t * encoded_size, uint8_t encoded_buffer[*encoded_size])" + +.PP +Performs one-shot memory-to-memory compression\&. Compresses the data in \fCinput_buffer\fP into \fCencoded_buffer\fP, and sets \fC*encoded_size\fP to the compressed length\&. +.PP +\fBNote:\fP +.RS 4 +If \fBBrotliEncoderMaxCompressedSize\fP(\fCinput_size\fP) returns non-zero value, then output is guaranteed to be no longer than that\&. +.PP +If \fClgwin\fP is greater than \fBBROTLI_MAX_WINDOW_BITS\fP then resulting stream might be incompatible with RFC 7932; to decode such streams, decoder should be configured with \fBBROTLI_DECODER_PARAM_LARGE_WINDOW\fP = \fC1\fP +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIquality\fP quality parameter value, e\&.g\&. \fBBROTLI_DEFAULT_QUALITY\fP +.br +\fIlgwin\fP lgwin parameter value, e\&.g\&. \fBBROTLI_DEFAULT_WINDOW\fP +.br +\fImode\fP mode parameter value, e\&.g\&. \fBBROTLI_DEFAULT_MODE\fP +.br +\fIinput_size\fP size of \fCinput_buffer\fP +.br +\fIinput_buffer\fP input data buffer with at least \fCinput_size\fP addressable bytes +.br +\fIencoded_size\fP \fBin:\fP size of \fCencoded_buffer\fP; +.br + \fBout:\fP length of compressed data written to \fCencoded_buffer\fP, or \fC0\fP if compression fails +.br +\fIencoded_buffer\fP compressed data destination buffer +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP in case of compression error +.PP +\fBBROTLI_FALSE\fP if output buffer is too small +.PP +\fBBROTLI_TRUE\fP otherwise +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliEncoderCompressStream (\fBBrotliEncoderState\fP * state, \fBBrotliEncoderOperation\fP op, size_t * available_in, const uint8_t ** next_in, size_t * available_out, uint8_t ** next_out, size_t * total_out)" + +.PP +Compresses input stream to output stream\&. The values \fC*available_in\fP and \fC*available_out\fP must specify the number of bytes addressable at \fC*next_in\fP and \fC*next_out\fP respectively\&. When \fC*available_out\fP is \fC0\fP, \fCnext_out\fP is allowed to be \fCNULL\fP\&. +.PP +After each call, \fC*available_in\fP will be decremented by the amount of input bytes consumed, and the \fC*next_in\fP pointer will be incremented by that amount\&. Similarly, \fC*available_out\fP will be decremented by the amount of output bytes written, and the \fC*next_out\fP pointer will be incremented by that amount\&. +.PP +\fCtotal_out\fP, if it is not a null-pointer, will be set to the number of bytes compressed since the last \fCstate\fP initialization\&. +.PP +Internally workflow consists of 3 tasks: +.IP "1." 4 +(optionally) copy input data to internal buffer +.IP "2." 4 +actually compress data and (optionally) store it to internal buffer +.IP "3." 4 +(optionally) copy compressed bytes from internal buffer to output stream +.PP +.PP +Whenever all 3 tasks can't move forward anymore, or error occurs, this method returns the control flow to caller\&. +.PP +\fCop\fP is used to perform flush, finish the stream, or inject metadata block\&. See \fBBrotliEncoderOperation\fP for more information\&. +.PP +Flushing the stream means forcing encoding of all input passed to encoder and completing the current output block, so it could be fully decoded by stream decoder\&. To perform flush set \fCop\fP to \fBBROTLI_OPERATION_FLUSH\fP\&. Under some circumstances (e\&.g\&. lack of output stream capacity) this operation would require several calls to \fBBrotliEncoderCompressStream\fP\&. The method must be called again until both input stream is depleted and encoder has no more output (see \fBBrotliEncoderHasMoreOutput\fP) after the method is called\&. +.PP +Finishing the stream means encoding of all input passed to encoder and adding specific 'final' marks, so stream decoder could determine that stream is complete\&. To perform finish set \fCop\fP to \fBBROTLI_OPERATION_FINISH\fP\&. Under some circumstances (e\&.g\&. lack of output stream capacity) this operation would require several calls to \fBBrotliEncoderCompressStream\fP\&. The method must be called again until both input stream is depleted and encoder has no more output (see \fBBrotliEncoderHasMoreOutput\fP) after the method is called\&. +.PP +\fBWarning:\fP +.RS 4 +When flushing and finishing, \fCop\fP should not change until operation is complete; input stream should not be swapped, reduced or extended as well\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP encoder instance +.br +\fIop\fP requested operation +.br +\fIavailable_in\fP \fBin:\fP amount of available input; +.br + \fBout:\fP amount of unused input +.br +\fInext_in\fP pointer to the next input byte +.br +\fIavailable_out\fP \fBin:\fP length of output buffer; +.br + \fBout:\fP remaining size of output buffer +.br +\fInext_out\fP compressed output buffer cursor; can be \fCNULL\fP if \fCavailable_out\fP is \fC0\fP +.br +\fItotal_out\fP number of bytes produced so far; can be \fCNULL\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP if there was an error +.PP +\fBBROTLI_TRUE\fP otherwise +.RE +.PP + +.SS "\fBBrotliEncoderState\fP* BrotliEncoderCreateInstance (\fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void * opaque)" + +.PP +Creates an instance of \fBBrotliEncoderState\fP and initializes it\&. \fCalloc_func\fP and \fCfree_func\fP \fBMUST\fP be both zero or both non-zero\&. In the case they are both zero, default memory allocators are used\&. \fCopaque\fP is passed to \fCalloc_func\fP and \fCfree_func\fP when they are called\&. \fCfree_func\fP has to return without doing anything when asked to free a NULL pointer\&. +.PP +\fBParameters:\fP +.RS 4 +\fIalloc_func\fP custom memory allocation function +.br +\fIfree_func\fP custom memory free function +.br +\fIopaque\fP custom memory manager handle +.RE +.PP +\fBReturns:\fP +.RS 4 +\fC0\fP if instance can not be allocated or initialized +.PP +pointer to initialized \fBBrotliEncoderState\fP otherwise +.RE +.PP + +.SS "void BrotliEncoderDestroyInstance (\fBBrotliEncoderState\fP * state)" + +.PP +Deinitializes and frees \fBBrotliEncoderState\fP instance\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP decoder instance to be cleaned up and deallocated +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliEncoderHasMoreOutput (\fBBrotliEncoderState\fP * state)" + +.PP +Checks if encoder has more output\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP encoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_TRUE\fP, if encoder has some unconsumed output +.PP +\fBBROTLI_FALSE\fP otherwise +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliEncoderIsFinished (\fBBrotliEncoderState\fP * state)" + +.PP +Checks if encoder instance reached the final state\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP encoder instance +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_TRUE\fP if encoder is in a state where it reached the end of the input and produced all of the output +.PP +\fBBROTLI_FALSE\fP otherwise +.RE +.PP + +.SS "size_t BrotliEncoderMaxCompressedSize (size_t input_size)" + +.PP +Calculates the output size bound for the given \fCinput_size\fP\&. +.PP +\fBWarning:\fP +.RS 4 +Result is only valid if quality is at least \fC2\fP and, in case \fBBrotliEncoderCompressStream\fP was used, no flushes (\fBBROTLI_OPERATION_FLUSH\fP) were performed\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIinput_size\fP size of projected input +.RE +.PP +\fBReturns:\fP +.RS 4 +\fC0\fP if result does not fit \fCsize_t\fP +.RE +.PP + +.SS "BrotliEncoderPreparedDictionary* BrotliEncoderPrepareDictionary (BrotliSharedDictionaryType type, size_t data_size, const uint8_t data[data_size], int quality, \fBbrotli_alloc_func\fP alloc_func, \fBbrotli_free_func\fP free_func, void * opaque)" + +.PP +Prepares a shared dictionary from the given file format for the encoder\&. \fCalloc_func\fP and \fCfree_func\fP \fBMUST\fP be both zero or both non-zero\&. In the case they are both zero, default memory allocators are used\&. \fCopaque\fP is passed to \fCalloc_func\fP and \fCfree_func\fP when they are called\&. \fCfree_func\fP has to return without doing anything when asked to free a NULL pointer\&. +.PP +\fBWarning:\fP +.RS 4 +Created instance is 'lean'; it does not contain copy of \fCdata\fP, rather it contains only pointer to it; therefore, \fCdata\fP \fBMUST\fP outlive the created instance\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fItype\fP type of dictionary stored in data +.br +\fIdata_size\fP size of \fCdata\fP buffer +.br +\fIdata\fP pointer to the dictionary data +.br +\fIquality\fP the maximum Brotli quality to prepare the dictionary for, use BROTLI_MAX_QUALITY by default +.br +\fIalloc_func\fP custom memory allocation function +.br +\fIfree_func\fP custom memory free function +.br +\fIopaque\fP custom memory manager handle +.RE +.PP + +.SS "\fBBROTLI_BOOL\fP BrotliEncoderSetParameter (\fBBrotliEncoderState\fP * state, \fBBrotliEncoderParameter\fP param, uint32_t value)" + +.PP +Sets the specified parameter to the given encoder instance\&. +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP encoder instance +.br +\fIparam\fP parameter to set +.br +\fIvalue\fP new parameter value +.RE +.PP +\fBReturns:\fP +.RS 4 +\fBBROTLI_FALSE\fP if parameter is unrecognized, or value is invalid +.PP +\fBBROTLI_FALSE\fP if value of parameter can not be changed at current encoder state (e\&.g\&. when encoding is started, window size might be already encoded and therefore it is impossible to change it) +.PP +\fBBROTLI_TRUE\fP if value is accepted +.RE +.PP +\fBWarning:\fP +.RS 4 +invalid values might be accepted in case they would not break encoding process\&. +.RE +.PP + +.SS "const uint8_t* BrotliEncoderTakeOutput (\fBBrotliEncoderState\fP * state, size_t * size)" + +.PP +Acquires pointer to internal output buffer\&. This method is used to make language bindings easier and more efficient: +.IP "1." 4 +push data to \fBBrotliEncoderCompressStream\fP, until \fBBrotliEncoderHasMoreOutput\fP returns BROTLI_TRUE +.IP "2." 4 +use \fBBrotliEncoderTakeOutput\fP to peek bytes and copy to language-specific entity +.PP +.PP +Also this could be useful if there is an output stream that is able to consume all the provided data (e\&.g\&. when data is saved to file system)\&. +.PP +\fBAttention:\fP +.RS 4 +After every call to \fBBrotliEncoderTakeOutput\fP \fC*size\fP bytes of output are considered consumed for all consecutive calls to the instance methods; returned pointer becomes invalidated as well\&. +.RE +.PP +\fBNote:\fP +.RS 4 +Encoder output is not guaranteed to be contiguous\&. This means that after the size-unrestricted call to \fBBrotliEncoderTakeOutput\fP, immediate next call to \fBBrotliEncoderTakeOutput\fP may return more data\&. +.RE +.PP +\fBParameters:\fP +.RS 4 +\fIstate\fP encoder instance +.br +\fIsize\fP \fBin:\fP number of bytes caller is ready to take, \fC0\fP if any amount could be handled; +.br + \fBout:\fP amount of data pointed by returned pointer and considered consumed; +.br + out value is never greater than in value, unless it is \fC0\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +pointer to output data +.RE +.PP + +.SS "uint32_t BrotliEncoderVersion (void)" + +.PP +Gets an encoder library version\&. Look at BROTLI_MAKE_HEX_VERSION for more information\&. +.SH "Author" +.PP +Generated automatically by Doxygen for Brotli from the source code\&. diff --git a/miniconda3/share/man/man3/ev.3 b/miniconda3/share/man/man3/ev.3 new file mode 100644 index 0000000000000000000000000000000000000000..af578f0bb4eebd143a96cc4654cb0c217f923c85 --- /dev/null +++ b/miniconda3/share/man/man3/ev.3 @@ -0,0 +1,5819 @@ +.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LIBEV 3" +.TH LIBEV 3 "2020-03-12" "libev-4.31" "libev - high performance full featured event loop" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +libev \- a high performance full\-featured event loop written in C +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 1 +\& #include +.Ve +.SS "\s-1EXAMPLE PROGRAM\s0" +.IX Subsection "EXAMPLE PROGRAM" +.Vb 2 +\& // a single header file is required +\& #include +\& +\& #include // for puts +\& +\& // every watcher type has its own typedef\*(Aqd struct +\& // with the name ev_TYPE +\& ev_io stdin_watcher; +\& ev_timer timeout_watcher; +\& +\& // all watcher callbacks have a similar signature +\& // this callback is called when data is readable on stdin +\& static void +\& stdin_cb (EV_P_ ev_io *w, int revents) +\& { +\& puts ("stdin ready"); +\& // for one\-shot events, one must manually stop the watcher +\& // with its corresponding stop function. +\& ev_io_stop (EV_A_ w); +\& +\& // this causes all nested ev_run\*(Aqs to stop iterating +\& ev_break (EV_A_ EVBREAK_ALL); +\& } +\& +\& // another callback, this time for a time\-out +\& static void +\& timeout_cb (EV_P_ ev_timer *w, int revents) +\& { +\& puts ("timeout"); +\& // this causes the innermost ev_run to stop iterating +\& ev_break (EV_A_ EVBREAK_ONE); +\& } +\& +\& int +\& main (void) +\& { +\& // use the default event loop unless you have special needs +\& struct ev_loop *loop = EV_DEFAULT; +\& +\& // initialise an io watcher, then start it +\& // this one will watch for stdin to become readable +\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); +\& ev_io_start (loop, &stdin_watcher); +\& +\& // initialise a timer watcher, then start it +\& // simple non\-repeating 5.5 second timeout +\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); +\& ev_timer_start (loop, &timeout_watcher); +\& +\& // now wait for events to arrive +\& ev_run (loop, 0); +\& +\& // break was called, so exit +\& return 0; +\& } +.Ve +.SH "ABOUT THIS DOCUMENT" +.IX Header "ABOUT THIS DOCUMENT" +This document documents the libev software package. +.PP +The newest version of this document is also available as an html-formatted +web page you might find easier to navigate when reading it for the first +time: . +.PP +While this document tries to be as complete as possible in documenting +libev, its usage and the rationale behind its design, it is not a tutorial +on event-based programming, nor will it introduce event-based programming +with libev. +.PP +Familiarity with event based programming techniques in general is assumed +throughout this document. +.SH "WHAT TO READ WHEN IN A HURRY" +.IX Header "WHAT TO READ WHEN IN A HURRY" +This manual tries to be very detailed, but unfortunately, this also makes +it very long. If you just want to know the basics of libev, I suggest +reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and +look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and +\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0. +.SH "ABOUT LIBEV" +.IX Header "ABOUT LIBEV" +Libev is an event loop: you register interest in certain events (such as a +file descriptor being readable or a timeout occurring), and it will manage +these event sources and provide your program with events. +.PP +To do this, it must take more or less complete control over your process +(or thread) by executing the \fIevent loop\fR handler, and will then +communicate events via a callback mechanism. +.PP +You register interest in certain events by registering so-called \fIevent +watchers\fR, which are relatively small C structures you initialise with the +details of the event, and then hand it over to libev by \fIstarting\fR the +watcher. +.SS "\s-1FEATURES\s0" +.IX Subsection "FEATURES" +Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific aio and \f(CW\*(C`epoll\*(C'\fR +interfaces, the BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port +mechanisms for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR +interface (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner +inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative +timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling +(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status +change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event +loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and +\&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even +limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR). +.PP +It also is quite fast (see this +benchmark comparing it to libevent +for example). +.SS "\s-1CONVENTIONS\s0" +.IX Subsection "CONVENTIONS" +Libev is very configurable. In this manual the default (and most common) +configuration will be described, which supports multiple event loops. For +more info about various configuration options please have a look at +\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support +for multiple event loops, then all functions taking an initial argument of +name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have +this argument. +.SS "\s-1TIME REPRESENTATION\s0" +.IX Subsection "TIME REPRESENTATION" +Libev represents time as a single floating point number, representing +the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice +somewhere near the beginning of 1970, details are complicated, don't +ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use +too. It usually aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do +any calculations on it, you should treat it as some floating point value. +.PP +Unlike the name component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for +time differences (e.g. delays) throughout libev. +.SH "ERROR HANDLING" +.IX Header "ERROR HANDLING" +Libev knows three classes of errors: operating system errors, usage errors +and internal errors (bugs). +.PP +When libev catches an operating system error it cannot handle (for example +a system call indicating a condition libev cannot fix), it calls the callback +set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or +abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort +()\*(C'\fR. +.PP +When libev detects a usage error such as a negative timer interval, then +it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, +so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in +the libev caller and need to be fixed there. +.PP +Via the \f(CW\*(C`EV_FREQUENT\*(C'\fR macro you can compile in and/or enable extensive +consistency checking code inside libev that can be used to check for +internal inconsistencies, suually caused by application bugs. +.PP +Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions. These do not +trigger under normal circumstances, as they indicate either a bug in libev +or worse. +.SH "GLOBAL FUNCTIONS" +.IX Header "GLOBAL FUNCTIONS" +These functions can be called anytime, even before initialising the +library in any way. +.IP "ev_tstamp ev_time ()" 4 +.IX Item "ev_tstamp ev_time ()" +Returns the current time as libev would use it. Please note that the +\&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp +you actually want to know. Also interesting is the combination of +\&\f(CW\*(C`ev_now_update\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR. +.IP "ev_sleep (ev_tstamp interval)" 4 +.IX Item "ev_sleep (ev_tstamp interval)" +Sleep for the given interval: The current thread will be blocked +until either it is interrupted or the given time interval has +passed (approximately \- it might return a bit earlier even if not +interrupted). Returns immediately if \f(CW\*(C`interval <= 0\*(C'\fR. +.Sp +Basically this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. +.Sp +The range of the \f(CW\*(C`interval\*(C'\fR is limited \- libev only guarantees to work +with sleep times of up to one day (\f(CW\*(C`interval <= 86400\*(C'\fR). +.IP "int ev_version_major ()" 4 +.IX Item "int ev_version_major ()" +.PD 0 +.IP "int ev_version_minor ()" 4 +.IX Item "int ev_version_minor ()" +.PD +You can find out the major and minor \s-1ABI\s0 version numbers of the library +you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and +\&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global +symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the +version of the library your program was compiled against. +.Sp +These version numbers refer to the \s-1ABI\s0 version of the library, not the +release version. +.Sp +Usually, it's a good idea to terminate if the major versions mismatch, +as this indicates an incompatible change. Minor versions are usually +compatible to older versions, so a larger minor version alone is usually +not a problem. +.Sp +Example: Make sure we haven't accidentally been linked against the wrong +version (note, however, that this will not detect other \s-1ABI\s0 mismatches, +such as \s-1LFS\s0 or reentrancy). +.Sp +.Vb 3 +\& assert (("libev version mismatch", +\& ev_version_major () == EV_VERSION_MAJOR +\& && ev_version_minor () >= EV_VERSION_MINOR)); +.Ve +.IP "unsigned int ev_supported_backends ()" 4 +.IX Item "unsigned int ev_supported_backends ()" +Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR +value) compiled into this binary of libev (independent of their +availability on the system you are running on). See \f(CW\*(C`ev_default_loop\*(C'\fR for +a description of the set values. +.Sp +Example: make sure we have the epoll method, because yeah this is cool and +a must have and can we have a torrent of it please!!!11 +.Sp +.Vb 2 +\& assert (("sorry, no epoll, no sex", +\& ev_supported_backends () & EVBACKEND_EPOLL)); +.Ve +.IP "unsigned int ev_recommended_backends ()" 4 +.IX Item "unsigned int ev_recommended_backends ()" +Return the set of all backends compiled into this binary of libev and +also recommended for this platform, meaning it will work for most file +descriptor types. This set is often smaller than the one returned by +\&\f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs +and will not be auto-detected unless you explicitly request it (assuming +you know what you are doing). This is the set of backends that libev will +probe for if you specify no backends explicitly. +.IP "unsigned int ev_embeddable_backends ()" 4 +.IX Item "unsigned int ev_embeddable_backends ()" +Returns the set of backends that are embeddable in other event loops. This +value is platform-specific but can include backends not available on the +current system. To find which embeddable backends might be supported on +the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends () +& ev_supported_backends ()\*(C'\fR, likewise for recommended ones. +.Sp +See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. +.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4 +.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" +Sets the allocation function to use (the prototype is similar \- the +semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is +used to allocate and free memory (no surprises here). If it returns zero +when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort +or take some potentially destructive action. +.Sp +Since some systems (at least OpenBSD and Darwin) fail to implement +correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system +\&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default. +.Sp +You could override this function in high-availability programs to, say, +free some memory if it cannot allocate memory, to use a special allocator, +or even to sleep a while and retry until some memory is available. +.Sp +Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses +which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and +is probably a good basis for your own implementation. +.Sp +.Vb 5 +\& static void * +\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT +\& { +\& if (size) +\& return realloc (ptr, size); +\& +\& free (ptr); +\& return 0; +\& } +.Ve +.Sp +Example: Replace the libev allocator with one that waits a bit and then +retries. +.Sp +.Vb 8 +\& static void * +\& persistent_realloc (void *ptr, size_t size) +\& { +\& if (!size) +\& { +\& free (ptr); +\& return 0; +\& } +\& +\& for (;;) +\& { +\& void *newptr = realloc (ptr, size); +\& +\& if (newptr) +\& return newptr; +\& +\& sleep (60); +\& } +\& } +\& +\& ... +\& ev_set_allocator (persistent_realloc); +.Ve +.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4 +.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" +Set the callback function to call on a retryable system call error (such +as failed select, poll, epoll_wait). The message is a printable string +indicating the system call or subsystem causing the problem. If this +callback is set, then libev will expect it to remedy the situation, no +matter what, when it returns. That is, libev will generally retry the +requested operation, or, if the condition doesn't go away, do bad stuff +(such as abort). +.Sp +Example: This is basically the same thing that libev does internally, too. +.Sp +.Vb 6 +\& static void +\& fatal_error (const char *msg) +\& { +\& perror (msg); +\& abort (); +\& } +\& +\& ... +\& ev_set_syserr_cb (fatal_error); +.Ve +.IP "ev_feed_signal (int signum)" 4 +.IX Item "ev_feed_signal (int signum)" +This function can be used to \*(L"simulate\*(R" a signal receive. It is completely +safe to call this function at any time, from any context, including signal +handlers or random threads. +.Sp +Its main use is to customise signal handling in your process, especially +in the presence of threads. For example, you could block signals +by default in all threads (and specifying \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when +creating any loops), and in one thread, use \f(CW\*(C`sigwait\*(C'\fR or any other +mechanism to wait for signals, then \*(L"deliver\*(R" them to libev by calling +\&\f(CW\*(C`ev_feed_signal\*(C'\fR. +.SH "FUNCTIONS CONTROLLING EVENT LOOPS" +.IX Header "FUNCTIONS CONTROLLING EVENT LOOPS" +An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is +\&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as +libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name). +.PP +The library knows two types of such loops, the \fIdefault\fR loop, which +supports child process events, and dynamically created event loops which +do not. +.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 +.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" +This returns the \*(L"default\*(R" event loop object, which is what you should +normally use when you just need \*(L"the event loop\*(R". Event loop objects and +the \f(CW\*(C`flags\*(C'\fR parameter are described in more detail in the entry for +\&\f(CW\*(C`ev_loop_new\*(C'\fR. +.Sp +If the default loop is already initialised then this function simply +returns it (and ignores the flags. If that is troubling you, check +\&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given +flags, which should almost always be \f(CW0\fR, unless the caller is also the +one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R". +.Sp +If you don't know what event loop to use, use the one returned from this +function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro). +.Sp +Note that this function is \fInot\fR thread-safe, so if you want to use it +from multiple threads, you have to employ some kind of mutex (note also +that this case is unlikely, as loops cannot be shared easily between +threads anyway). +.Sp +The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers, +and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is +a problem for your application you can either create a dynamic loop with +\&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the +\&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR. +.Sp +Example: This is the most typical usage. +.Sp +.Vb 2 +\& if (!ev_default_loop (0)) +\& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); +.Ve +.Sp +Example: Restrict libev to the select and poll backends, and do not allow +environment settings to be taken into account: +.Sp +.Vb 1 +\& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); +.Ve +.IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 +.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" +This will create and initialise a new event loop object. If the loop +could not be initialised, returns false. +.Sp +This function is thread-safe, and one common way to use libev with +threads is indeed to create one loop per thread, and using the default +loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. +.Sp +The flags argument can be used to specify special behaviour or specific +backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). +.Sp +The following flags are supported: +.RS 4 +.ie n .IP """EVFLAG_AUTO""" 4 +.el .IP "\f(CWEVFLAG_AUTO\fR" 4 +.IX Item "EVFLAG_AUTO" +The default flags value. Use this if you have no clue (it's the right +thing, believe me). +.ie n .IP """EVFLAG_NOENV""" 4 +.el .IP "\f(CWEVFLAG_NOENV\fR" 4 +.IX Item "EVFLAG_NOENV" +If this flag bit is or'ed into the flag value (or the program runs setuid +or setgid) then libev will \fInot\fR look at the environment variable +\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will +override the flags completely if it is found in the environment. This is +useful to try out specific backends to test their performance, to work +around bugs, or to make libev threadsafe (accessing environment variables +cannot be done in a threadsafe way, but usually it works if no other +thread modifies them). +.ie n .IP """EVFLAG_FORKCHECK""" 4 +.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 +.IX Item "EVFLAG_FORKCHECK" +Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also +make libev check for a fork in each iteration by enabling this flag. +.Sp +This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, +and thus this might slow down your event loop if you do a lot of loop +iterations and little real work, but is usually not noticeable (on my +GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn +sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux +system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc +versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again). +.Sp +The big advantage of this flag is that you can forget about fork (and +forget about forgetting to tell libev about forking, although you still +have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag. +.Sp +This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR +environment variable. +.ie n .IP """EVFLAG_NOINOTIFY""" 4 +.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 +.IX Item "EVFLAG_NOINOTIFY" +When this flag is specified, then libev will not attempt to use the +\&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and +testing, this flag can be useful to conserve inotify file descriptors, as +otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle. +.ie n .IP """EVFLAG_SIGNALFD""" 4 +.el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4 +.IX Item "EVFLAG_SIGNALFD" +When this flag is specified, then libev will attempt to use the +\&\fIsignalfd\fR \s-1API\s0 for its \f(CW\*(C`ev_signal\*(C'\fR (and \f(CW\*(C`ev_child\*(C'\fR) watchers. This \s-1API\s0 +delivers signals synchronously, which makes it both faster and might make +it possible to get the queued signal data. It can also simplify signal +handling with threads, as long as you properly block signals in your +threads that are not interested in handling them. +.Sp +Signalfd will not be used by default as this changes your signal mask, and +there are a lot of shoddy libraries and programs (glib's threadpool for +example) that can't properly initialise their signal masks. +.ie n .IP """EVFLAG_NOSIGMASK""" 4 +.el .IP "\f(CWEVFLAG_NOSIGMASK\fR" 4 +.IX Item "EVFLAG_NOSIGMASK" +When this flag is specified, then libev will avoid to modify the signal +mask. Specifically, this means you have to make sure signals are unblocked +when you want to receive them. +.Sp +This behaviour is useful when you want to do your own signal handling, or +want to handle signals only in specific threads and want to avoid libev +unblocking the signals. +.Sp +It's also required by \s-1POSIX\s0 in a threaded program, as libev calls +\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. +.ie n .IP """EVFLAG_NOTIMERFD""" 4 +.el .IP "\f(CWEVFLAG_NOTIMERFD\fR" 4 +.IX Item "EVFLAG_NOTIMERFD" +When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to +detect time jumps. It will still be able to detect time jumps, but takes +longer and has a lower accuracy in doing so, but saves a file descriptor +per loop. +.Sp +The current implementation only tries to use a \f(CW\*(C`timerfd\*(C'\fR when the first +\&\f(CW\*(C`ev_periodic\*(C'\fR watcher is started and falls back on other methods if it +cannot be created, but this behaviour might change in the future. +.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 +.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 +.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" +This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as +libev tries to roll its own fd_set with no limits on the number of fds, +but if that fails, expect a fairly low limit on the number of fds when +using this backend. It doesn't scale too well (O(highest_fd)), but its +usually the fastest backend for a low number of (low-numbered :) fds. +.Sp +To get good performance out of this backend you need a high amount of +parallelism (most of the file descriptors should be busy). If you are +writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many +connections as possible during one iteration. You might also want to have +a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of +readiness notifications you get per iteration. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the +\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the +\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). +.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 +.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 +.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" +And this is your standard \fBpoll\fR\|(2) backend. It's more complicated +than select, but handles sparse fds better and has no artificial +limit on the number of fds you can use (except it will slow down +considerably with a lot of inactive fds). It scales similarly to select, +i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for +performance tips. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and +\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. +.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 +.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 +.IX Item "EVBACKEND_EPOLL (value 4, Linux)" +Use the Linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 +kernels). +.Sp +For few fds, this backend is a bit little slower than poll and select, but +it scales phenomenally better. While poll and select usually scale like +O(total_fds) where total_fds is the total number of fds (or the highest +fd), epoll scales either O(1) or O(active_fds). +.Sp +The epoll mechanism deserves honorable mention as the most misdesigned +of the more advanced event mechanisms: mere annoyances include silently +dropping file descriptors, requiring a system call per change per file +descriptor (and unnecessary guessing of parameters), problems with dup, +returning before the timeout value, resulting in additional iterations +(and only giving 5ms accuracy while select on the same platform gives +0.1ms) and so on. The biggest issue is fork races, however \- if a program +forks then \fIboth\fR parent and child process have to recreate the epoll +set, which can take considerable time (one syscall per file descriptor) +and is of course hard to detect. +.Sp +Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, +but of course \fIdoesn't\fR, and epoll just loves to report events for +totally \fIdifferent\fR file descriptors (even already closed ones, so +one cannot even remove them from the set) than registered in the set +(especially on \s-1SMP\s0 systems). Libev tries to counter these spurious +notifications by employing an additional generation counter and comparing +that against the events to filter out spurious ones, recreating the set +when required. Epoll also erroneously rounds down timeouts, but gives you +no way to know when and by how much, so sometimes you have to busy-wait +because epoll returns immediately despite a nonzero timeout. And last +not least, it also refuses to work with some file descriptors which work +perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...). +.Sp +Epoll is truly the train wreck among event poll mechanisms, a frankenpoll, +cobbled together in a hurry, no thought to design or interaction with +others. Oh, the pain, will it ever stop... +.Sp +While stopping, setting and starting an I/O watcher in the same iteration +will result in some caching, there is still a system call per such +incident (because the same \fIfile descriptor\fR could point to a different +\&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed +file descriptors might not work very well if you register events for both +file descriptors. +.Sp +Best performance from this backend is achieved by not unregistering all +watchers for a file descriptor until it has been closed, if possible, +i.e. keep at least one watcher active per fd at all times. Stopping and +starting a watcher (without re-setting it) also usually doesn't cause +extra overhead. A fork can both result in spurious notifications as well +as in libev having to destroy and recreate the epoll object, which can +take considerable time and thus should be avoided. +.Sp +All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or +faster than epoll for maybe up to a hundred file descriptors, depending on +the usage. So sad. +.Sp +While nominally embeddable in other event loops, this feature is broken in +a lot of kernel revisions, but probably(!) works in current versions. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as +\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. +.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4 +.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4 +.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)" +Use the Linux-specific Linux \s-1AIO\s0 (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels (but libev +only tries to use it in 4.19+). +.Sp +This is another Linux train wreck of an event interface. +.Sp +If this backend works for you (as of this writing, it was very +experimental), it is the best event interface available on Linux and might +be well worth enabling it \- if it isn't available in your kernel this will +be detected and this backend will be skipped. +.Sp +This backend can batch oneshot requests and supports a user-space ring +buffer to receive events. It also doesn't suffer from most of the design +problems of epoll (such as not being able to remove event sources from +the epoll set), and generally sounds too good to be true. Because, this +being the Linux kernel, of course it suffers from a whole new set of +limitations, forcing you to fall back to epoll, inheriting all its design +issues. +.Sp +For one, it is not easily embeddable (but probably could be done using +an event fd at some extra overhead). It also is subject to a system wide +limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR. If no \s-1AIO\s0 +requests are left, this backend will be skipped during initialisation, and +will switch to epoll when the loop is active. +.Sp +Most problematic in practice, however, is that not all file descriptors +work with it. For example, in Linux 5.1, \s-1TCP\s0 sockets, pipes, event fds, +files, \fI/dev/null\fR and many others are supported, but ttys do not work +properly (a known bug that the kernel developers don't care about, see +), so this is not +(yet?) a generic event polling interface. +.Sp +Overall, it seems the Linux developers just don't want it to have a +generic event handling mechanism other than \f(CW\*(C`select\*(C'\fR or \f(CW\*(C`poll\*(C'\fR. +.Sp +To work around all these problem, the current version of libev uses its +epoll backend as a fallback for file descriptor types that do not work. Or +falls back completely to epoll if the kernel acts up. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as +\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. +.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 +.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 +.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" +Kqueue deserves special mention, as at the time this backend was +implemented, it was broken on all BSDs except NetBSD (usually it doesn't +work reliably with anything but sockets and pipes, except on Darwin, +where of course it's completely useless). Unlike epoll, however, whose +brokenness is by design, these kqueue bugs can be (and mostly have been) +fixed without \s-1API\s0 changes to existing programs. For this reason it's not +being \*(L"auto-detected\*(R" on all platforms unless you explicitly specify it +in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a +known-to-be-good (\-enough) system like NetBSD. +.Sp +You still can embed kqueue into a normal poll or select backend and use it +only for sockets (after having made sure that sockets work with kqueue on +the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. +.Sp +It scales in the same way as the epoll backend, but the interface to the +kernel is more efficient (which says nothing about its actual speed, of +course). While stopping, setting and starting an I/O watcher does never +cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to +two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you +might have to leak fds on fork, but it's more sane than epoll) and it +drops fds silently in similarly hard-to-detect cases. +.Sp +This backend usually performs well under most conditions. +.Sp +While nominally embeddable in other event loops, this doesn't work +everywhere, so you might need to test for this. And since it is broken +almost everywhere, you should only use it when you have a lot of sockets +(for which it usually works), by embedding it into another event loop +(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course +also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with +\&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with +\&\f(CW\*(C`NOTE_EOF\*(C'\fR. +.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 +.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 +.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" +This is not implemented yet (and might never be, unless you send me an +implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets +and is not embeddable, which would limit the usefulness of this backend +immensely. +.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 +.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 +.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" +This uses the Solaris 10 event port mechanism. As with everything on Solaris, +it's really slow, but it still scales very well (O(active_fds)). +.Sp +While this backend scales well, it requires one system call per active +file descriptor per loop iteration. For small and medium numbers of file +descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend +might perform better. +.Sp +On the positive side, this backend actually performed fully to +specification in all tests and is fully embeddable, which is a rare feat +among the OS-specific backends (I vastly prefer correctness over speed +hacks). +.Sp +On the negative side, the interface is \fIbizarre\fR \- so bizarre that +even sun itself gets it wrong in their code examples: The event polling +function sometimes returns events to the caller even though an error +occurred, but with no indication whether it has done so or not (yes, it's +even documented that way) \- deadly for edge-triggered interfaces where you +absolutely have to know whether an event occurred or not because you have +to re-arm the watcher. +.Sp +Fortunately libev seems to be able to work around these idiocies. +.Sp +This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as +\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. +.ie n .IP """EVBACKEND_ALL""" 4 +.el .IP "\f(CWEVBACKEND_ALL\fR" 4 +.IX Item "EVBACKEND_ALL" +Try all backends (even potentially broken ones that wouldn't be tried +with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as +\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. +.Sp +It is definitely not recommended to use this flag, use whatever +\&\f(CW\*(C`ev_recommended_backends ()\*(C'\fR returns, or simply do not specify a backend +at all. +.ie n .IP """EVBACKEND_MASK""" 4 +.el .IP "\f(CWEVBACKEND_MASK\fR" 4 +.IX Item "EVBACKEND_MASK" +Not a backend at all, but a mask to select all backend bits from a +\&\f(CW\*(C`flags\*(C'\fR value, in case you want to mask out any backends from a flags +value (e.g. when modifying the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR environment variable). +.RE +.RS 4 +.Sp +If one or more of the backend flags are or'ed into the flags value, +then only these backends will be tried (in the reverse order as listed +here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends +()\*(C'\fR will be tried. +.Sp +Example: Try to create a event loop that uses epoll and nothing else. +.Sp +.Vb 3 +\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); +\& if (!epoller) +\& fatal ("no epoll found here, maybe it hides under your chair"); +.Ve +.Sp +Example: Use whatever libev has to offer, but make sure that kqueue is +used if available. +.Sp +.Vb 1 +\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); +.Ve +.Sp +Example: Similarly, on linux, you mgiht want to take advantage of the +linux aio backend if possible, but fall back to something else if that +isn't available. +.Sp +.Vb 1 +\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO); +.Ve +.RE +.IP "ev_loop_destroy (loop)" 4 +.IX Item "ev_loop_destroy (loop)" +Destroys an event loop object (frees all memory and kernel state +etc.). None of the active event watchers will be stopped in the normal +sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your +responsibility to either stop all watchers cleanly yourself \fIbefore\fR +calling this function, or cope with the fact afterwards (which is usually +the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them +for example). +.Sp +Note that certain global state, such as signal state (and installed signal +handlers), will not be freed by this function, and related watchers (such +as signal and child watchers) would need to be stopped manually. +.Sp +This function is normally used on loop objects allocated by +\&\f(CW\*(C`ev_loop_new\*(C'\fR, but it can also be used on the default loop returned by +\&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe. +.Sp +Note that it is not advisable to call this function on the default loop +except in the rare occasion where you really need to free its resources. +If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR +and \f(CW\*(C`ev_loop_destroy\*(C'\fR. +.IP "ev_loop_fork (loop)" 4 +.IX Item "ev_loop_fork (loop)" +This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations +to reinitialise the kernel state for backends that have one. Despite +the name, you can call it anytime you are allowed to start or stop +watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most +sense after forking, in the child process. You \fImust\fR call it (or use +\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. +.Sp +In addition, if you want to reuse a loop (via this function or +\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR. +.Sp +Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after +a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is +because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things +during fork. +.Sp +On the other hand, you only need to call this function in the child +process if and only if you want to use the event loop in the child. If +you just fork+exec or create a new loop in the child, you don't have to +call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a +difference, but libev will usually detect this case on its own and do a +costly reset of the backend). +.Sp +The function itself is quite fast and it's usually not a problem to call +it just in case after a fork. +.Sp +Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when +using pthreads. +.Sp +.Vb 5 +\& static void +\& post_fork_child (void) +\& { +\& ev_loop_fork (EV_DEFAULT); +\& } +\& +\& ... +\& pthread_atfork (0, 0, post_fork_child); +.Ve +.IP "int ev_is_default_loop (loop)" 4 +.IX Item "int ev_is_default_loop (loop)" +Returns true when the given loop is, in fact, the default loop, and false +otherwise. +.IP "unsigned int ev_iteration (loop)" 4 +.IX Item "unsigned int ev_iteration (loop)" +Returns the current iteration count for the event loop, which is identical +to the number of times libev did poll for new events. It starts at \f(CW0\fR +and happily wraps around with enough iterations. +.Sp +This value can sometimes be useful as a generation counter of sorts (it +\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with +\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the +prepare and check phases. +.IP "unsigned int ev_depth (loop)" 4 +.IX Item "unsigned int ev_depth (loop)" +Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of +times \f(CW\*(C`ev_run\*(C'\fR was exited normally, in other words, the recursion depth. +.Sp +Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is +\&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread), +in which case it is higher. +.Sp +Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread, +throwing an exception etc.), doesn't count as \*(L"exit\*(R" \- consider this +as a hint to avoid such ungentleman-like behaviour unless it's really +convenient, in which case it is fully supported. +.IP "unsigned int ev_backend (loop)" 4 +.IX Item "unsigned int ev_backend (loop)" +Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in +use. +.IP "ev_tstamp ev_now (loop)" 4 +.IX Item "ev_tstamp ev_now (loop)" +Returns the current \*(L"event loop time\*(R", which is the time the event loop +received events and started processing them. This timestamp does not +change as long as callbacks are being processed, and this is also the base +time used for relative timers. You can treat it as the timestamp of the +event occurring (or more correctly, libev finding out about it). +.IP "ev_now_update (loop)" 4 +.IX Item "ev_now_update (loop)" +Establishes the current time by querying the kernel, updating the time +returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and +is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR. +.Sp +This function is rarely useful, but when some event callback runs for a +very long time without entering the event loop, updating libev's idea of +the current time is a good idea. +.Sp +See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section. +.IP "ev_suspend (loop)" 4 +.IX Item "ev_suspend (loop)" +.PD 0 +.IP "ev_resume (loop)" 4 +.IX Item "ev_resume (loop)" +.PD +These two functions suspend and resume an event loop, for use when the +loop is not used for a while and timeouts should not be processed. +.Sp +A typical use case would be an interactive program such as a game: When +the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it +would be best to handle timeouts as if no time had actually passed while +the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR +in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling +\&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing. +.Sp +Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend +between \f(CW\*(C`ev_suspend\*(C'\fR and \f(CW\*(C`ev_resume\*(C'\fR, and all \f(CW\*(C`ev_periodic\*(C'\fR watchers +will be rescheduled (that is, they will lose any events that would have +occurred while suspended). +.Sp +After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the +given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR +without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. +.Sp +Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the +event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). +.IP "bool ev_run (loop, int flags)" 4 +.IX Item "bool ev_run (loop, int flags)" +Finally, this is it, the event handler. This function usually is called +after you have initialised all your watchers and you want to start +handling events. It will ask the operating system for any new events, call +the watcher callbacks, and then repeat the whole process indefinitely: This +is why event loops are called \fIloops\fR. +.Sp +If the flags argument is specified as \f(CW0\fR, it will keep handling events +until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was +called. +.Sp +The return value is false if there are no more active watchers (which +usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases +(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again"). +.Sp +Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than +relying on all watchers to be stopped when deciding when a program has +finished (especially in interactive programs), but having a program +that automatically loops as long as it has to and no longer by virtue +of relying on its watchers stopping correctly, that is truly a thing of +beauty. +.Sp +This function is \fImostly\fR exception-safe \- you can break out of a +\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+ +exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor +will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks. +.Sp +A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle +those events and any already outstanding ones, but will not wait and +block your process in case there are no events and will return after one +iteration of the loop. This is sometimes useful to poll and handle new +events while doing lengthy calculations, to keep the program responsive. +.Sp +A flags value of \f(CW\*(C`EVRUN_ONCE\*(C'\fR will look for new events (waiting if +necessary) and will handle those and any already outstanding ones. It +will block your process until at least one new event arrives (which could +be an event internal to libev itself, so there is no guarantee that a +user-registered callback will be called), and will return after one +iteration of the loop. +.Sp +This is useful if you are waiting for some external event in conjunction +with something not expressible using other libev watchers (i.e. "roll your +own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is +usually a better approach for this kind of thing. +.Sp +Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does (this is for your +understanding, not a guarantee that things will work exactly like this in +future versions): +.Sp +.Vb 10 +\& \- Increment loop depth. +\& \- Reset the ev_break status. +\& \- Before the first iteration, call any pending watchers. +\& LOOP: +\& \- If EVFLAG_FORKCHECK was used, check for a fork. +\& \- If a fork was detected (by any means), queue and call all fork watchers. +\& \- Queue and call all prepare watchers. +\& \- If ev_break was called, goto FINISH. +\& \- If we have been forked, detach and recreate the kernel state +\& as to not disturb the other process. +\& \- Update the kernel state with all outstanding changes. +\& \- Update the "event loop time" (ev_now ()). +\& \- Calculate for how long to sleep or block, if at all +\& (active idle watchers, EVRUN_NOWAIT or not having +\& any active watchers at all will result in not sleeping). +\& \- Sleep if the I/O and timer collect interval say so. +\& \- Increment loop iteration counter. +\& \- Block the process, waiting for any events. +\& \- Queue all outstanding I/O (fd) events. +\& \- Update the "event loop time" (ev_now ()), and do time jump adjustments. +\& \- Queue all expired timers. +\& \- Queue all expired periodics. +\& \- Queue all idle watchers with priority higher than that of pending events. +\& \- Queue all check watchers. +\& \- Call all queued watchers in reverse order (i.e. check watchers first). +\& Signals and child watchers are implemented as I/O watchers, and will +\& be handled here by queueing them when their watcher gets executed. +\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT +\& were used, or there are no active watchers, goto FINISH, otherwise +\& continue with step LOOP. +\& FINISH: +\& \- Reset the ev_break status iff it was EVBREAK_ONE. +\& \- Decrement the loop depth. +\& \- Return. +.Ve +.Sp +Example: Queue some jobs and then loop until no events are outstanding +anymore. +.Sp +.Vb 4 +\& ... queue jobs here, make sure they register event watchers as long +\& ... as they still have work to do (even an idle watcher will do..) +\& ev_run (my_loop, 0); +\& ... jobs done or somebody called break. yeah! +.Ve +.IP "ev_break (loop, how)" 4 +.IX Item "ev_break (loop, how)" +Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it +has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either +\&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or +\&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return. +.Sp +This \*(L"break state\*(R" will be cleared on the next call to \f(CW\*(C`ev_run\*(C'\fR. +.Sp +It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too, in +which case it will have no effect. +.IP "ev_ref (loop)" 4 +.IX Item "ev_ref (loop)" +.PD 0 +.IP "ev_unref (loop)" 4 +.IX Item "ev_unref (loop)" +.PD +Ref/unref can be used to add or remove a reference count on the event +loop: Every watcher keeps one reference, and as long as the reference +count is nonzero, \f(CW\*(C`ev_run\*(C'\fR will not return on its own. +.Sp +This is useful when you have a watcher that you never intend to +unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from +returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR +before stopping it. +.Sp +As an example, libev itself uses this for its internal signal pipe: It +is not visible to the libev user and should not keep \f(CW\*(C`ev_run\*(C'\fR from +exiting if no event watchers registered by it are active. It is also an +excellent way to do this for generic recurring timers or from within +third-party libraries. Just remember to \fIunref after start\fR and \fIref +before stop\fR (but only if the watcher wasn't active before, or was active +before, respectively. Note also that libev might stop watchers itself +(e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR +in the callback). +.Sp +Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR +running when nothing else is active. +.Sp +.Vb 4 +\& ev_signal exitsig; +\& ev_signal_init (&exitsig, sig_cb, SIGINT); +\& ev_signal_start (loop, &exitsig); +\& ev_unref (loop); +.Ve +.Sp +Example: For some weird reason, unregister the above signal handler again. +.Sp +.Vb 2 +\& ev_ref (loop); +\& ev_signal_stop (loop, &exitsig); +.Ve +.IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 +.IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" +.PD 0 +.IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 +.IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" +.PD +These advanced functions influence the time that libev will spend waiting +for events. Both time intervals are by default \f(CW0\fR, meaning that libev +will try to invoke timer/periodic callbacks and I/O callbacks with minimum +latency. +.Sp +Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) +allows libev to delay invocation of I/O and timer/periodic callbacks +to increase efficiency of loop iterations (or to increase power-saving +opportunities). +.Sp +The idea is that sometimes your program runs just fast enough to handle +one (or very few) event(s) per loop iteration. While this makes the +program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new +events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high +overhead for the actual polling but can deliver many events at once. +.Sp +By setting a higher \fIio collect interval\fR you allow libev to spend more +time collecting I/O events, so you can handle more events per iteration, +at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and +\&\f(CW\*(C`ev_timer\*(C'\fR) will not be affected. Setting this to a non-null value will +introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The +sleep time ensures that libev will not poll for I/O events more often then +once per this interval, on average (as long as the host time resolution is +good enough). +.Sp +Likewise, by setting a higher \fItimeout collect interval\fR you allow libev +to spend more time collecting timeouts, at the expense of increased +latency/jitter/inexactness (the watcher callback will be called +later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null +value will not introduce any overhead in libev. +.Sp +Many (busy) programs can usually benefit by setting the I/O collect +interval to a value near \f(CW0.1\fR or so, which is often enough for +interactive servers (of course not for games), likewise for timeouts. It +usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, +as this approaches the timing granularity of most systems. Note that if +you do transactions with the outside world and you can't increase the +parallelity, then this setting will limit your transaction rate (if you +need to poll once per transaction and the I/O collect interval is 0.01, +then you can't do more than 100 transactions per second). +.Sp +Setting the \fItimeout collect interval\fR can improve the opportunity for +saving power, as the program will \*(L"bundle\*(R" timer callback invocations that +are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of +times the process sleeps and wakes up again. Another useful technique to +reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure +they fire on, say, one-second boundaries only. +.Sp +Example: we only need 0.1s timeout granularity, and we wish not to poll +more often than 100 times per second: +.Sp +.Vb 2 +\& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); +\& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); +.Ve +.IP "ev_invoke_pending (loop)" 4 +.IX Item "ev_invoke_pending (loop)" +This call will simply invoke all pending watchers while resetting their +pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required, +but when overriding the invoke callback this call comes handy. This +function can be invoked from a watcher \- this can be useful for example +when you want to do some lengthy calculation and want to pass further +event handling to another thread (you still have to make sure only one +thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course). +.IP "int ev_pending_count (loop)" 4 +.IX Item "int ev_pending_count (loop)" +Returns the number of pending watchers \- zero indicates that no watchers +are pending. +.IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4 +.IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))" +This overrides the invoke pending functionality of the loop: Instead of +invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call +this callback instead. This is useful, for example, when you want to +invoke the actual watchers inside another context (another thread etc.). +.Sp +If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new +callback. +.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4 +.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())" +Sometimes you want to share the same loop between multiple threads. This +can be done relatively simply by putting mutex_lock/unlock calls around +each call to a libev function. +.Sp +However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible +to wait for it to return. One way around this is to wake up the event +loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`ev_async_send\*(C'\fR, another way is to set these +\&\fIrelease\fR and \fIacquire\fR callbacks on the loop. +.Sp +When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is +suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just +afterwards. +.Sp +Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and +\&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again. +.Sp +While event loop modifications are allowed between invocations of +\&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no +modifications done will affect the event loop, i.e. adding watchers will +have no effect on the set of file descriptors being watched, or the time +waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it +to take note of any changes you made. +.Sp +In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between +invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR. +.Sp +See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this +document. +.IP "ev_set_userdata (loop, void *data)" 4 +.IX Item "ev_set_userdata (loop, void *data)" +.PD 0 +.IP "void *ev_userdata (loop)" 4 +.IX Item "void *ev_userdata (loop)" +.PD +Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When +\&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns +\&\f(CW0\fR. +.Sp +These two functions can be used to associate arbitrary data with a loop, +and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and +\&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for +any other purpose as well. +.IP "ev_verify (loop)" 4 +.IX Item "ev_verify (loop)" +This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been +compiled in, which is the default for non-minimal builds. It tries to go +through all internal structures and checks them for validity. If anything +is found to be inconsistent, it will print an error message to standard +error and call \f(CW\*(C`abort ()\*(C'\fR. +.Sp +This can be used to catch bugs inside libev itself: under normal +circumstances, this function will never abort as of course libev keeps its +data structures consistent. +.SH "ANATOMY OF A WATCHER" +.IX Header "ANATOMY OF A WATCHER" +In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the +watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer +watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers. +.PP +A watcher is an opaque structure that you allocate and register to record +your interest in some event. To make a concrete example, imagine you want +to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher +for that: +.PP +.Vb 5 +\& static void my_cb (struct ev_loop *loop, ev_io *w, int revents) +\& { +\& ev_io_stop (w); +\& ev_break (loop, EVBREAK_ALL); +\& } +\& +\& struct ev_loop *loop = ev_default_loop (0); +\& +\& ev_io stdin_watcher; +\& +\& ev_init (&stdin_watcher, my_cb); +\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); +\& ev_io_start (loop, &stdin_watcher); +\& +\& ev_run (loop, 0); +.Ve +.PP +As you can see, you are responsible for allocating the memory for your +watcher structures (and it is \fIusually\fR a bad idea to do this on the +stack). +.PP +Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR +or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs). +.PP +Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init (watcher +*, callback)\*(C'\fR, which expects a callback to be provided. This callback is +invoked each time the event occurs (or, in the case of I/O watchers, each +time the event loop detects that the file descriptor given is readable +and/or writable). +.PP +Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR +macro to configure it, with arguments specific to the watcher type. There +is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR. +.PP +To make the watcher actually watch out for events, you have to start it +with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher +*)\*(C'\fR), and you can stop watching for events at any time by calling the +corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR. +.PP +As long as your watcher is active (has been started but not stopped) you +must not touch the values stored in it except when explicitly documented +otherwise. Most specifically you must never reinitialise it or call its +\&\f(CW\*(C`ev_TYPE_set\*(C'\fR macro. +.PP +Each and every callback receives the event loop pointer as first, the +registered watcher structure as second, and a bitset of received events as +third argument. +.PP +The received events usually include a single bit per event type received +(you can receive multiple events at the same time). The possible bit masks +are: +.ie n .IP """EV_READ""" 4 +.el .IP "\f(CWEV_READ\fR" 4 +.IX Item "EV_READ" +.PD 0 +.ie n .IP """EV_WRITE""" 4 +.el .IP "\f(CWEV_WRITE\fR" 4 +.IX Item "EV_WRITE" +.PD +The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or +writable. +.ie n .IP """EV_TIMER""" 4 +.el .IP "\f(CWEV_TIMER\fR" 4 +.IX Item "EV_TIMER" +The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. +.ie n .IP """EV_PERIODIC""" 4 +.el .IP "\f(CWEV_PERIODIC\fR" 4 +.IX Item "EV_PERIODIC" +The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. +.ie n .IP """EV_SIGNAL""" 4 +.el .IP "\f(CWEV_SIGNAL\fR" 4 +.IX Item "EV_SIGNAL" +The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. +.ie n .IP """EV_CHILD""" 4 +.el .IP "\f(CWEV_CHILD\fR" 4 +.IX Item "EV_CHILD" +The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. +.ie n .IP """EV_STAT""" 4 +.el .IP "\f(CWEV_STAT\fR" 4 +.IX Item "EV_STAT" +The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow. +.ie n .IP """EV_IDLE""" 4 +.el .IP "\f(CWEV_IDLE\fR" 4 +.IX Item "EV_IDLE" +The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. +.ie n .IP """EV_PREPARE""" 4 +.el .IP "\f(CWEV_PREPARE\fR" 4 +.IX Item "EV_PREPARE" +.PD 0 +.ie n .IP """EV_CHECK""" 4 +.el .IP "\f(CWEV_CHECK\fR" 4 +.IX Item "EV_CHECK" +.PD +All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to +gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked) +just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks +for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last +watchers invoked before the event loop sleeps or polls for new events, and +\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same +or lower priority within an event loop iteration. +.Sp +Callbacks of both watcher types can start and stop as many watchers as +they want, and all of them will be taken into account (for example, a +\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from +blocking). +.ie n .IP """EV_EMBED""" 4 +.el .IP "\f(CWEV_EMBED\fR" 4 +.IX Item "EV_EMBED" +The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. +.ie n .IP """EV_FORK""" 4 +.el .IP "\f(CWEV_FORK\fR" 4 +.IX Item "EV_FORK" +The event loop has been resumed in the child process after fork (see +\&\f(CW\*(C`ev_fork\*(C'\fR). +.ie n .IP """EV_CLEANUP""" 4 +.el .IP "\f(CWEV_CLEANUP\fR" 4 +.IX Item "EV_CLEANUP" +The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR). +.ie n .IP """EV_ASYNC""" 4 +.el .IP "\f(CWEV_ASYNC\fR" 4 +.IX Item "EV_ASYNC" +The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). +.ie n .IP """EV_CUSTOM""" 4 +.el .IP "\f(CWEV_CUSTOM\fR" 4 +.IX Item "EV_CUSTOM" +Not ever sent (or otherwise used) by libev itself, but can be freely used +by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR). +.ie n .IP """EV_ERROR""" 4 +.el .IP "\f(CWEV_ERROR\fR" 4 +.IX Item "EV_ERROR" +An unspecified error has occurred, the watcher has been stopped. This might +happen because the watcher could not be properly started because libev +ran out of memory, a file descriptor was found to be closed or any other +problem. Libev considers these application bugs. +.Sp +You best act on it by reporting the problem and somehow coping with the +watcher being stopped. Note that well-written programs should not receive +an error ever, so when your watcher receives it, this usually indicates a +bug in your program. +.Sp +Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for +example it might indicate that a fd is readable or writable, and if your +callbacks is well-written it can just attempt the operation and cope with +the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded +programs, though, as the fd could already be closed and reused for another +thing, so beware. +.SS "\s-1GENERIC WATCHER FUNCTIONS\s0" +.IX Subsection "GENERIC WATCHER FUNCTIONS" +.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 +.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 +.IX Item "ev_init (ev_TYPE *watcher, callback)" +This macro initialises the generic portion of a watcher. The contents +of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only +the generic parts of the watcher are initialised, you \fIneed\fR to call +the type-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR macro afterwards to initialise the +type-specific parts. For each type there is also a \f(CW\*(C`ev_TYPE_init\*(C'\fR macro +which rolls both calls into one. +.Sp +You can reinitialise a watcher at any time as long as it has been stopped +(or never started) and there are no pending events outstanding. +.Sp +The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher, +int revents)\*(C'\fR. +.Sp +Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps. +.Sp +.Vb 3 +\& ev_io w; +\& ev_init (&w, my_cb); +\& ev_io_set (&w, STDIN_FILENO, EV_READ); +.Ve +.ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4 +.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4 +.IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])" +This macro initialises the type-specific parts of a watcher. You need to +call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can +call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this +macro on a watcher that is active (it can be pending, however, which is a +difference to the \f(CW\*(C`ev_init\*(C'\fR macro). +.Sp +Although some watcher types do not have type-specific arguments +(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. +.Sp +See \f(CW\*(C`ev_init\*(C'\fR, above, for an example. +.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 +.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 +.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" +This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro +calls into a single call. This is the most convenient method to initialise +a watcher. The same limitations apply, of course. +.Sp +Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step. +.Sp +.Vb 1 +\& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); +.Ve +.ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4 +.el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4 +.IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)" +Starts (activates) the given watcher. Only active watchers will receive +events. If the watcher is already active nothing will happen. +.Sp +Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this +whole section. +.Sp +.Vb 1 +\& ev_io_start (EV_DEFAULT_UC, &w); +.Ve +.ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4 +.el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4 +.IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)" +Stops the given watcher if active, and clears the pending status (whether +the watcher was active or not). +.Sp +It is possible that stopped watchers are pending \- for example, +non-repeating timers are being stopped when they become pending \- but +calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor +pending. If you want to free or reuse the memory used by the watcher it is +therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. +.IP "bool ev_is_active (ev_TYPE *watcher)" 4 +.IX Item "bool ev_is_active (ev_TYPE *watcher)" +Returns a true value iff the watcher is active (i.e. it has been started +and not yet been stopped). As long as a watcher is active you must not modify +it. +.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 +.IX Item "bool ev_is_pending (ev_TYPE *watcher)" +Returns a true value iff the watcher is pending, (i.e. it has outstanding +events but its callback has not yet been invoked). As long as a watcher +is pending (but not active) you must not call an init function on it (but +\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must +make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR +it). +.IP "callback ev_cb (ev_TYPE *watcher)" 4 +.IX Item "callback ev_cb (ev_TYPE *watcher)" +Returns the callback currently set on the watcher. +.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4 +.IX Item "ev_set_cb (ev_TYPE *watcher, callback)" +Change the callback. You can change the callback at virtually any time +(modulo threads). +.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 +.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" +.PD 0 +.IP "int ev_priority (ev_TYPE *watcher)" 4 +.IX Item "int ev_priority (ev_TYPE *watcher)" +.PD +Set and query the priority of the watcher. The priority is a small +integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR +(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked +before watchers with lower priority, but priority will not keep watchers +from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). +.Sp +If you need to suppress invocation when higher priority events are pending +you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. +.Sp +You \fImust not\fR change the priority of a watcher as long as it is active or +pending. +.Sp +Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is +fine, as long as you do not mind that the priority value you query might +or might not have been clamped to the valid range. +.Sp +The default priority used by watchers when no priority has been set is +always \f(CW0\fR, which is supposed to not be too high and not be too low :). +.Sp +See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of +priorities. +.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 +.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" +Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither +\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback +can deal with that fact, as both are simply passed through to the +callback. +.IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 +.IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" +If the watcher is pending, this function clears its pending status and +returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the +watcher isn't pending it does nothing and returns \f(CW0\fR. +.Sp +Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its +callback to be invoked, which can be accomplished with this function. +.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4 +.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)" +Feeds the given event set into the event loop, as if the specified event +had happened for the specified watcher (which must be a pointer to an +initialised but not necessarily started event watcher). Obviously you must +not free the watcher as long as it has pending events. +.Sp +Stopping the watcher, letting libev invoke it, or calling +\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was +not started in the first place. +.Sp +See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related +functions that do not need a watcher. +.PP +See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR +OWN COMPOSITE WATCHERS\*(R"\s0 idioms. +.SS "\s-1WATCHER STATES\s0" +.IX Subsection "WATCHER STATES" +There are various watcher states mentioned throughout this manual \- +active, pending and so on. In this section these states and the rules to +transition between them will be described in more detail \- and while these +rules might look complicated, they usually do \*(L"the right thing\*(R". +.IP "initialised" 4 +.IX Item "initialised" +Before a watcher can be registered with the event loop it has to be +initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to +\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. +.Sp +In this state it is simply some block of memory that is suitable for +use in an event loop. It can be moved around, freed, reused etc. at +will \- as long as you either keep the memory contents intact, or call +\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again. +.IP "started/running/active" 4 +.IX Item "started/running/active" +Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes +property of the event loop, and is actively waiting for events. While in +this state it cannot be accessed (except in a few documented ways), moved, +freed or anything else \- the only legal thing is to keep a pointer to it, +and call libev functions on it that are documented to work on active watchers. +.IP "pending" 4 +.IX Item "pending" +If a watcher is active and libev determines that an event it is interested +in has occurred (such as a timer expiring), it will become pending. It will +stay in this pending state until either it is stopped or its callback is +about to be invoked, so it is not normally pending inside the watcher +callback. +.Sp +The watcher might or might not be active while it is pending (for example, +an expired non-repeating timer can be pending but no longer active). If it +is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), +but it is still property of the event loop at this time, so cannot be +moved, freed or reused. And if it is active the rules described in the +previous item still apply. +.Sp +It is also possible to feed an event on a watcher that is not active (e.g. +via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being +active. +.IP "stopped" 4 +.IX Item "stopped" +A watcher can be stopped implicitly by libev (in which case it might still +be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The +latter will clear any pending state the watcher might be in, regardless +of whether it was active or not, so stopping a watcher explicitly before +freeing it is often a good idea. +.Sp +While stopped (and not pending) the watcher is essentially in the +initialised state, that is, it can be reused, moved, modified in any way +you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR +it again). +.SS "\s-1WATCHER PRIORITY MODELS\s0" +.IX Subsection "WATCHER PRIORITY MODELS" +Many event loops support \fIwatcher priorities\fR, which are usually small +integers that influence the ordering of event callback invocation +between watchers in some way, all else being equal. +.PP +In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its +description for the more technical details such as the actual priority +range. +.PP +There are two common ways how these these priorities are being interpreted +by event loops: +.PP +In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation +of lower priority watchers, which means as long as higher priority +watchers receive events, lower priority watchers are not being invoked. +.PP +The less common only-for-ordering model uses priorities solely to order +callback invocation within a single event loop iteration: Higher priority +watchers are invoked before lower priority ones, but they all get invoked +before polling for new events. +.PP +Libev uses the second (only-for-ordering) model for all its watchers +except for idle watchers (which use the lock-out model). +.PP +The rationale behind this is that implementing the lock-out model for +watchers is not well supported by most kernel interfaces, and most event +libraries will just poll for the same events again and again as long as +their callbacks have not been executed, which is very inefficient in the +common case of one high-priority watcher locking out a mass of lower +priority ones. +.PP +Static (ordering) priorities are most useful when you have two or more +watchers handling the same resource: a typical usage example is having an +\&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle +timeouts. Under load, data might be received while the program handles +other jobs, but since timers normally get invoked first, the timeout +handler will be executed before checking for data. In that case, giving +the timer a lower priority than the I/O watcher ensures that I/O will be +handled first even under adverse conditions (which is usually, but not +always, what you want). +.PP +Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers +will only be executed when no same or higher priority watchers have +received events, they can be used to implement the \*(L"lock-out\*(R" model when +required. +.PP +For example, to emulate how many other event libraries handle priorities, +you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in +the normal watcher callback, you just start the idle watcher. The real +processing is done in the idle watcher callback. This causes libev to +continuously poll and process kernel event data for the watcher, but when +the lock-out case is known to be rare (which in turn is rare :), this is +workable. +.PP +Usually, however, the lock-out model implemented that way will perform +miserably under the type of load it was designed to handle. In that case, +it might be preferable to stop the real watcher before starting the +idle watcher, so the kernel will not have to process the event in case +the actual processing will be delayed for considerable time. +.PP +Here is an example of an I/O watcher that should run at a strictly lower +priority than the default, and which should only process data when no +other events are pending: +.PP +.Vb 2 +\& ev_idle idle; // actual processing watcher +\& ev_io io; // actual event watcher +\& +\& static void +\& io_cb (EV_P_ ev_io *w, int revents) +\& { +\& // stop the I/O watcher, we received the event, but +\& // are not yet ready to handle it. +\& ev_io_stop (EV_A_ w); +\& +\& // start the idle watcher to handle the actual event. +\& // it will not be executed as long as other watchers +\& // with the default priority are receiving events. +\& ev_idle_start (EV_A_ &idle); +\& } +\& +\& static void +\& idle_cb (EV_P_ ev_idle *w, int revents) +\& { +\& // actual processing +\& read (STDIN_FILENO, ...); +\& +\& // have to start the I/O watcher again, as +\& // we have handled the event +\& ev_io_start (EV_P_ &io); +\& } +\& +\& // initialisation +\& ev_idle_init (&idle, idle_cb); +\& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ); +\& ev_io_start (EV_DEFAULT_ &io); +.Ve +.PP +In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that +low-priority connections can not be locked out forever under load. This +enables your program to keep a lower latency for important connections +during short periods of high load, while not completely locking out less +important ones. +.SH "WATCHER TYPES" +.IX Header "WATCHER TYPES" +This section describes each watcher in detail, but will not repeat +information given in the last section. Any initialisation/set macros, +functions and members specific to the watcher type are explained. +.PP +Most members are additionally marked with either \fI[read\-only]\fR, meaning +that, while the watcher is active, you can look at the member and expect +some sensible content, but you must not modify it (you can modify it while +the watcher is stopped to your hearts content), or \fI[read\-write]\fR, which +means you can expect it to have some sensible content while the watcher is +active, but you can also modify it (within the same thread as the event +loop, i.e. without creating data races). Modifying it may not do something +sensible or take immediate effect (or do anything at all), but libev will +not crash or malfunction in any way. +.PP +In any case, the documentation for each member will explain what the +effects are, and if there are any additional access restrictions. +.ie n .SS """ev_io"" \- is this file descriptor readable or writable?" +.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?" +.IX Subsection "ev_io - is this file descriptor readable or writable?" +I/O watchers check whether a file descriptor is readable or writable +in each iteration of the event loop, or, more precisely, when reading +would not block the process and writing would at least be able to write +some data. This behaviour is called level-triggering because you keep +receiving events as long as the condition persists. Remember you can stop +the watcher if you don't want to act on the event and neither want to +receive future events. +.PP +In general you can register as many read and/or write event watchers per +fd as you want (as long as you don't confuse yourself). Setting all file +descriptors to non-blocking mode is also usually a good idea (but not +required if you know what you are doing). +.PP +Another thing you have to watch out for is that it is quite easy to +receive \*(L"spurious\*(R" readiness notifications, that is, your callback might +be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block +because there is no data. It is very easy to get into this situation even +with a relatively standard program structure. Thus it is best to always +use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning \f(CW\*(C`EAGAIN\*(C'\fR is far +preferable to a program hanging until some data arrives. +.PP +If you cannot run the fd in non-blocking mode (for example you should +not play around with an Xlib connection), then you have to separately +re-test whether a file descriptor is really ready with a known-to-be good +interface such as poll (fortunately in the case of Xlib, it already does +this on its own, so its quite safe to use). Some people additionally +use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block +indefinitely. +.PP +But really, best use non-blocking mode. +.PP +\fIThe special problem of disappearing file descriptors\fR +.IX Subsection "The special problem of disappearing file descriptors" +.PP +Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing +a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other +means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some +file descriptor, but when it goes away, the operating system will silently +drop this interest. If another file descriptor with the same number then +is registered with libev, there is no efficient way to see that this is, +in fact, a different file descriptor. +.PP +To avoid having to explicitly tell libev about such cases, libev follows +the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev +will assume that this is potentially a new file descriptor, otherwise +it is assumed that the file descriptor stays the same. That means that +you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the +descriptor even if the file descriptor number itself did not change. +.PP +This is how one would do it normally anyway, the important point is that +the libev application should not optimise around libev but should leave +optimisations to libev. +.PP +\fIThe special problem of dup'ed file descriptors\fR +.IX Subsection "The special problem of dup'ed file descriptors" +.PP +Some backends (e.g. epoll), cannot register events for file descriptors, +but only events for the underlying file descriptions. That means when you +have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register +events for them, only one file descriptor might actually receive events. +.PP +There is no workaround possible except not registering events +for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to +\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. +.PP +\fIThe special problem of files\fR +.IX Subsection "The special problem of files" +.PP +Many people try to use \f(CW\*(C`select\*(C'\fR (or libev) on file descriptors +representing files, and expect it to become ready when their program +doesn't block on disk accesses (which can take a long time on their own). +.PP +However, this cannot ever work in the \*(L"expected\*(R" way \- you get a readiness +notification as soon as the kernel knows whether and how much data is +there, and in the case of open files, that's always the case, so you +always get a readiness notification instantly, and your read (or possibly +write) will still block on the disk I/O. +.PP +Another way to view it is that in the case of sockets, pipes, character +devices and so on, there is another party (the sender) that delivers data +on its own, but in the case of files, there is no such thing: the disk +will not send data on its own, simply because it doesn't know what you +wish to read \- you would first have to request some data. +.PP +Since files are typically not-so-well supported by advanced notification +mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect +to files, even though you should not use it. The reason for this is +convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is +usually a tty, often a pipe, but also sometimes files or special devices +(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with +\&\fI/dev/urandom\fR), and even though the file might better be served with +asynchronous I/O instead of with non-blocking I/O, it is still useful when +it \*(L"just works\*(R" instead of freezing. +.PP +So avoid file descriptors pointing to files when you know it (e.g. use +libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or +when you rarely read from a file instead of from a socket, and want to +reuse the same code path. +.PP +\fIThe special problem of fork\fR +.IX Subsection "The special problem of fork" +.PP +Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR +at all or exhibit useless behaviour. Libev fully supports fork, but needs +to be told about it in the child if you want to continue to use it in the +child. +.PP +To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork +()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to +\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. +.PP +\fIThe special problem of \s-1SIGPIPE\s0\fR +.IX Subsection "The special problem of SIGPIPE" +.PP +While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: +when writing to a pipe whose other end has been closed, your program gets +sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs +this is sensible behaviour, for daemons, this is usually undesirable. +.PP +So when you encounter spurious, unexplained daemon exits, make sure you +ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon +somewhere, as that would have given you a big clue). +.PP +\fIThe special problem of \f(BIaccept()\fIing when you can't\fR +.IX Subsection "The special problem of accept()ing when you can't" +.PP +Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, +found in post\-2004 Linux) have the peculiar behaviour of not removing a +connection from the pending queue in all error cases. +.PP +For example, larger servers often run out of file descriptors (because +of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not +rejecting the connection, leading to libev signalling readiness on +the next iteration again (the connection still exists after all), and +typically causing the program to loop at 100% \s-1CPU\s0 usage. +.PP +Unfortunately, the set of errors that cause this issue differs between +operating systems, there is usually little the app can do to remedy the +situation, and no known thread-safe method of removing the connection to +cope with overload is known (to me). +.PP +One of the easiest ways to handle this situation is to just ignore it +\&\- when the program encounters an overload, it will just loop until the +situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an +event-based way to handle this situation, so it's the best one can do. +.PP +A better way to handle the situation is to log any errors other than +\&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such +messages, and continue as usual, which at least gives the user an idea of +what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop +the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0 +usage. +.PP +If your program is single-threaded, then you could also keep a dummy file +descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and +when you run into \f(CW\*(C`ENFILE\*(C'\fR or \f(CW\*(C`EMFILE\*(C'\fR, close it, run \f(CW\*(C`accept\*(C'\fR, +close that fd, and create a new dummy fd. This will gracefully refuse +clients under typical overload conditions. +.PP +The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as +is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy +opportunity for a DoS attack. +.PP +\fIWatcher-Specific Functions\fR +.IX Subsection "Watcher-Specific Functions" +.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 +.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" +.PD 0 +.IP "ev_io_set (ev_io *, int fd, int events)" 4 +.IX Item "ev_io_set (ev_io *, int fd, int events)" +.PD +Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to +receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR, both +\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR or \f(CW0\fR, to express the desire to receive the given +events. +.Sp +Note that setting the \f(CW\*(C`events\*(C'\fR to \f(CW0\fR and starting the watcher is +supported, but not specially optimized \- if your program sometimes happens +to generate this combination this is fine, but if it is easy to avoid +starting an io watcher watching for no events you should do so. +.IP "ev_io_modify (ev_io *, int events)" 4 +.IX Item "ev_io_modify (ev_io *, int events)" +Similar to \f(CW\*(C`ev_io_set\*(C'\fR, but only changes the requested events. Using this +might be faster with some backends, as libev can assume that the \f(CW\*(C`fd\*(C'\fR +still refers to the same underlying file description, something it cannot +do when using \f(CW\*(C`ev_io_set\*(C'\fR. +.IP "int fd [no\-modify]" 4 +.IX Item "int fd [no-modify]" +The file descriptor being watched. While it can be read at any time, you +must not modify this member even when the watcher is stopped \- always use +\&\f(CW\*(C`ev_io_set\*(C'\fR for that. +.IP "int events [no\-modify]" 4 +.IX Item "int events [no-modify]" +The set of events the fd is being watched for, among other flags. Remember +that this is a bit set \- to test for \f(CW\*(C`EV_READ\*(C'\fR, use \f(CW\*(C`w\->events & +EV_READ\*(C'\fR, and similarly for \f(CW\*(C`EV_WRITE\*(C'\fR. +.Sp +As with \f(CW\*(C`fd\*(C'\fR, you must not modify this member even when the watcher is +stopped, always use \f(CW\*(C`ev_io_set\*(C'\fR or \f(CW\*(C`ev_io_modify\*(C'\fR for that. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well +readable, but only once. Since it is likely line-buffered, you could +attempt to read a whole line in the callback. +.PP +.Vb 6 +\& static void +\& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents) +\& { +\& ev_io_stop (loop, w); +\& .. read from stdin here (or from w\->fd) and handle any I/O errors +\& } +\& +\& ... +\& struct ev_loop *loop = ev_default_init (0); +\& ev_io stdin_readable; +\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); +\& ev_io_start (loop, &stdin_readable); +\& ev_run (loop, 0); +.Ve +.ie n .SS """ev_timer"" \- relative and optionally repeating timeouts" +.el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts" +.IX Subsection "ev_timer - relative and optionally repeating timeouts" +Timer watchers are simple relative timers that generate an event after a +given time, and optionally repeating in regular intervals after that. +.PP +The timers are based on real time, that is, if you register an event that +times out after an hour and you reset your system clock to January last +year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because +detecting time jumps is hard, and some inaccuracies are unavoidable (the +monotonic clock option helps a lot here). +.PP +The callback is guaranteed to be invoked only \fIafter\fR its timeout has +passed (not \fIat\fR, so on systems with very low-resolution clocks this +might introduce a small delay, see \*(L"the special problem of being too +early\*(R", below). If multiple timers become ready during the same loop +iteration then the ones with earlier time-out values are invoked before +ones of the same priority with later time-out values (but this is no +longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). +.PP +\fIBe smart about timeouts\fR +.IX Subsection "Be smart about timeouts" +.PP +Many real-world problems involve some kind of timeout, usually for error +recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs, +you want to raise some error after a while. +.PP +What follows are some ways to handle this problem, from obvious and +inefficient to smart and efficient. +.PP +In the following, a 60 second activity timeout is assumed \- a timeout that +gets reset to 60 seconds each time there is activity (e.g. each time some +data or other life sign was received). +.IP "1. Use a timer and stop, reinitialise and start it on activity." 4 +.IX Item "1. Use a timer and stop, reinitialise and start it on activity." +This is the most obvious, but not the most simple way: In the beginning, +start the watcher: +.Sp +.Vb 2 +\& ev_timer_init (timer, callback, 60., 0.); +\& ev_timer_start (loop, timer); +.Ve +.Sp +Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it +and start it again: +.Sp +.Vb 3 +\& ev_timer_stop (loop, timer); +\& ev_timer_set (timer, 60., 0.); +\& ev_timer_start (loop, timer); +.Ve +.Sp +This is relatively simple to implement, but means that each time there is +some activity, libev will first have to remove the timer from its internal +data structure and then add it again. Libev tries to be fast, but it's +still not a constant-time operation. +.ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4 +.el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4 +.IX Item "2. Use a timer and re-start it with ev_timer_again inactivity." +This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of +\&\f(CW\*(C`ev_timer_start\*(C'\fR. +.Sp +To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value +of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you +successfully read or write some data. If you go into an idle state where +you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR +the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be. +.Sp +That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the +\&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR +member and \f(CW\*(C`ev_timer_again\*(C'\fR. +.Sp +At start: +.Sp +.Vb 3 +\& ev_init (timer, callback); +\& timer\->repeat = 60.; +\& ev_timer_again (loop, timer); +.Ve +.Sp +Each time there is some activity: +.Sp +.Vb 1 +\& ev_timer_again (loop, timer); +.Ve +.Sp +It is even possible to change the time-out on the fly, regardless of +whether the watcher is active or not: +.Sp +.Vb 2 +\& timer\->repeat = 30.; +\& ev_timer_again (loop, timer); +.Ve +.Sp +This is slightly more efficient then stopping/starting the timer each time +you want to modify its timeout value, as libev does not have to completely +remove and re-insert the timer from/into its internal data structure. +.Sp +It is, however, even simpler than the \*(L"obvious\*(R" way to do it. +.IP "3. Let the timer time out, but then re-arm it as required." 4 +.IX Item "3. Let the timer time out, but then re-arm it as required." +This method is more tricky, but usually most efficient: Most timeouts are +relatively long compared to the intervals between other activity \- in +our example, within 60 seconds, there are usually many I/O events with +associated activity resets. +.Sp +In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, +but remember the time of last activity, and check for a real timeout only +within the callback: +.Sp +.Vb 3 +\& ev_tstamp timeout = 60.; +\& ev_tstamp last_activity; // time of last activity +\& ev_timer timer; +\& +\& static void +\& callback (EV_P_ ev_timer *w, int revents) +\& { +\& // calculate when the timeout would happen +\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout; +\& +\& // if negative, it means we the timeout already occurred +\& if (after < 0.) +\& { +\& // timeout occurred, take action +\& } +\& else +\& { +\& // callback was invoked, but there was some recent +\& // activity. simply restart the timer to time out +\& // after "after" seconds, which is the earliest time +\& // the timeout can occur. +\& ev_timer_set (w, after, 0.); +\& ev_timer_start (EV_A_ w); +\& } +\& } +.Ve +.Sp +To summarise the callback: first calculate in how many seconds the +timeout will occur (by calculating the absolute time when it would occur, +\&\f(CW\*(C`last_activity + timeout\*(C'\fR, and subtracting the current time, \f(CW\*(C`ev_now +(EV_A)\*(C'\fR from that). +.Sp +If this value is negative, then we are already past the timeout, i.e. we +timed out, and need to do whatever is needed in this case. +.Sp +Otherwise, we now the earliest time at which the timeout would trigger, +and simply start the timer with this timeout value. +.Sp +In other words, each time the callback is invoked it will check whether +the timeout occurred. If not, it will simply reschedule itself to check +again at the earliest time it could time out. Rinse. Repeat. +.Sp +This scheme causes more callback invocations (about one every 60 seconds +minus half the average time between activity), but virtually no calls to +libev to change the timeout. +.Sp +To start the machinery, simply initialise the watcher and set +\&\f(CW\*(C`last_activity\*(C'\fR to the current time (meaning there was some activity just +now), then call the callback, which will \*(L"do the right thing\*(R" and start +the timer: +.Sp +.Vb 3 +\& last_activity = ev_now (EV_A); +\& ev_init (&timer, callback); +\& callback (EV_A_ &timer, 0); +.Ve +.Sp +When there is some activity, simply store the current time in +\&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: +.Sp +.Vb 2 +\& if (activity detected) +\& last_activity = ev_now (EV_A); +.Ve +.Sp +When your timeout value changes, then the timeout can be changed by simply +providing a new value, stopping the timer and calling the callback, which +will again do the right thing (for example, time out immediately :). +.Sp +.Vb 3 +\& timeout = new_value; +\& ev_timer_stop (EV_A_ &timer); +\& callback (EV_A_ &timer, 0); +.Ve +.Sp +This technique is slightly more complex, but in most cases where the +time-out is unlikely to be triggered, much more efficient. +.IP "4. Wee, just use a double-linked list for your timeouts." 4 +.IX Item "4. Wee, just use a double-linked list for your timeouts." +If there is not one request, but many thousands (millions...), all +employing some kind of timeout with the same timeout value, then one can +do even better: +.Sp +When starting the timeout, calculate the timeout value and put the timeout +at the \fIend\fR of the list. +.Sp +Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of +the list is expected to fire (for example, using the technique #3). +.Sp +When there is some activity, remove the timer from the list, recalculate +the timeout, append it to the end of the list again, and make sure to +update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list. +.Sp +This way, one can manage an unlimited number of timeouts in O(1) time for +starting, stopping and updating the timers, at the expense of a major +complication, and having to use a constant timeout. The constant timeout +ensures that the list stays sorted. +.PP +So which method the best? +.PP +Method #2 is a simple no-brain-required solution that is adequate in most +situations. Method #3 requires a bit more thinking, but handles many cases +better, and isn't very complicated either. In most case, choosing either +one is fine, with #3 being better in typical situations. +.PP +Method #1 is almost always a bad idea, and buys you nothing. Method #4 is +rather complicated, but extremely efficient, something that really pays +off after the first million or so of active timers, i.e. it's usually +overkill :) +.PP +\fIThe special problem of being too early\fR +.IX Subsection "The special problem of being too early" +.PP +If you ask a timer to call your callback after three seconds, then +you expect it to be invoked after three seconds \- but of course, this +cannot be guaranteed to infinite precision. Less obviously, it cannot be +guaranteed to any precision by libev \- imagine somebody suspending the +process with a \s-1STOP\s0 signal for a few hours for example. +.PP +So, libev tries to invoke your callback as soon as possible \fIafter\fR the +delay has occurred, but cannot guarantee this. +.PP +A less obvious failure mode is calling your callback too early: many event +loops compare timestamps with a \*(L"elapsed delay >= requested delay\*(R", but +this can cause your callback to be invoked much earlier than you would +expect. +.PP +To see why, imagine a system with a clock that only offers full second +resolution (think windows if you can't come up with a broken enough \s-1OS\s0 +yourself). If you schedule a one-second timer at the time 500.9, then the +event loop will schedule your timeout to elapse at a system time of 500 +(500.9 truncated to the resolution) + 1, or 501. +.PP +If an event library looks at the timeout 0.1s later, it will see \*(L"501 >= +501\*(R" and invoke the callback 0.1s after it was started, even though a +one-second delay was requested \- this is being \*(L"too early\*(R", despite best +intentions. +.PP +This is the reason why libev will never invoke the callback if the elapsed +delay equals the requested delay, but only when the elapsed delay is +larger than the requested delay. In the example above, libev would only invoke +the callback at system time 502, or 1.1s after the timer was started. +.PP +So, while libev cannot guarantee that your callback will be invoked +exactly when requested, it \fIcan\fR and \fIdoes\fR guarantee that the requested +delay has actually elapsed, or in other words, it always errs on the \*(L"too +late\*(R" side of things. +.PP +\fIThe special problem of time updates\fR +.IX Subsection "The special problem of time updates" +.PP +Establishing the current time is a costly operation (it usually takes +at least one system call): \s-1EV\s0 therefore updates its idea of the current +time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a +growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling +lots of events in one iteration. +.PP +The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR +time. This is usually the right thing as this timestamp refers to the time +of the event triggering whatever timeout you are modifying/starting. If +you suspect event processing to be delayed and you \fIneed\fR to base the +timeout on the current time, use something like the following to adjust +for it: +.PP +.Vb 1 +\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.); +.Ve +.PP +If the event loop is suspended for a long time, you can also force an +update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update +()\*(C'\fR, although that will push the event time of all outstanding events +further into the future. +.PP +\fIThe special problem of unsynchronised clocks\fR +.IX Subsection "The special problem of unsynchronised clocks" +.PP +Modern systems have a variety of clocks \- libev itself uses the normal +\&\*(L"wall clock\*(R" clock and, if available, the monotonic clock (to avoid time +jumps). +.PP +Neither of these clocks is synchronised with each other or any other clock +on the system, so \f(CW\*(C`ev_time ()\*(C'\fR might return a considerably different time +than \f(CW\*(C`gettimeofday ()\*(C'\fR or \f(CW\*(C`time ()\*(C'\fR. On a GNU/Linux system, for example, +a call to \f(CW\*(C`gettimeofday\*(C'\fR might return a second count that is one higher +than a directly following call to \f(CW\*(C`time\*(C'\fR. +.PP +The moral of this is to only compare libev-related timestamps with +\&\f(CW\*(C`ev_time ()\*(C'\fR and \f(CW\*(C`ev_now ()\*(C'\fR, at least if you want better precision than +a second or so. +.PP +One more problem arises due to this lack of synchronisation: if libev uses +the system monotonic clock and you compare timestamps from \f(CW\*(C`ev_time\*(C'\fR +or \f(CW\*(C`ev_now\*(C'\fR from when you started your timer and when your callback is +invoked, you will find that sometimes the callback is a bit \*(L"early\*(R". +.PP +This is because \f(CW\*(C`ev_timer\*(C'\fRs work in real time, not wall clock time, so +libev makes sure your callback is not invoked before the delay happened, +\&\fImeasured according to the real time\fR, not the system clock. +.PP +If your timeouts are based on a physical timescale (e.g. \*(L"time out this +connection after 100 seconds\*(R") then this shouldn't bother you as it is +exactly the right behaviour. +.PP +If you want to compare wall clock/system timestamps to your timers, then +you need to use \f(CW\*(C`ev_periodic\*(C'\fRs, as these are based on the wall clock +time, where your comparisons will always generate correct results. +.PP +\fIThe special problems of suspended animation\fR +.IX Subsection "The special problems of suspended animation" +.PP +When you leave the server world it is quite customary to hit machines that +can suspend/hibernate \- what happens to the clocks during such a suspend? +.PP +Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes +all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue +to run until the system is suspended, but they will not advance while the +system is suspended. That means, on resume, it will be as if the program +was frozen for a few seconds, but the suspend time will not be counted +towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time +clock advanced as expected, but if it is used as sole clocksource, then a +long suspend would be detected as a time jump by libev, and timers would +be adjusted accordingly. +.PP +I would not be surprised to see different behaviour in different between +operating systems, \s-1OS\s0 versions or even different hardware. +.PP +The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a +time jump in the monotonic clocks and the realtime clock. If the program +is suspended for a very long time, and monotonic clock sources are in use, +then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time +will be counted towards the timers. When no monotonic clock source is in +use, then libev will again assume a timejump and adjust accordingly. +.PP +It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR +and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get +deterministic behaviour in this case (you can do nothing against +\&\f(CW\*(C`SIGSTOP\*(C'\fR). +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 +.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" +.PD 0 +.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 +.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" +.PD +Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and +negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will +automatically be stopped once the timeout is reached. If it is positive, +then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR +seconds later, again, and again, until stopped manually. +.Sp +The timer itself will do a best-effort at avoiding drift, that is, if +you configure a timer to trigger every 10 seconds, then it will normally +trigger at exactly 10 second intervals. If, however, your program cannot +keep up with the timer (because it takes longer than those 10 seconds to +do stuff) the timer will not fire more than once per event loop iteration. +.IP "ev_timer_again (loop, ev_timer *)" 4 +.IX Item "ev_timer_again (loop, ev_timer *)" +This will act as if the timer timed out, and restarts it again if it is +repeating. It basically works like calling \f(CW\*(C`ev_timer_stop\*(C'\fR, updating the +timeout to the \f(CW\*(C`repeat\*(C'\fR value and calling \f(CW\*(C`ev_timer_start\*(C'\fR. +.Sp +The exact semantics are as in the following rules, all of which will be +applied to the watcher: +.RS 4 +.IP "If the timer is pending, the pending status is always cleared." 4 +.IX Item "If the timer is pending, the pending status is always cleared." +.PD 0 +.IP "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." 4 +.IX Item "If the timer is started but non-repeating, stop it (as if it timed out, without invoking it)." +.ie n .IP "If the timer is repeating, make the ""repeat"" value the new timeout and start the timer, if necessary." 4 +.el .IP "If the timer is repeating, make the \f(CWrepeat\fR value the new timeout and start the timer, if necessary." 4 +.IX Item "If the timer is repeating, make the repeat value the new timeout and start the timer, if necessary." +.RE +.RS 4 +.PD +.Sp +This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a +usage example. +.RE +.IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 +.IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" +Returns the remaining time until a timer fires. If the timer is active, +then this time is relative to the current event loop time, otherwise it's +the timeout value currently configured. +.Sp +That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns +\&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR +will return \f(CW4\fR. When the timer expires and is restarted, it will return +roughly \f(CW7\fR (likely slightly less as callback invocation takes some time, +too), and so on. +.IP "ev_tstamp repeat [read\-write]" 4 +.IX Item "ev_tstamp repeat [read-write]" +The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out +or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any), +which is also when any modifications are taken into account. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Create a timer that fires after 60 seconds. +.PP +.Vb 5 +\& static void +\& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents) +\& { +\& .. one minute over, w is actually stopped right here +\& } +\& +\& ev_timer mytimer; +\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); +\& ev_timer_start (loop, &mytimer); +.Ve +.PP +Example: Create a timeout timer that times out after 10 seconds of +inactivity. +.PP +.Vb 5 +\& static void +\& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents) +\& { +\& .. ten seconds without any activity +\& } +\& +\& ev_timer mytimer; +\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ +\& ev_timer_again (&mytimer); /* start timer */ +\& ev_run (loop, 0); +\& +\& // and in some piece of code that gets executed on any "activity": +\& // reset the timeout to start ticking again at 10 seconds +\& ev_timer_again (&mytimer); +.Ve +.ie n .SS """ev_periodic"" \- to cron or not to cron?" +.el .SS "\f(CWev_periodic\fP \- to cron or not to cron?" +.IX Subsection "ev_periodic - to cron or not to cron?" +Periodic watchers are also timers of a kind, but they are very versatile +(and unfortunately a bit complex). +.PP +Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or +relative time, the physical time that passes) but on wall clock time +(absolute time, the thing you can read on your calendar or clock). The +difference is that wall clock time can run faster or slower than real +time, and time jumps are not uncommon (e.g. when you adjust your +wrist-watch). +.PP +You can tell a periodic watcher to trigger after some specific point +in time: for example, if you tell a periodic watcher to trigger \*(L"in 10 +seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time +not a delay) and then reset your system clock to January of the previous +year, then it will take a year or more to trigger the event (unlike an +\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting +it, as it uses a relative timeout). +.PP +\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex +timers, such as triggering an event on each \*(L"midnight, local time\*(R", or +other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR +watchers, as those cannot react to time jumps. +.PP +As with timers, the callback is guaranteed to be invoked only when the +point in time where it is supposed to trigger has passed. If multiple +timers become ready during the same loop iteration then the ones with +earlier time-out values are invoked before ones with later time-out values +(but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4 +.IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" +.PD 0 +.IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4 +.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" +.PD +Lots of arguments, let's sort it out... There are basically three modes of +operation, and we will explain them from simplest to most complex: +.RS 4 +.IP "\(bu" 4 +absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0) +.Sp +In this configuration the watcher triggers an event after the wall clock +time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a +time jump occurs, that is, if it is to be run at January 1st 2011 then it +will be stopped and invoked when the system clock reaches or surpasses +this point in time. +.IP "\(bu" 4 +repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0) +.Sp +In this mode the watcher will always be scheduled to time out at the next +\&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be +negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR +argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods. +.Sp +This can be used to create timers that do not drift with respect to the +system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each +hour, on the hour (with respect to \s-1UTC\s0): +.Sp +.Vb 1 +\& ev_periodic_set (&periodic, 0., 3600., 0); +.Ve +.Sp +This doesn't mean there will always be 3600 seconds in between triggers, +but only that the callback will be called when the system time shows a +full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible +by 3600. +.Sp +Another way to think about it (for the mathematically inclined) is that +\&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible +time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. +.Sp +The \f(CW\*(C`interval\*(C'\fR \fI\s-1MUST\s0\fR be positive, and for numerical stability, the +interval value should be higher than \f(CW\*(C`1/8192\*(C'\fR (which is around 100 +microseconds) and \f(CW\*(C`offset\*(C'\fR should be higher than \f(CW0\fR and should have +at most a similar magnitude as the current time (say, within a factor of +ten). Typical values for offset are, in fact, \f(CW0\fR or something between +\&\f(CW0\fR and \f(CW\*(C`interval\*(C'\fR, which is also the recommended range. +.Sp +Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 +speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability +will of course deteriorate. Libev itself tries to be exact to be about one +millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). +.IP "\(bu" 4 +manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback) +.Sp +In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being +ignored. Instead, each time the periodic watcher gets scheduled, the +reschedule callback will be called with the watcher as first, and the +current time as second argument. +.Sp +\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever, +or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly +allowed by documentation here\fR. +.Sp +If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop +it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the +only event loop modification you are allowed to do). +.Sp +The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic +*w, ev_tstamp now)\*(C'\fR, e.g.: +.Sp +.Vb 5 +\& static ev_tstamp +\& my_rescheduler (ev_periodic *w, ev_tstamp now) +\& { +\& return now + 60.; +\& } +.Ve +.Sp +It must return the next time to trigger, based on the passed time value +(that is, the lowest time value larger than to the second argument). It +will usually be called just before the callback will be triggered, but +might be called at other times, too. +.Sp +\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or +equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. +.Sp +This can be used to create very complex timers, such as a timer that +triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate +the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for +this. Here is a (completely untested, no error checking) example on how to +do this: +.Sp +.Vb 1 +\& #include +\& +\& static ev_tstamp +\& my_rescheduler (ev_periodic *w, ev_tstamp now) +\& { +\& time_t tnow = (time_t)now; +\& struct tm tm; +\& localtime_r (&tnow, &tm); +\& +\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day +\& ++tm.tm_mday; // midnight next day +\& +\& return mktime (&tm); +\& } +.Ve +.Sp +Note: this code might run into trouble on days that have more then two +midnights (beginning and end). +.RE +.RS 4 +.RE +.IP "ev_periodic_again (loop, ev_periodic *)" 4 +.IX Item "ev_periodic_again (loop, ev_periodic *)" +Simply stops and restarts the periodic watcher again. This is only useful +when you changed some parameters or the reschedule callback would return +a different time than the last time it was called (e.g. in a crond like +program when the crontabs have changed). +.IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 +.IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" +When active, returns the absolute time that the watcher is supposed +to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to +\&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual +rescheduling modes. +.IP "ev_tstamp offset [read\-write]" 4 +.IX Item "ev_tstamp offset [read-write]" +When repeating, this contains the offset value, otherwise this is the +absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR, +although libev might modify this value for better numerical stability). +.Sp +Can be modified any time, but changes only take effect when the periodic +timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. +.IP "ev_tstamp interval [read\-write]" 4 +.IX Item "ev_tstamp interval [read-write]" +The current interval value. Can be modified any time, but changes only +take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being +called. +.IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4 +.IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]" +The current reschedule callback, or \f(CW0\fR, if this functionality is +switched off. Can be changed any time, but changes only take effect when +the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Call a callback every hour, or, more precisely, whenever the +system time is divisible by 3600. The callback invocation times have +potentially a lot of jitter, but good long-term stability. +.PP +.Vb 5 +\& static void +\& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents) +\& { +\& ... its now a full hour (UTC, or TAI or whatever your clock follows) +\& } +\& +\& ev_periodic hourly_tick; +\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); +\& ev_periodic_start (loop, &hourly_tick); +.Ve +.PP +Example: The same as above, but use a reschedule callback to do it: +.PP +.Vb 1 +\& #include +\& +\& static ev_tstamp +\& my_scheduler_cb (ev_periodic *w, ev_tstamp now) +\& { +\& return now + (3600. \- fmod (now, 3600.)); +\& } +\& +\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); +.Ve +.PP +Example: Call a callback every hour, starting now: +.PP +.Vb 4 +\& ev_periodic hourly_tick; +\& ev_periodic_init (&hourly_tick, clock_cb, +\& fmod (ev_now (loop), 3600.), 3600., 0); +\& ev_periodic_start (loop, &hourly_tick); +.Ve +.ie n .SS """ev_signal"" \- signal me when a signal gets signalled!" +.el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!" +.IX Subsection "ev_signal - signal me when a signal gets signalled!" +Signal watchers will trigger an event when the process receives a specific +signal one or more times. Even though signals are very asynchronous, libev +will try its best to deliver signals synchronously, i.e. as part of the +normal event processing, like any other event. +.PP +If you want signals to be delivered truly asynchronously, just use +\&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing +the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to +synchronously wake up an event loop. +.PP +You can configure as many watchers as you like for the same signal, but +only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your +default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for +\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At +the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. +.PP +Only after the first watcher for a signal is started will libev actually +register something with the kernel. It thus coexists with your own signal +handlers as long as you don't register any with libev for the same signal. +.PP +If possible and supported, libev will install its handlers with +\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should +not be unduly interrupted. If you have a problem with system calls getting +interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher +and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. +.PP +\fIThe special problem of inheritance over fork/execve/pthread_create\fR +.IX Subsection "The special problem of inheritance over fork/execve/pthread_create" +.PP +Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition +(\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after +stopping it again), that is, libev might or might not block the signal, +and might or might not set or restore the installed signal handler (but +see \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR). +.PP +While this does not matter for the signal disposition (libev never +sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on +\&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect +certain signals to be blocked. +.PP +This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset +the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good +choice usually). +.PP +The simplest way to ensure that the signal mask is reset in the child is +to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will +catch fork calls done by libraries (such as the libc) as well. +.PP +In current versions of libev, the signal will not be blocked indefinitely +unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces +the window of opportunity for problems, it will not go away, as libev +\&\fIhas\fR to modify the signal mask, at least temporarily. +.PP +So I can't stress this enough: \fIIf you do not reset your signal mask when +you expect it to be empty, you have a race condition in your code\fR. This +is not a libev-specific thing, this is true for most event libraries. +.PP +\fIThe special problem of threads signal handling\fR +.IX Subsection "The special problem of threads signal handling" +.PP +\&\s-1POSIX\s0 threads has problematic signal handling semantics, specifically, +a lot of functionality (sigfd, sigwait etc.) only really works if all +threads in a process block signals, which is hard to achieve. +.PP +When you want to use sigwait (or mix libev signal handling with your own +for the same signals), you can tackle this problem by globally blocking +all signals before creating any threads (or creating them with a fully set +sigprocmask) and also specifying the \f(CW\*(C`EVFLAG_NOSIGMASK\*(C'\fR when creating +loops. Then designate one thread as \*(L"signal receiver thread\*(R" which handles +these signals. You can pass on any signals that libev might be interested +in by calling \f(CW\*(C`ev_feed_signal\*(C'\fR. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 +.IX Item "ev_signal_init (ev_signal *, callback, int signum)" +.PD 0 +.IP "ev_signal_set (ev_signal *, int signum)" 4 +.IX Item "ev_signal_set (ev_signal *, int signum)" +.PD +Configures the watcher to trigger on the given signal number (usually one +of the \f(CW\*(C`SIGxxx\*(C'\fR constants). +.IP "int signum [read\-only]" 4 +.IX Item "int signum [read-only]" +The signal the watcher watches out for. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Try to exit cleanly on \s-1SIGINT.\s0 +.PP +.Vb 5 +\& static void +\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) +\& { +\& ev_break (loop, EVBREAK_ALL); +\& } +\& +\& ev_signal signal_watcher; +\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); +\& ev_signal_start (loop, &signal_watcher); +.Ve +.ie n .SS """ev_child"" \- watch out for process status changes" +.el .SS "\f(CWev_child\fP \- watch out for process status changes" +.IX Subsection "ev_child - watch out for process status changes" +Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to +some child status changes (most typically when a child of yours dies or +exits). It is permissible to install a child watcher \fIafter\fR the child +has been forked (which implies it might have already exited), as long +as the event loop isn't entered (or is continued from a watcher), i.e., +forking and then immediately registering a watcher for the child is fine, +but forking and registering a watcher a few event loop iterations later or +in the next callback invocation is not. +.PP +Only the default event loop is capable of handling signals, and therefore +you can only register child watchers in the default event loop. +.PP +Due to some design glitches inside libev, child watchers will always be +handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by +libev) +.PP +\fIProcess Interaction\fR +.IX Subsection "Process Interaction" +.PP +Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is +initialised. This is necessary to guarantee proper behaviour even if the +first child watcher is started after the child exits. The occurrence +of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done +synchronously as part of the event loop processing. Libev always reaps all +children, even ones not watched. +.PP +\fIOverriding the Built-In Processing\fR +.IX Subsection "Overriding the Built-In Processing" +.PP +Libev offers no special support for overriding the built-in child +processing, but if your application collides with libev's default child +handler, you can override it easily by installing your own handler for +\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the +default loop never gets destroyed. You are encouraged, however, to use an +event-based approach to child reaping and thus use libev's support for +that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely. +.PP +\fIStopping the Child Watcher\fR +.IX Subsection "Stopping the Child Watcher" +.PP +Currently, the child watcher never gets stopped, even when the +child terminates, so normally one needs to stop the watcher in the +callback. Future versions of libev might stop the watcher automatically +when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a +problem). +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 +.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" +.PD 0 +.IP "ev_child_set (ev_child *, int pid, int trace)" 4 +.IX Item "ev_child_set (ev_child *, int pid, int trace)" +.PD +Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or +\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look +at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see +the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems +\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the +process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only +activate the watcher when the process terminates) or \f(CW1\fR (additionally +activate the watcher when the process is stopped or continued). +.IP "int pid [read\-only]" 4 +.IX Item "int pid [read-only]" +The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. +.IP "int rpid [read\-write]" 4 +.IX Item "int rpid [read-write]" +The process id that detected a status change. +.IP "int rstatus [read\-write]" 4 +.IX Item "int rstatus [read-write]" +The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems +\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for +its completion. +.PP +.Vb 1 +\& ev_child cw; +\& +\& static void +\& child_cb (EV_P_ ev_child *w, int revents) +\& { +\& ev_child_stop (EV_A_ w); +\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); +\& } +\& +\& pid_t pid = fork (); +\& +\& if (pid < 0) +\& // error +\& else if (pid == 0) +\& { +\& // the forked child executes here +\& exit (1); +\& } +\& else +\& { +\& ev_child_init (&cw, child_cb, pid, 0); +\& ev_child_start (EV_DEFAULT_ &cw); +\& } +.Ve +.ie n .SS """ev_stat"" \- did the file attributes just change?" +.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" +.IX Subsection "ev_stat - did the file attributes just change?" +This watches a file system path for attribute changes. That is, it calls +\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) +and sees if it changed compared to the last time, invoking the callback +if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that +happen after the watcher has been started will be reported. +.PP +The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does +not exist\*(R" is a status change like any other. The condition \*(L"path does not +exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the +\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at +least one) and all the other fields of the stat buffer having unspecified +contents. +.PP +The path \fImust not\fR end in a slash or contain special components such as +\&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and +your working directory changes, then the behaviour is undefined. +.PP +Since there is no portable change notification interface available, the +portable implementation simply calls \f(CWstat(2)\fR regularly on the path +to see if it changed somehow. You can specify a recommended polling +interval for this case. If you specify a polling interval of \f(CW0\fR (highly +recommended!) then a \fIsuitable, unspecified default\fR value will be used +(which you can expect to be around five seconds, although this might +change dynamically). Libev will also impose a minimum interval which is +currently around \f(CW0.1\fR, but that's usually overkill. +.PP +This watcher type is not meant for massive numbers of stat watchers, +as even with OS-supported change notifications, this can be +resource-intensive. +.PP +At the time of this writing, the only OS-specific interface implemented +is the Linux inotify interface (implementing kqueue support is left as an +exercise for the reader. Note, however, that the author sees no way of +implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint). +.PP +\fI\s-1ABI\s0 Issues (Largefile Support)\fR +.IX Subsection "ABI Issues (Largefile Support)" +.PP +Libev by default (unless the user overrides this) uses the default +compilation environment, which means that on systems with large file +support disabled by default, you get the 32 bit version of the stat +structure. When using the library from programs that change the \s-1ABI\s0 to +use 64 bit file offsets the programs will fail. In that case you have to +compile libev with the same flags to get binary compatibility. This is +obviously the case with any flags that change the \s-1ABI,\s0 but the problem is +most noticeably displayed with ev_stat and large file support. +.PP +The solution for this is to lobby your distribution maker to make large +file interfaces available by default (as e.g. FreeBSD does) and not +optional. Libev cannot simply switch on large file support because it has +to exchange stat structures with application programs compiled using the +default compilation environment. +.PP +\fIInotify and Kqueue\fR +.IX Subsection "Inotify and Kqueue" +.PP +When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at +runtime, it will be used to speed up change detection where possible. The +inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR +watcher is being started. +.PP +Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers +except that changes might be detected earlier, and in some cases, to avoid +making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support +there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling, +but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too +many bugs), the path exists (i.e. stat succeeds), and the path resides on +a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and +xfs are fully working) libev usually gets away without polling. +.PP +There is no support for kqueue, as apparently it cannot be used to +implement this functionality, due to the requirement of having a file +descriptor open on the object at all times, and detecting renames, unlinks +etc. is difficult. +.PP +\fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR +.IX Subsection "stat () is a synchronous operation" +.PP +Libev doesn't normally do any kind of I/O itself, and so is not blocking +the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat +()\*(C'\fR, which is a synchronous operation. +.PP +For local paths, this usually doesn't matter: unless the system is very +busy or the intervals between stat's are large, a stat call will be fast, +as the path data is usually in memory already (except when starting the +watcher). +.PP +For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite +time due to network issues, and even under good conditions, a stat call +often takes multiple milliseconds. +.PP +Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked +paths, although this is fully supported by libev. +.PP +\fIThe special problem of stat time resolution\fR +.IX Subsection "The special problem of stat time resolution" +.PP +The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably, +and even on systems where the resolution is higher, most file systems +still only support whole seconds. +.PP +That means that, if the time is the only thing that changes, you can +easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and +calls your callback, which does something. When there is another update +within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the +stat data does change in other ways (e.g. file size). +.PP +The solution to this is to delay acting on a change for slightly more +than a second (or till slightly after the next full second boundary), using +a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02); +ev_timer_again (loop, w)\*(C'\fR). +.PP +The \f(CW.02\fR offset is added to work around small timing inconsistencies +of some operating systems (where the second counter of the current time +might be be delayed. One such system is the Linux kernel, where a call to +\&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than +a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to +update file times then there will be a small window where the kernel uses +the previous second to update file times but libev might already execute +the timer callback). +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 +.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" +.PD 0 +.IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 +.IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" +.PD +Configures the watcher to wait for status changes of the given +\&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to +be detected and should normally be specified as \f(CW0\fR to let libev choose +a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same +path for as long as the watcher is active. +.Sp +The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected, +relative to the attributes at the time the watcher was started (or the +last change was detected). +.IP "ev_stat_stat (loop, ev_stat *)" 4 +.IX Item "ev_stat_stat (loop, ev_stat *)" +Updates the stat buffer immediately with new values. If you change the +watched path in your callback, you could call this function to avoid +detecting this change (while introducing a race condition if you are not +the only one changing the path). Can also be useful simply to find out the +new values. +.IP "ev_statdata attr [read\-only]" 4 +.IX Item "ev_statdata attr [read-only]" +The most-recently detected attributes of the file. Although the type is +\&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types +suitable for your system, but you can only rely on the POSIX-standardised +members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was +some error while \f(CW\*(C`stat\*(C'\fRing the file. +.IP "ev_statdata prev [read\-only]" 4 +.IX Item "ev_statdata prev [read-only]" +The previous attributes of the file. The callback gets invoked whenever +\&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members +differ: \f(CW\*(C`st_dev\*(C'\fR, \f(CW\*(C`st_ino\*(C'\fR, \f(CW\*(C`st_mode\*(C'\fR, \f(CW\*(C`st_nlink\*(C'\fR, \f(CW\*(C`st_uid\*(C'\fR, +\&\f(CW\*(C`st_gid\*(C'\fR, \f(CW\*(C`st_rdev\*(C'\fR, \f(CW\*(C`st_size\*(C'\fR, \f(CW\*(C`st_atime\*(C'\fR, \f(CW\*(C`st_mtime\*(C'\fR, \f(CW\*(C`st_ctime\*(C'\fR. +.IP "ev_tstamp interval [read\-only]" 4 +.IX Item "ev_tstamp interval [read-only]" +The specified interval. +.IP "const char *path [read\-only]" 4 +.IX Item "const char *path [read-only]" +The file system path that is being watched. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. +.PP +.Vb 10 +\& static void +\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) +\& { +\& /* /etc/passwd changed in some way */ +\& if (w\->attr.st_nlink) +\& { +\& printf ("passwd current size %ld\en", (long)w\->attr.st_size); +\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime); +\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime); +\& } +\& else +\& /* you shalt not abuse printf for puts */ +\& puts ("wow, /etc/passwd is not there, expect problems. " +\& "if this is windows, they already arrived\en"); +\& } +\& +\& ... +\& ev_stat passwd; +\& +\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); +\& ev_stat_start (loop, &passwd); +.Ve +.PP +Example: Like above, but additionally use a one-second delay so we do not +miss updates (however, frequent updates will delay processing, too, so +one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on +\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). +.PP +.Vb 2 +\& static ev_stat passwd; +\& static ev_timer timer; +\& +\& static void +\& timer_cb (EV_P_ ev_timer *w, int revents) +\& { +\& ev_timer_stop (EV_A_ w); +\& +\& /* now it\*(Aqs one second after the most recent passwd change */ +\& } +\& +\& static void +\& stat_cb (EV_P_ ev_stat *w, int revents) +\& { +\& /* reset the one\-second timer */ +\& ev_timer_again (EV_A_ &timer); +\& } +\& +\& ... +\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); +\& ev_stat_start (loop, &passwd); +\& ev_timer_init (&timer, timer_cb, 0., 1.02); +.Ve +.ie n .SS """ev_idle"" \- when you've got nothing better to do..." +.el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..." +.IX Subsection "ev_idle - when you've got nothing better to do..." +Idle watchers trigger events when no other events of the same or higher +priority are pending (prepare, check and other idle watchers do not count +as receiving \*(L"events\*(R"). +.PP +That is, as long as your process is busy handling sockets or timeouts +(or even signals, imagine) of the same or higher priority it will not be +triggered. But when your process is idle (or only lower-priority watchers +are pending), the idle watchers are being called once per event loop +iteration \- until stopped, that is, or your process receives more events +and becomes busy again with higher priority stuff. +.PP +The most noteworthy effect is that as long as any idle watchers are +active, the process will not block when waiting for new events. +.PP +Apart from keeping your process non-blocking (which is a useful +effect on its own sometimes), idle watchers are a good place to do +\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the +event loop has handled all outstanding events. +.PP +\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR +.IX Subsection "Abusing an ev_idle watcher for its side-effect" +.PP +As long as there is at least one active idle watcher, libev will never +sleep unnecessarily. Or in other words, it will loop as fast as possible. +For this to work, the idle watcher doesn't need to be invoked at all \- the +lowest priority will do. +.PP +This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher, +to do something on each event loop iteration \- for example to balance load +between different connections. +.PP +See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer +example. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_idle_init (ev_idle *, callback)" 4 +.IX Item "ev_idle_init (ev_idle *, callback)" +Initialises and configures the idle watcher \- it has no parameters of any +kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, +believe me. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the +callback, free it. Also, use no error checking, as usual. +.PP +.Vb 5 +\& static void +\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) +\& { +\& // stop the watcher +\& ev_idle_stop (loop, w); +\& +\& // now we can free it +\& free (w); +\& +\& // now do something you wanted to do when the program has +\& // no longer anything immediate to do. +\& } +\& +\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); +\& ev_idle_init (idle_watcher, idle_cb); +\& ev_idle_start (loop, idle_watcher); +.Ve +.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" +.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" +.IX Subsection "ev_prepare and ev_check - customise your event loop!" +Prepare and check watchers are often (but not always) used in pairs: +prepare watchers get invoked before the process blocks and check watchers +afterwards. +.PP +You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the +current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or +\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine, +however. The rationale behind this is that you do not need to check +for recursion in those watchers, i.e. the sequence will always be +\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each +kind they will always be called in pairs bracketing the blocking call. +.PP +Their main purpose is to integrate other event mechanisms into libev and +their use is somewhat advanced. They could be used, for example, to track +variable changes, implement your own watchers, integrate net-snmp or a +coroutine library and lots more. They are also occasionally useful if +you cache some data and want to flush it before blocking (for example, +in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR +watcher). +.PP +This is done by examining in each prepare call which file descriptors +need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers +for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many +libraries provide exactly this functionality). Then, in the check watcher, +you check for any events that occurred (by checking the pending status +of all watchers and stopping them) and call back into the library. The +I/O and timer callbacks will never actually be called (but must be valid +nevertheless, because you never know, you know?). +.PP +As another example, the Perl Coro module uses these hooks to integrate +coroutines into libev programs, by yielding to other active coroutines +during each prepare and only letting the process block if no coroutines +are ready to run (it's actually more complicated: it only runs coroutines +with priority higher than or equal to the event loop and one coroutine +of lower priority, but only once, using idle watchers to keep the event +loop from blocking if lower-priority coroutines are active, thus mapping +low-priority coroutines to idle/background tasks). +.PP +When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers +highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before +any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR +watchers). +.PP +Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not +activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they +might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As +\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event +loops those other event loops might be in an unusable state until their +\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with +others). +.PP +\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR +.IX Subsection "Abusing an ev_check watcher for its side-effect" +.PP +\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be +useful because they are called once per event loop iteration. For +example, if you want to handle a large number of connections fairly, you +normally only do a bit of work for each active connection, and if there +is more work to do, you wait for the next event loop iteration, so other +connections have a chance of making progress. +.PP +Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the +next event loop iteration. However, that isn't as soon as possible \- +without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked. +.PP +This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a +single global idle watcher that is active as long as you have one active +\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop +will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets +invoked. Neither watcher alone can do that. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_prepare_init (ev_prepare *, callback)" 4 +.IX Item "ev_prepare_init (ev_prepare *, callback)" +.PD 0 +.IP "ev_check_init (ev_check *, callback)" 4 +.IX Item "ev_check_init (ev_check *, callback)" +.PD +Initialises and configures the prepare or check watcher \- they have no +parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR +macros, but using them is utterly, utterly, utterly and completely +pointless. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +There are a number of principal ways to embed other event loops or modules +into libev. Here are some ideas on how to include libadns into libev +(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could +use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a +Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the +Glib event loop). +.PP +Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, +and in a check watcher, destroy them and call into libadns. What follows +is pseudo-code only of course. This requires you to either use a low +priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as +the callbacks for the IO/timeout watchers might not have been called yet. +.PP +.Vb 2 +\& static ev_io iow [nfd]; +\& static ev_timer tw; +\& +\& static void +\& io_cb (struct ev_loop *loop, ev_io *w, int revents) +\& { +\& } +\& +\& // create io watchers for each fd and a timer before blocking +\& static void +\& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents) +\& { +\& int timeout = 3600000; +\& struct pollfd fds [nfd]; +\& // actual code will need to loop here and realloc etc. +\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); +\& +\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ +\& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.); +\& ev_timer_start (loop, &tw); +\& +\& // create one ev_io per pollfd +\& for (int i = 0; i < nfd; ++i) +\& { +\& ev_io_init (iow + i, io_cb, fds [i].fd, +\& ((fds [i].events & POLLIN ? EV_READ : 0) +\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); +\& +\& fds [i].revents = 0; +\& ev_io_start (loop, iow + i); +\& } +\& } +\& +\& // stop all watchers after blocking +\& static void +\& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents) +\& { +\& ev_timer_stop (loop, &tw); +\& +\& for (int i = 0; i < nfd; ++i) +\& { +\& // set the relevant poll flags +\& // could also call adns_processreadable etc. here +\& struct pollfd *fd = fds + i; +\& int revents = ev_clear_pending (iow + i); +\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN; +\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT; +\& +\& // now stop the watcher +\& ev_io_stop (loop, iow + i); +\& } +\& +\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); +\& } +.Ve +.PP +Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR +in the prepare watcher and would dispose of the check watcher. +.PP +Method 3: If the module to be embedded supports explicit event +notification (libadns does), you can also make use of the actual watcher +callbacks, and only destroy/create the watchers in the prepare watcher. +.PP +.Vb 5 +\& static void +\& timer_cb (EV_P_ ev_timer *w, int revents) +\& { +\& adns_state ads = (adns_state)w\->data; +\& update_now (EV_A); +\& +\& adns_processtimeouts (ads, &tv_now); +\& } +\& +\& static void +\& io_cb (EV_P_ ev_io *w, int revents) +\& { +\& adns_state ads = (adns_state)w\->data; +\& update_now (EV_A); +\& +\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now); +\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now); +\& } +\& +\& // do not ever call adns_afterpoll +.Ve +.PP +Method 4: Do not use a prepare or check watcher because the module you +want to embed is not flexible enough to support it. Instead, you can +override their poll function. The drawback with this solution is that the +main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses +this approach, effectively embedding \s-1EV\s0 as a client into the horrible +libglib event loop. +.PP +.Vb 4 +\& static gint +\& event_poll_func (GPollFD *fds, guint nfds, gint timeout) +\& { +\& int got_events = 0; +\& +\& for (n = 0; n < nfds; ++n) +\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events +\& +\& if (timeout >= 0) +\& // create/start timer +\& +\& // poll +\& ev_run (EV_A_ 0); +\& +\& // stop timer again +\& if (timeout >= 0) +\& ev_timer_stop (EV_A_ &to); +\& +\& // stop io watchers again \- their callbacks should have set +\& for (n = 0; n < nfds; ++n) +\& ev_io_stop (EV_A_ iow [n]); +\& +\& return got_events; +\& } +.Ve +.ie n .SS """ev_embed"" \- when one backend isn't enough..." +.el .SS "\f(CWev_embed\fP \- when one backend isn't enough..." +.IX Subsection "ev_embed - when one backend isn't enough..." +This is a rather advanced watcher type that lets you embed one event loop +into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded +loop, other types of watchers might be handled in a delayed or incorrect +fashion and must not be used). +.PP +There are primarily two reasons you would want that: work around bugs and +prioritise I/O. +.PP +As an example for a bug workaround, the kqueue backend might only support +sockets on some platform, so it is unusable as generic backend, but you +still want to make use of it because you have many sockets and it scales +so nicely. In this case, you would create a kqueue-based loop and embed +it into your default loop (which might use e.g. poll). Overall operation +will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then +\&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are +best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :) +.PP +As for prioritising I/O: under rare circumstances you have the case where +some fds have to be watched and handled very quickly (with low latency), +and even priorities and idle watchers might have too much overhead. In +this case you would put all the high priority stuff in one loop and all +the rest in a second one, and embed the second one in the first. +.PP +As long as the watcher is active, the callback will be invoked every +time there might be events pending in the embedded loop. The callback +must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single +sweep and invoke their callbacks (the callback doesn't need to invoke the +\&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher +to give the embedded loop strictly lower priority for example). +.PP +You can also set the callback to \f(CW0\fR, in which case the embed watcher +will automatically execute the embedded loop sweep whenever necessary. +.PP +Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher +is active, i.e., the embedded loop will automatically be forked when the +embedding loop forks. In other cases, the user is responsible for calling +\&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop. +.PP +Unfortunately, not all backends are embeddable: only the ones returned by +\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any +portable one. +.PP +So when you want to use this feature you will always have to be prepared +that you cannot get an embeddable loop. The recommended way to get around +this is to have a separate variables for your embeddable loop, try to +create it, and if that fails, use the normal loop for everything. +.PP +\fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR +.IX Subsection "ev_embed and fork" +.PP +While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will +automatically be applied to the embedded loop as well, so no special +fork handling is required in that case. When the watcher is not running, +however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR +as applicable. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 +.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" +.PD 0 +.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4 +.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" +.PD +Configures the watcher to embed the given loop, which must be +embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be +invoked automatically, otherwise it is the responsibility of the callback +to invoke it (it will continue to be called until the sweep has been done, +if you do not want that, you need to temporarily stop the embed watcher). +.IP "ev_embed_sweep (loop, ev_embed *)" 4 +.IX Item "ev_embed_sweep (loop, ev_embed *)" +Make a single, non-blocking sweep over the embedded loop. This works +similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most +appropriate way for embedded loops. +.IP "struct ev_loop *other [read\-only]" 4 +.IX Item "struct ev_loop *other [read-only]" +The embedded event loop. +.PP +\fIExamples\fR +.IX Subsection "Examples" +.PP +Example: Try to get an embeddable event loop and embed it into the default +event loop. If that is not possible, use the default loop. The default +loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in +\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be +used). +.PP +.Vb 3 +\& struct ev_loop *loop_hi = ev_default_init (0); +\& struct ev_loop *loop_lo = 0; +\& ev_embed embed; +\& +\& // see if there is a chance of getting one that works +\& // (remember that a flags value of 0 means autodetection) +\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () +\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) +\& : 0; +\& +\& // if we got one, then embed it, otherwise default to loop_hi +\& if (loop_lo) +\& { +\& ev_embed_init (&embed, 0, loop_lo); +\& ev_embed_start (loop_hi, &embed); +\& } +\& else +\& loop_lo = loop_hi; +.Ve +.PP +Example: Check if kqueue is available but not recommended and create +a kqueue backend for use with sockets (which usually work with any +kqueue implementation). Store the kqueue/socket\-only event loop in +\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). +.PP +.Vb 3 +\& struct ev_loop *loop = ev_default_init (0); +\& struct ev_loop *loop_socket = 0; +\& ev_embed embed; +\& +\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) +\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) +\& { +\& ev_embed_init (&embed, 0, loop_socket); +\& ev_embed_start (loop, &embed); +\& } +\& +\& if (!loop_socket) +\& loop_socket = loop; +\& +\& // now use loop_socket for all sockets, and loop for everything else +.Ve +.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" +.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" +.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" +Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because +whoever is a good citizen cared to tell libev about it by calling +\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next +and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child +after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats +and calls it in the wrong process, the fork handlers will be invoked, too, +of course. +.PP +\fIThe special problem of life after fork \- how is it possible?\fR +.IX Subsection "The special problem of life after fork - how is it possible?" +.PP +Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set +up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This +sequence should be handled by libev without any problems. +.PP +This changes when the application actually wants to do event handling +in the child, or both parent in child, in effect \*(L"continuing\*(R" after the +fork. +.PP +The default mode of operation (for libev, with application help to detect +forks) is to duplicate all the state in the child, as would be expected +when \fIeither\fR the parent \fIor\fR the child process continues. +.PP +When both processes want to continue using libev, then this is usually the +wrong result. In that case, usually one process (typically the parent) is +supposed to continue with all watchers in place as before, while the other +process typically wants to start fresh, i.e. without any active watchers. +.PP +The cleanest and most efficient way to achieve that with libev is to +simply create a new event loop, which of course will be \*(L"empty\*(R", and +use that for new watchers. This has the advantage of not touching more +memory than necessary, and thus avoiding the copy-on-write, and the +disadvantage of having to use multiple event loops (which do not support +signal watchers). +.PP +When this is not possible, or you want to use the default loop for +other reasons, then in the process that wants to start \*(L"fresh\*(R", call +\&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR. +Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered +watchers, so you have to be careful not to execute code that modifies +those watchers. Note also that in that case, you have to re-register any +signal watchers. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_fork_init (ev_fork *, callback)" 4 +.IX Item "ev_fork_init (ev_fork *, callback)" +Initialises and configures the fork watcher \- it has no parameters of any +kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, +really. +.ie n .SS """ev_cleanup"" \- even the best things end" +.el .SS "\f(CWev_cleanup\fP \- even the best things end" +.IX Subsection "ev_cleanup - even the best things end" +Cleanup watchers are called just before the event loop is being destroyed +by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR. +.PP +While there is no guarantee that the event loop gets destroyed, cleanup +watchers provide a convenient method to install cleanup hooks for your +program, worker threads and so on \- you just to make sure to destroy the +loop when you want them to be invoked. +.PP +Cleanup watchers are invoked in the same way as any other watcher. Unlike +all other watchers, they do not keep a reference to the event loop (which +makes a lot of sense if you think about it). Like all other watchers, you +can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR. +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_cleanup_init (ev_cleanup *, callback)" 4 +.IX Item "ev_cleanup_init (ev_cleanup *, callback)" +Initialises and configures the cleanup watcher \- it has no parameters of +any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly +pointless, I assure you. +.PP +Example: Register an atexit handler to destroy the default loop, so any +cleanup functions are called. +.PP +.Vb 5 +\& static void +\& program_exits (void) +\& { +\& ev_loop_destroy (EV_DEFAULT_UC); +\& } +\& +\& ... +\& atexit (program_exits); +.Ve +.ie n .SS """ev_async"" \- how to wake up an event loop" +.el .SS "\f(CWev_async\fP \- how to wake up an event loop" +.IX Subsection "ev_async - how to wake up an event loop" +In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other +asynchronous sources such as signal handlers (as opposed to multiple event +loops \- those are of course safe to use in different threads). +.PP +Sometimes, however, you need to wake up an event loop you do not control, +for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR +watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal +it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. +.PP +This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, +too, are asynchronous in nature, and signals, too, will be compressed +(i.e. the number of callback invocations may be less than the number of +\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind +of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused +signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread, +even without knowing which loop owns the signal. +.PP +\fIQueueing\fR +.IX Subsection "Queueing" +.PP +\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason +is that the author does not know of a simple (or any) algorithm for a +multiple-writer-single-reader queue that works in all cases and doesn't +need elaborate support such as pthreads or unportable memory access +semantics. +.PP +That means that if you want to queue data, you have to provide your own +queue. But at least I can tell you how to implement locking around your +queue: +.IP "queueing from a signal handler context" 4 +.IX Item "queueing from a signal handler context" +To implement race-free queueing, you simply add to the queue in the signal +handler but you block the signal handler in the watcher callback. Here is +an example that does that for some fictitious \s-1SIGUSR1\s0 handler: +.Sp +.Vb 1 +\& static ev_async mysig; +\& +\& static void +\& sigusr1_handler (void) +\& { +\& sometype data; +\& +\& // no locking etc. +\& queue_put (data); +\& ev_async_send (EV_DEFAULT_ &mysig); +\& } +\& +\& static void +\& mysig_cb (EV_P_ ev_async *w, int revents) +\& { +\& sometype data; +\& sigset_t block, prev; +\& +\& sigemptyset (&block); +\& sigaddset (&block, SIGUSR1); +\& sigprocmask (SIG_BLOCK, &block, &prev); +\& +\& while (queue_get (&data)) +\& process (data); +\& +\& if (sigismember (&prev, SIGUSR1) +\& sigprocmask (SIG_UNBLOCK, &block, 0); +\& } +.Ve +.Sp +(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR +instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it +either...). +.IP "queueing from a thread context" 4 +.IX Item "queueing from a thread context" +The strategy for threads is different, as you cannot (easily) block +threads but you can easily preempt them, so to queue safely you need to +employ a traditional mutex lock, such as in this pthread example: +.Sp +.Vb 2 +\& static ev_async mysig; +\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER; +\& +\& static void +\& otherthread (void) +\& { +\& // only need to lock the actual queueing operation +\& pthread_mutex_lock (&mymutex); +\& queue_put (data); +\& pthread_mutex_unlock (&mymutex); +\& +\& ev_async_send (EV_DEFAULT_ &mysig); +\& } +\& +\& static void +\& mysig_cb (EV_P_ ev_async *w, int revents) +\& { +\& pthread_mutex_lock (&mymutex); +\& +\& while (queue_get (&data)) +\& process (data); +\& +\& pthread_mutex_unlock (&mymutex); +\& } +.Ve +.PP +\fIWatcher-Specific Functions and Data Members\fR +.IX Subsection "Watcher-Specific Functions and Data Members" +.IP "ev_async_init (ev_async *, callback)" 4 +.IX Item "ev_async_init (ev_async *, callback)" +Initialises and configures the async watcher \- it has no parameters of any +kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, +trust me. +.IP "ev_async_send (loop, ev_async *)" 4 +.IX Item "ev_async_send (loop, ev_async *)" +Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds +an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop, and instantly +returns. +.Sp +Unlike \f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, +signal or similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the +embedding section below on what exactly this means). +.Sp +Note that, as with other watchers in libev, multiple events might get +compressed into a single callback invocation (another way to look at +this is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered: they are set on +\&\f(CW\*(C`ev_async_send\*(C'\fR, reset when the event loop detects that). +.Sp +This call incurs the overhead of at most one extra system call per event +loop iteration, if the event loop is blocked, and no syscall at all if +the event loop (or your program) is processing events. That means that +repeated calls are basically free (there is no need to avoid calls for +performance reasons) and that the overhead becomes smaller (typically +zero) under load. +.IP "bool = ev_async_pending (ev_async *)" 4 +.IX Item "bool = ev_async_pending (ev_async *)" +Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the +watcher but the event has not yet been processed (or even noted) by the +event loop. +.Sp +\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When +the loop iterates next and checks for the watcher to have become active, +it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very +quickly check whether invoking the loop might be a good idea. +.Sp +Not that this does \fInot\fR check whether the watcher itself is pending, +only whether it has been requested to make this watcher pending: there +is a time window between the event loop checking and resetting the async +notification, and the callback being invoked. +.SH "OTHER FUNCTIONS" +.IX Header "OTHER FUNCTIONS" +There are some other functions of possible interest. Described. Here. Now. +.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4 +.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" +This function combines a simple timer and an I/O watcher, calls your +callback on whichever event happens first and automatically stops both +watchers. This is useful if you want to wait for a single event on an fd +or timeout without having to allocate/configure/start/stop/free one or +more watchers yourself. +.Sp +If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the +\&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for +the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started. +.Sp +If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be +started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and +repeat = 0) will be started. \f(CW0\fR is a valid timeout. +.Sp +The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is +passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of +\&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR +value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR +a timeout and an io event at the same time \- you probably should give io +events precedence. +.Sp +Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0 +.Sp +.Vb 7 +\& static void stdin_ready (int revents, void *arg) +\& { +\& if (revents & EV_READ) +\& /* stdin might have data for us, joy! */; +\& else if (revents & EV_TIMER) +\& /* doh, nothing entered */; +\& } +\& +\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); +.Ve +.IP "ev_feed_fd_event (loop, int fd, int revents)" 4 +.IX Item "ev_feed_fd_event (loop, int fd, int revents)" +Feed an event on the given fd, as if a file descriptor backend detected +the given events. +.IP "ev_feed_signal_event (loop, int signum)" 4 +.IX Item "ev_feed_signal_event (loop, int signum)" +Feed an event as if the given signal occurred. See also \f(CW\*(C`ev_feed_signal\*(C'\fR, +which is async-safe. +.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" +.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" +This section explains some common idioms that are not immediately +obvious. Note that examples are sprinkled over the whole manual, and this +section only contains stuff that wouldn't fit anywhere else. +.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0" +.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" +Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read +or modify at any time: libev will completely ignore it. This can be used +to associate arbitrary data with your watcher. If you need more data and +don't want to allocate memory separately and store a pointer to it in that +data member, you can also \*(L"subclass\*(R" the watcher type and provide your own +data: +.PP +.Vb 7 +\& struct my_io +\& { +\& ev_io io; +\& int otherfd; +\& void *somedata; +\& struct whatever *mostinteresting; +\& }; +\& +\& ... +\& struct my_io w; +\& ev_io_init (&w.io, my_cb, fd, EV_READ); +.Ve +.PP +And since your callback will be called with a pointer to the watcher, you +can cast it back to your own type: +.PP +.Vb 5 +\& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents) +\& { +\& struct my_io *w = (struct my_io *)w_; +\& ... +\& } +.Ve +.PP +More interesting and less C\-conformant ways of casting your callback +function type instead have been omitted. +.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0" +.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" +Another common scenario is to use some data structure with multiple +embedded watchers, in effect creating your own watcher that combines +multiple libev event sources into one \*(L"super-watcher\*(R": +.PP +.Vb 6 +\& struct my_biggy +\& { +\& int some_data; +\& ev_timer t1; +\& ev_timer t2; +\& } +.Ve +.PP +In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more +complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct in +the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies or \*(C+ coders), or you need +to use some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for +real programmers): +.PP +.Vb 1 +\& #include +\& +\& static void +\& t1_cb (EV_P_ ev_timer *w, int revents) +\& { +\& struct my_biggy big = (struct my_biggy *) +\& (((char *)w) \- offsetof (struct my_biggy, t1)); +\& } +\& +\& static void +\& t2_cb (EV_P_ ev_timer *w, int revents) +\& { +\& struct my_biggy big = (struct my_biggy *) +\& (((char *)w) \- offsetof (struct my_biggy, t2)); +\& } +.Ve +.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0" +.IX Subsection "AVOIDING FINISHING BEFORE RETURNING" +Often you have structures like this in event-based programs: +.PP +.Vb 4 +\& callback () +\& { +\& free (request); +\& } +\& +\& request = start_new_request (..., callback); +.Ve +.PP +The intent is to start some \*(L"lengthy\*(R" operation. The \f(CW\*(C`request\*(C'\fR could be +used to cancel the operation, or do other things with it. +.PP +It's not uncommon to have code paths in \f(CW\*(C`start_new_request\*(C'\fR that +immediately invoke the callback, for example, to report errors. Or you add +some caching layer that finds that it can skip the lengthy aspects of the +operation and simply invoke the callback with the result. +.PP +The problem here is that this will happen \fIbefore\fR \f(CW\*(C`start_new_request\*(C'\fR +has returned, so \f(CW\*(C`request\*(C'\fR is not set. +.PP +Even if you pass the request by some safer means to the callback, you +might want to do something to the request after starting it, such as +canceling it, which probably isn't working so well when the callback has +already been invoked. +.PP +A common way around all these issues is to make sure that +\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If +\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially +delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for +example, or more sneakily, by reusing an existing (stopped) watcher and +pushing it into the pending queue: +.PP +.Vb 2 +\& ev_set_cb (watcher, callback); +\& ev_feed_event (EV_A_ watcher, 0); +.Ve +.PP +This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is +invoked, while not delaying callback invocation too much. +.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0" +.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" +Often (especially in \s-1GUI\s0 toolkits) there are places where you have +\&\fImodal\fR interaction, which is most easily implemented by recursively +invoking \f(CW\*(C`ev_run\*(C'\fR. +.PP +This brings the problem of exiting \- a callback might want to finish the +main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but +a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one +and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some +other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work. +.PP +The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR +invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is +triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR: +.PP +.Vb 2 +\& // main loop +\& int exit_main_loop = 0; +\& +\& while (!exit_main_loop) +\& ev_run (EV_DEFAULT_ EVRUN_ONCE); +\& +\& // in a modal watcher +\& int exit_nested_loop = 0; +\& +\& while (!exit_nested_loop) +\& ev_run (EV_A_ EVRUN_ONCE); +.Ve +.PP +To exit from any of these loops, just set the corresponding exit variable: +.PP +.Vb 2 +\& // exit modal loop +\& exit_nested_loop = 1; +\& +\& // exit main program, after modal loop is finished +\& exit_main_loop = 1; +\& +\& // exit both +\& exit_main_loop = exit_nested_loop = 1; +.Ve +.SS "\s-1THREAD LOCKING EXAMPLE\s0" +.IX Subsection "THREAD LOCKING EXAMPLE" +Here is a fictitious example of how to run an event loop in a different +thread from where callbacks are being invoked and watchers are +created/added/removed. +.PP +For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module, +which uses exactly this technique (which is suited for many high-level +languages). +.PP +The example uses a pthread mutex to protect the loop data, a condition +variable to wait for callback invocations, an async watcher to notify the +event loop thread and an unspecified mechanism to wake up the main thread. +.PP +First, you need to associate some data with the event loop: +.PP +.Vb 6 +\& typedef struct { +\& mutex_t lock; /* global loop lock */ +\& ev_async async_w; +\& thread_t tid; +\& cond_t invoke_cv; +\& } userdata; +\& +\& void prepare_loop (EV_P) +\& { +\& // for simplicity, we use a static userdata struct. +\& static userdata u; +\& +\& ev_async_init (&u\->async_w, async_cb); +\& ev_async_start (EV_A_ &u\->async_w); +\& +\& pthread_mutex_init (&u\->lock, 0); +\& pthread_cond_init (&u\->invoke_cv, 0); +\& +\& // now associate this with the loop +\& ev_set_userdata (EV_A_ u); +\& ev_set_invoke_pending_cb (EV_A_ l_invoke); +\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire); +\& +\& // then create the thread running ev_run +\& pthread_create (&u\->tid, 0, l_run, EV_A); +\& } +.Ve +.PP +The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used +solely to wake up the event loop so it takes notice of any new watchers +that might have been added: +.PP +.Vb 5 +\& static void +\& async_cb (EV_P_ ev_async *w, int revents) +\& { +\& // just used for the side effects +\& } +.Ve +.PP +The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex +protecting the loop data, respectively. +.PP +.Vb 6 +\& static void +\& l_release (EV_P) +\& { +\& userdata *u = ev_userdata (EV_A); +\& pthread_mutex_unlock (&u\->lock); +\& } +\& +\& static void +\& l_acquire (EV_P) +\& { +\& userdata *u = ev_userdata (EV_A); +\& pthread_mutex_lock (&u\->lock); +\& } +.Ve +.PP +The event loop thread first acquires the mutex, and then jumps straight +into \f(CW\*(C`ev_run\*(C'\fR: +.PP +.Vb 4 +\& void * +\& l_run (void *thr_arg) +\& { +\& struct ev_loop *loop = (struct ev_loop *)thr_arg; +\& +\& l_acquire (EV_A); +\& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); +\& ev_run (EV_A_ 0); +\& l_release (EV_A); +\& +\& return 0; +\& } +.Ve +.PP +Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will +signal the main thread via some unspecified mechanism (signals? pipe +writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers +have been called (in a while loop because a) spurious wakeups are possible +and b) skipping inter-thread-communication when there are no pending +watchers is very beneficial): +.PP +.Vb 4 +\& static void +\& l_invoke (EV_P) +\& { +\& userdata *u = ev_userdata (EV_A); +\& +\& while (ev_pending_count (EV_A)) +\& { +\& wake_up_other_thread_in_some_magic_or_not_so_magic_way (); +\& pthread_cond_wait (&u\->invoke_cv, &u\->lock); +\& } +\& } +.Ve +.PP +Now, whenever the main thread gets told to invoke pending watchers, it +will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop +thread to continue: +.PP +.Vb 4 +\& static void +\& real_invoke_pending (EV_P) +\& { +\& userdata *u = ev_userdata (EV_A); +\& +\& pthread_mutex_lock (&u\->lock); +\& ev_invoke_pending (EV_A); +\& pthread_cond_signal (&u\->invoke_cv); +\& pthread_mutex_unlock (&u\->lock); +\& } +.Ve +.PP +Whenever you want to start/stop a watcher or do other modifications to an +event loop, you will now have to lock: +.PP +.Vb 2 +\& ev_timer timeout_watcher; +\& userdata *u = ev_userdata (EV_A); +\& +\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); +\& +\& pthread_mutex_lock (&u\->lock); +\& ev_timer_start (EV_A_ &timeout_watcher); +\& ev_async_send (EV_A_ &u\->async_w); +\& pthread_mutex_unlock (&u\->lock); +.Ve +.PP +Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise +an event loop currently blocking in the kernel will have no knowledge +about the newly added timer. By waking up the loop it will pick up any new +watchers in the next event loop iteration. +.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0" +.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" +While the overhead of a callback that e.g. schedules a thread is small, it +is still an overhead. If you embed libev, and your main usage is with some +kind of threads or coroutines, you might want to customise libev so that +doesn't need callbacks anymore. +.PP +Imagine you have coroutines that you can switch to using a function +\&\f(CW\*(C`switch_to (coro)\*(C'\fR, that libev runs in a coroutine called \f(CW\*(C`libev_coro\*(C'\fR +and that due to some magic, the currently active coroutine is stored in a +global called \f(CW\*(C`current_coro\*(C'\fR. Then you can build your own \*(L"wait for libev +event\*(R" primitive by changing \f(CW\*(C`EV_CB_DECLARE\*(C'\fR and \f(CW\*(C`EV_CB_INVOKE\*(C'\fR (note +the differing \f(CW\*(C`;\*(C'\fR conventions): +.PP +.Vb 2 +\& #define EV_CB_DECLARE(type) struct my_coro *cb; +\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb) +.Ve +.PP +That means instead of having a C callback function, you store the +coroutine to switch to in each watcher, and instead of having libev call +your callback, you instead have it switch to that coroutine. +.PP +A coroutine might now wait for an event with a function called +\&\f(CW\*(C`wait_for_event\*(C'\fR. (the watcher needs to be started, as always, but it doesn't +matter when, or whether the watcher is active or not when this function is +called): +.PP +.Vb 6 +\& void +\& wait_for_event (ev_watcher *w) +\& { +\& ev_set_cb (w, current_coro); +\& switch_to (libev_coro); +\& } +.Ve +.PP +That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and +continues the libev coroutine, which, when appropriate, switches back to +this or any other coroutine. +.PP +You can do similar tricks if you have, say, threads with an event queue \- +instead of storing a coroutine, you store the queue object and instead of +switching to a coroutine, you push the watcher onto the queue and notify +any waiters. +.PP +To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two +files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: +.PP +.Vb 4 +\& // my_ev.h +\& #define EV_CB_DECLARE(type) struct my_coro *cb; +\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb) +\& #include "../libev/ev.h" +\& +\& // my_ev.c +\& #define EV_H "my_ev.h" +\& #include "../libev/ev.c" +.Ve +.PP +And then use \fImy_ev.h\fR when you would normally use \fIev.h\fR, and compile +\&\fImy_ev.c\fR into your project. When properly specifying include paths, you +can even use \fIev.h\fR as header file name directly. +.SH "LIBEVENT EMULATION" +.IX Header "LIBEVENT EMULATION" +Libev offers a compatibility emulation layer for libevent. It cannot +emulate the internals of libevent, so here are some usage hints: +.IP "\(bu" 4 +Only the libevent\-1.4.1\-beta \s-1API\s0 is being emulated. +.Sp +This was the newest libevent version available when libev was implemented, +and is still mostly unchanged in 2010. +.IP "\(bu" 4 +Use it by including , as usual. +.IP "\(bu" 4 +The following members are fully supported: ev_base, ev_callback, +ev_arg, ev_fd, ev_res, ev_events. +.IP "\(bu" 4 +Avoid using ev_flags and the EVLIST_*\-macros, while it is +maintained by libev, it does not work exactly the same way as in libevent (consider +it a private \s-1API\s0). +.IP "\(bu" 4 +Priorities are not currently supported. Initialising priorities +will fail and all watchers will have the same priority, even though there +is an ev_pri field. +.IP "\(bu" 4 +In libevent, the last base created gets the signals, in libev, the +base that registered the signal gets the signals. +.IP "\(bu" 4 +Other members are not supported. +.IP "\(bu" 4 +The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need +to use the libev header file and library. +.SH "\*(C+ SUPPORT" +.IX Header " SUPPORT" +.SS "C \s-1API\s0" +.IX Subsection "C API" +The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the +libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0 +will work fine. +.PP +Proper exception specifications might have to be added to callbacks passed +to libev: exceptions may be thrown only from watcher callbacks, all other +callbacks (allocator, syserr, loop acquire/release and periodic reschedule +callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR +specification. If you have code that needs to be compiled as both C and +\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this: +.PP +.Vb 6 +\& static void +\& fatal_error (const char *msg) EV_NOEXCEPT +\& { +\& perror (msg); +\& abort (); +\& } +\& +\& ... +\& ev_set_syserr_cb (fatal_error); +.Ve +.PP +The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR, +\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter +because it runs cleanup watchers). +.PP +Throwing exceptions in watcher callbacks is only supported if libev itself +is compiled with a \*(C+ compiler or your C and \*(C+ environments allow +throwing exceptions through C libraries (most do). +.SS "\*(C+ \s-1API\s0" +.IX Subsection " API" +Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow +you to use some convenience methods to start/stop watchers and also change +the callback model to a model using method callbacks on objects. +.PP +To use it, +.PP +.Vb 1 +\& #include +.Ve +.PP +This automatically includes \fIev.h\fR and puts all of its definitions (many +of them macros) into the global namespace. All \*(C+ specific things are +put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding +options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. +.PP +Care has been taken to keep the overhead low. The only data member the \*(C+ +classes add (compared to plain C\-style watchers) is the event loop pointer +that the watcher is associated with (or no additional members at all if +you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). +.PP +Currently, functions, static and non-static member functions and classes +with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy +to add as long as they only need one additional pointer for context. If +you need support for other types of functors please contact the author +(preferably after implementing it). +.PP +For all this to work, your \*(C+ compiler either has to use the same calling +conventions as your C compiler (for static member functions), or you have +to embed libev and compile libev itself as \*(C+. +.PP +Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: +.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 +.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 +.IX Item "ev::READ, ev::WRITE etc." +These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. +macros from \fIev.h\fR. +.ie n .IP """ev::tstamp"", ""ev::now""" 4 +.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 +.IX Item "ev::tstamp, ev::now" +Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. +.ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4 +.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 +.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." +For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of +the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR +which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro +defined by many implementations. +.Sp +All of those classes have these methods: +.RS 4 +.IP "ev::TYPE::TYPE ()" 4 +.IX Item "ev::TYPE::TYPE ()" +.PD 0 +.IP "ev::TYPE::TYPE (loop)" 4 +.IX Item "ev::TYPE::TYPE (loop)" +.IP "ev::TYPE::~TYPE" 4 +.IX Item "ev::TYPE::~TYPE" +.PD +The constructor (optionally) takes an event loop to associate the watcher +with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. +.Sp +The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the +\&\f(CW\*(C`set\*(C'\fR method before starting it. +.Sp +It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR +method to set a callback before you can start the watcher. +.Sp +(The reason why you have to use a method is a limitation in \*(C+ which does +not allow explicit template arguments for constructors). +.Sp +The destructor automatically stops the watcher if it is active. +.IP "w\->set (object *)" 4 +.IX Item "w->set (object *)" +This method sets the callback method to call. The method has to have a +signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as +first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as +parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. +.Sp +This method synthesizes efficient thunking code to call your method from +the C callback that libev requires. If your compiler can inline your +callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and +your compiler is good :), then the method will be fully inlined into the +thunking function, making it as fast as a direct C callback. +.Sp +Example: simple class declaration and watcher initialisation +.Sp +.Vb 4 +\& struct myclass +\& { +\& void io_cb (ev::io &w, int revents) { } +\& } +\& +\& myclass obj; +\& ev::io iow; +\& iow.set (&obj); +.Ve +.IP "w\->set (object *)" 4 +.IX Item "w->set (object *)" +This is a variation of a method callback \- leaving out the method to call +will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use +functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all +the time. Incidentally, you can then also leave out the template argument +list. +.Sp +The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w, +int revents)\*(C'\fR. +.Sp +See the method\-\f(CW\*(C`set\*(C'\fR above for more details. +.Sp +Example: use a functor object as callback. +.Sp +.Vb 7 +\& struct myfunctor +\& { +\& void operator() (ev::io &w, int revents) +\& { +\& ... +\& } +\& } +\& +\& myfunctor f; +\& +\& ev::io w; +\& w.set (&f); +.Ve +.IP "w\->set (void *data = 0)" 4 +.IX Item "w->set (void *data = 0)" +Also sets a callback, but uses a static method or plain function as +callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's +\&\f(CW\*(C`data\*(C'\fR member and is free for you to use. +.Sp +The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. +.Sp +See the method\-\f(CW\*(C`set\*(C'\fR above for more details. +.Sp +Example: Use a plain function as callback. +.Sp +.Vb 2 +\& static void io_cb (ev::io &w, int revents) { } +\& iow.set (); +.Ve +.IP "w\->set (loop)" 4 +.IX Item "w->set (loop)" +Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only +do this when the watcher is inactive (and not pending either). +.IP "w\->set ([arguments])" 4 +.IX Item "w->set ([arguments])" +Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>), +with the same arguments. Either this method or a suitable start method +must be called at least once. Unlike the C counterpart, an active watcher +gets automatically stopped and restarted when reconfiguring it with this +method. +.Sp +For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid +clashing with the \f(CW\*(C`set (loop)\*(C'\fR method. +.Sp +For \f(CW\*(C`ev::io\*(C'\fR watchers there is an additional \f(CW\*(C`set\*(C'\fR method that acepts a +new event mask only, and internally calls \f(CW\*(C`ev_io_modfify\*(C'\fR. +.IP "w\->start ()" 4 +.IX Item "w->start ()" +Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the +constructor already stores the event loop. +.IP "w\->start ([arguments])" 4 +.IX Item "w->start ([arguments])" +Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often +convenient to wrap them in one call. Uses the same type of arguments as +the configure \f(CW\*(C`set\*(C'\fR method of the watcher. +.IP "w\->stop ()" 4 +.IX Item "w->stop ()" +Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. +.ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4 +.el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 +.IX Item "w->again () (ev::timer, ev::periodic only)" +For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding +\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. +.ie n .IP "w\->sweep () (""ev::embed"" only)" 4 +.el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 +.IX Item "w->sweep () (ev::embed only)" +Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. +.ie n .IP "w\->update () (""ev::stat"" only)" 4 +.el .IP "w\->update () (\f(CWev::stat\fR only)" 4 +.IX Item "w->update () (ev::stat only)" +Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. +.RE +.RS 4 +.RE +.PP +Example: Define a class with two I/O and idle watchers, start the I/O +watchers in the constructor. +.PP +.Vb 5 +\& class myclass +\& { +\& ev::io io ; void io_cb (ev::io &w, int revents); +\& ev::io io2 ; void io2_cb (ev::io &w, int revents); +\& ev::idle idle; void idle_cb (ev::idle &w, int revents); +\& +\& myclass (int fd) +\& { +\& io .set (this); +\& io2 .set (this); +\& idle.set (this); +\& +\& io.set (fd, ev::WRITE); // configure the watcher +\& io.start (); // start it whenever convenient +\& +\& io2.start (fd, ev::READ); // set + start in one call +\& } +\& }; +.Ve +.SH "OTHER LANGUAGE BINDINGS" +.IX Header "OTHER LANGUAGE BINDINGS" +Libev does not offer other language bindings itself, but bindings for a +number of languages exist in the form of third-party packages. If you know +any interesting language binding in addition to the ones listed here, drop +me a note. +.IP "Perl" 4 +.IX Item "Perl" +The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test +libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module, +there are additional modules that implement libev-compatible interfaces +to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), +\&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR +and \f(CW\*(C`EV::Glib\*(C'\fR). +.Sp +It can be found and installed via \s-1CPAN,\s0 its homepage is at +. +.IP "Python" 4 +.IX Item "Python" +Python bindings can be found at . It +seems to be quite complete and well-documented. +.IP "Ruby" 4 +.IX Item "Ruby" +Tony Arcieri has written a ruby extension that offers access to a subset +of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and +more on top of it. It can be found via gem servers. Its homepage is at +. +.Sp +Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR +makes rev work even on mingw. +.IP "Haskell" 4 +.IX Item "Haskell" +A haskell binding to libev is available at +. +.IP "D" 4 +.IX Item "D" +Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to +be found at . +.IP "Ocaml" 4 +.IX Item "Ocaml" +Erkki Seppala has written Ocaml bindings for libev, to be found at +. +.IP "Lua" 4 +.IX Item "Lua" +Brian Maher has written a partial interface to libev for lua (at the +time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at +. +.IP "Javascript" 4 +.IX Item "Javascript" +Node.js () uses libev as the underlying event library. +.IP "Others" 4 +.IX Item "Others" +There are others, and I stopped counting. +.SH "MACRO MAGIC" +.IX Header "MACRO MAGIC" +Libev can be compiled with a variety of options, the most fundamental +of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) +functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. +.PP +To make it easier to write programs that cope with either variant, the +following macros are defined: +.ie n .IP """EV_A"", ""EV_A_""" 4 +.el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 +.IX Item "EV_A, EV_A_" +This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev +loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, +\&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: +.Sp +.Vb 3 +\& ev_unref (EV_A); +\& ev_timer_add (EV_A_ watcher); +\& ev_run (EV_A_ 0); +.Ve +.Sp +It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, +which is often provided by the following macro. +.ie n .IP """EV_P"", ""EV_P_""" 4 +.el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 +.IX Item "EV_P, EV_P_" +This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev +loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, +\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: +.Sp +.Vb 2 +\& // this is how ev_unref is being declared +\& static void ev_unref (EV_P); +\& +\& // this is how you can declare your typical callback +\& static void cb (EV_P_ ev_timer *w, int revents) +.Ve +.Sp +It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite +suitable for use with \f(CW\*(C`EV_A\*(C'\fR. +.ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 +.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 +.IX Item "EV_DEFAULT, EV_DEFAULT_" +Similar to the other two macros, this gives you the value of the default +loop, if multiple loops are supported (\*(L"ev loop default\*(R"). The default loop +will be initialised if it isn't already initialised. +.Sp +For non-multiplicity builds, these macros do nothing, so you always have +to initialise the loop somewhere. +.ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 +.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 +.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" +Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the +default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour +is undefined when the default loop has not been initialised by a previous +execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR. +.Sp +It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first +watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards. +.PP +Example: Declare and initialise a check watcher, utilising the above +macros so it will work regardless of whether multiple loops are supported +or not. +.PP +.Vb 5 +\& static void +\& check_cb (EV_P_ ev_timer *w, int revents) +\& { +\& ev_check_stop (EV_A_ w); +\& } +\& +\& ev_check check; +\& ev_check_init (&check, check_cb); +\& ev_check_start (EV_DEFAULT_ &check); +\& ev_run (EV_DEFAULT_ 0); +.Ve +.SH "EMBEDDING" +.IX Header "EMBEDDING" +Libev can (and often is) directly embedded into host +applications. Examples of applications that embed it include the Deliantra +Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) +and rxvt-unicode. +.PP +The goal is to enable you to just copy the necessary files into your +source directory without having to change even a single line in them, so +you can easily upgrade by simply copying (or having a checked-out copy of +libev somewhere in your source tree). +.SS "\s-1FILESETS\s0" +.IX Subsection "FILESETS" +Depending on what features you need you need to include one or more sets of files +in your application. +.PP +\fI\s-1CORE EVENT LOOP\s0\fR +.IX Subsection "CORE EVENT LOOP" +.PP +To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual +configuration (no autoconf): +.PP +.Vb 2 +\& #define EV_STANDALONE 1 +\& #include "ev.c" +.Ve +.PP +This will automatically include \fIev.h\fR, too, and should be done in a +single C source file only to provide the function implementations. To use +it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best +done by writing a wrapper around \fIev.h\fR that you can include instead and +where you can put other configuration options): +.PP +.Vb 2 +\& #define EV_STANDALONE 1 +\& #include "ev.h" +.Ve +.PP +Both header files and implementation files can be compiled with a \*(C+ +compiler (at least, that's a stated goal, and breakage will be treated +as a bug). +.PP +You need the following files in your source tree, or in a directory +in your include path (e.g. in libev/ when using \-Ilibev): +.PP +.Vb 4 +\& ev.h +\& ev.c +\& ev_vars.h +\& ev_wrap.h +\& +\& ev_win32.c required on win32 platforms only +\& +\& ev_select.c only when select backend is enabled +\& ev_poll.c only when poll backend is enabled +\& ev_epoll.c only when the epoll backend is enabled +\& ev_linuxaio.c only when the linux aio backend is enabled +\& ev_iouring.c only when the linux io_uring backend is enabled +\& ev_kqueue.c only when the kqueue backend is enabled +\& ev_port.c only when the solaris port backend is enabled +.Ve +.PP +\&\fIev.c\fR includes the backend files directly when enabled, so you only need +to compile this single file. +.PP +\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR +.IX Subsection "LIBEVENT COMPATIBILITY API" +.PP +To include the libevent compatibility \s-1API,\s0 also include: +.PP +.Vb 1 +\& #include "event.c" +.Ve +.PP +in the file including \fIev.c\fR, and: +.PP +.Vb 1 +\& #include "event.h" +.Ve +.PP +in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR. +.PP +You need the following additional files for this: +.PP +.Vb 2 +\& event.h +\& event.c +.Ve +.PP +\fI\s-1AUTOCONF SUPPORT\s0\fR +.IX Subsection "AUTOCONF SUPPORT" +.PP +Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in +whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your +\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then +include \fIconfig.h\fR and configure itself accordingly. +.PP +For this of course you need the m4 file: +.PP +.Vb 1 +\& libev.m4 +.Ve +.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0" +.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" +Libev can be configured via a variety of preprocessor symbols you have to +define before including (or compiling) any of its files. The default in +the absence of autoconf is documented for every option. +.PP +Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different +values when compiling libev vs. including \fIev.h\fR, so it is permissible +to redefine them before including \fIev.h\fR without breaking compatibility +to a compiled library. All other symbols change the \s-1ABI,\s0 which means all +users of libev and the libev code itself must be compiled with compatible +settings. +.IP "\s-1EV_COMPAT3\s0 (h)" 4 +.IX Item "EV_COMPAT3 (h)" +Backwards compatibility is a major concern for libev. This is why this +release of libev comes with wrappers for the functions and symbols that +have been renamed between libev version 3 and 4. +.Sp +You can disable these wrappers (to test compatibility with future +versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your +sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR +from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR +typedef in that case. +.Sp +In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR, +and in some even more future version the compatibility code will be +removed completely. +.IP "\s-1EV_STANDALONE\s0 (h)" 4 +.IX Item "EV_STANDALONE (h)" +Must always be \f(CW1\fR if you do not use autoconf configuration, which +keeps libev from including \fIconfig.h\fR, and it also defines dummy +implementations for some libevent functions (such as logging, which is not +supported). It will also not define any of the structs usually found in +\&\fIevent.h\fR that are not directly supported by the libev core alone. +.Sp +In standalone mode, libev will still try to automatically deduce the +configuration, but has to be more conservative. +.IP "\s-1EV_USE_FLOOR\s0" 4 +.IX Item "EV_USE_FLOOR" +If defined to be \f(CW1\fR, libev will use the \f(CW\*(C`floor ()\*(C'\fR function for its +periodic reschedule calculations, otherwise libev will fall back on a +portable (slower) implementation. If you enable this, you usually have to +link against libm or something equivalent. Enabling this when the \f(CW\*(C`floor\*(C'\fR +function is not available will fail, so the safe default is to not enable +this. +.IP "\s-1EV_USE_MONOTONIC\s0" 4 +.IX Item "EV_USE_MONOTONIC" +If defined to be \f(CW1\fR, libev will try to detect the availability of the +monotonic clock option at both compile time and runtime. Otherwise no +use of the monotonic clock option will be attempted. If you enable this, +you usually have to link against librt or something similar. Enabling it +when the functionality isn't available is safe, though, although you have +to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR +function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. +.IP "\s-1EV_USE_REALTIME\s0" 4 +.IX Item "EV_USE_REALTIME" +If defined to be \f(CW1\fR, libev will try to detect the availability of the +real-time clock option at compile time (and assume its availability +at runtime if successful). Otherwise no use of the real-time clock +option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR +by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect +correctness. See the note about libraries in the description of +\&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of +\&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. +.IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4 +.IX Item "EV_USE_CLOCK_SYSCALL" +If defined to be \f(CW1\fR, libev will try to use a direct syscall instead +of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option +exists because on GNU/Linux, \f(CW\*(C`clock_gettime\*(C'\fR is in \f(CW\*(C`librt\*(C'\fR, but \f(CW\*(C`librt\*(C'\fR +unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded +programs needlessly. Using a direct syscall is slightly slower (in +theory), because no optimised vdso implementation can be used, but avoids +the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or +higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). +.IP "\s-1EV_USE_NANOSLEEP\s0" 4 +.IX Item "EV_USE_NANOSLEEP" +If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available +and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. +.IP "\s-1EV_USE_EVENTFD\s0" 4 +.IX Item "EV_USE_EVENTFD" +If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is +available and will probe for kernel support at runtime. This will improve +\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. +If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc +2.7 or newer, otherwise disabled. +.IP "\s-1EV_USE_SIGNALFD\s0" 4 +.IX Item "EV_USE_SIGNALFD" +If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is +available and will probe for kernel support at runtime. This enables +the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If +undefined, it will be enabled if the headers indicate GNU/Linux + Glibc +2.7 or newer, otherwise disabled. +.IP "\s-1EV_USE_TIMERFD\s0" 4 +.IX Item "EV_USE_TIMERFD" +If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is +available and will probe for kernel support at runtime. This allows +libev to detect time jumps accurately. If undefined, it will be enabled +if the headers indicate GNU/Linux + Glibc 2.8 or newer and define +\&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled. +.IP "\s-1EV_USE_EVENTFD\s0" 4 +.IX Item "EV_USE_EVENTFD" +If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is +available and will probe for kernel support at runtime. This will improve +\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. +If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc +2.7 or newer, otherwise disabled. +.IP "\s-1EV_USE_SELECT\s0" 4 +.IX Item "EV_USE_SELECT" +If undefined or defined to be \f(CW1\fR, libev will compile in support for the +\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no +other method takes over, select will be it. Otherwise the select backend +will not be compiled in. +.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 +.IX Item "EV_SELECT_USE_FD_SET" +If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR +structure. This is useful if libev doesn't compile due to a missing +\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout +on exotic systems. This usually limits the range of file descriptors to +some low limit such as 1024 or might have other limitations (winsocket +only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, +configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR. +.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 +.IX Item "EV_SELECT_IS_WINSOCKET" +When defined to \f(CW1\fR, the select backend will assume that +select/socket/connect etc. don't understand file descriptors but +wants osf handles on win32 (this is the case when the select to +be used is the winsock select). This means that it will call +\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, +it is assumed that all these functions actually work on fds, even +on win32. Should not be defined on non\-win32 platforms. +.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4 +.IX Item "EV_FD_TO_WIN32_HANDLE(fd)" +If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map +file descriptors to socket handles. When not defining this symbol (the +default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually +correct. In some cases, programs use their own file descriptor management, +in which case they can provide this function to map fds to socket handles. +.IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4 +.IX Item "EV_WIN32_HANDLE_TO_FD(handle)" +If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors +using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing +their own fd to handle mapping, overwriting this function makes it easier +to do so. This can be done by defining this macro to an appropriate value. +.IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4 +.IX Item "EV_WIN32_CLOSE_FD(fd)" +If programs implement their own fd to handle mapping on win32, then this +macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister +file descriptors again. Note that the replacement function has to close +the underlying \s-1OS\s0 handle. +.IP "\s-1EV_USE_WSASOCKET\s0" 4 +.IX Item "EV_USE_WSASOCKET" +If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal +communication socket, which works better in some environments. Otherwise, +the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other +environments. +.IP "\s-1EV_USE_POLL\s0" 4 +.IX Item "EV_USE_POLL" +If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) +backend. Otherwise it will be enabled on non\-win32 platforms. It +takes precedence over select. +.IP "\s-1EV_USE_EPOLL\s0" 4 +.IX Item "EV_USE_EPOLL" +If defined to be \f(CW1\fR, libev will compile in support for the Linux +\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, +otherwise another method will be used as fallback. This is the preferred +backend for GNU/Linux systems. If undefined, it will be enabled if the +headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. +.IP "\s-1EV_USE_LINUXAIO\s0" 4 +.IX Item "EV_USE_LINUXAIO" +If defined to be \f(CW1\fR, libev will compile in support for the Linux aio +backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be +enabled on linux, otherwise disabled. +.IP "\s-1EV_USE_IOURING\s0" 4 +.IX Item "EV_USE_IOURING" +If defined to be \f(CW1\fR, libev will compile in support for the Linux +io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's +current limitations it has to be requested explicitly. If undefined, it +will be enabled on linux, otherwise disabled. +.IP "\s-1EV_USE_KQUEUE\s0" 4 +.IX Item "EV_USE_KQUEUE" +If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style +\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, +otherwise another method will be used as fallback. This is the preferred +backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only +supports some types of fds correctly (the only platform we found that +supports ptys for example was NetBSD), so kqueue might be compiled in, but +not be used unless explicitly requested. The best way to use it is to find +out whether kqueue supports your type of fd properly and use an embedded +kqueue loop. +.IP "\s-1EV_USE_PORT\s0" 4 +.IX Item "EV_USE_PORT" +If defined to be \f(CW1\fR, libev will compile in support for the Solaris +10 port style backend. Its availability will be detected at runtime, +otherwise another method will be used as fallback. This is the preferred +backend for Solaris 10 systems. +.IP "\s-1EV_USE_DEVPOLL\s0" 4 +.IX Item "EV_USE_DEVPOLL" +Reserved for future expansion, works like the \s-1USE\s0 symbols above. +.IP "\s-1EV_USE_INOTIFY\s0" 4 +.IX Item "EV_USE_INOTIFY" +If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify +interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will +be detected at runtime. If undefined, it will be enabled if the headers +indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. +.IP "\s-1EV_NO_SMP\s0" 4 +.IX Item "EV_NO_SMP" +If defined to be \f(CW1\fR, libev will assume that memory is always coherent +between threads, that is, threads can be used, but threads never run on +different cpus (or different cpu cores). This reduces dependencies +and makes libev faster. +.IP "\s-1EV_NO_THREADS\s0" 4 +.IX Item "EV_NO_THREADS" +If defined to be \f(CW1\fR, libev will assume that it will never be called from +different threads (that includes signal handlers), which is a stronger +assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes +libev faster. +.IP "\s-1EV_ATOMIC_T\s0" 4 +.IX Item "EV_ATOMIC_T" +Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose +access is atomic with respect to other threads or signal contexts. No +such type is easily found in the C language, so you can provide your own +type that you know is safe for your purposes. It is used both for signal +handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR +watchers. +.Sp +In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR +(from \fIsignal.h\fR), which is usually good enough on most platforms. +.IP "\s-1EV_H\s0 (h)" 4 +.IX Item "EV_H (h)" +The name of the \fIev.h\fR header file used to include it. The default if +undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be +used to virtually rename the \fIev.h\fR header file in case of conflicts. +.IP "\s-1EV_CONFIG_H\s0 (h)" 4 +.IX Item "EV_CONFIG_H (h)" +If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override +\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to +\&\f(CW\*(C`EV_H\*(C'\fR, above. +.IP "\s-1EV_EVENT_H\s0 (h)" 4 +.IX Item "EV_EVENT_H (h)" +Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea +of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. +.IP "\s-1EV_PROTOTYPES\s0 (h)" 4 +.IX Item "EV_PROTOTYPES (h)" +If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function +prototypes, but still define all the structs and other symbols. This is +occasionally useful if you want to provide your own wrapper functions +around libev functions. +.IP "\s-1EV_MULTIPLICITY\s0" 4 +.IX Item "EV_MULTIPLICITY" +If undefined or defined to \f(CW1\fR, then all event-loop-specific functions +will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create +additional independent event loops. Otherwise there will be no support +for multiple event loops and there is no first event loop pointer +argument. Instead, all functions act on the single default loop. +.Sp +Note that \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR will no longer provide a +default loop when multiplicity is switched off \- you always have to +initialise the loop manually in this case. +.IP "\s-1EV_MINPRI\s0" 4 +.IX Item "EV_MINPRI" +.PD 0 +.IP "\s-1EV_MAXPRI\s0" 4 +.IX Item "EV_MAXPRI" +.PD +The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to +\&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can +provide for more priorities by overriding those symbols (usually defined +to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). +.Sp +When doing priority-based operations, libev usually has to linearly search +all the priorities, so having many of them (hundreds) uses a lot of space +and time, so using the defaults of five priorities (\-2 .. +2) is usually +fine. +.Sp +If your embedding application does not need any priorities, defining these +both to \f(CW0\fR will save some memory and \s-1CPU.\s0 +.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4 +.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE." +If undefined or defined to be \f(CW1\fR (and the platform supports it), then +the respective watcher type is supported. If defined to be \f(CW0\fR, then it +is not. Disabling watcher types mainly saves code size. +.IP "\s-1EV_FEATURES\s0" 4 +.IX Item "EV_FEATURES" +If you need to shave off some kilobytes of code at the expense of some +speed (but with the full \s-1API\s0), you can define this symbol to request +certain subsets of functionality. The default is to enable all features +that can be enabled on the platform. +.Sp +A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset +with some broad features you want) and then selectively re-enable +additional parts you want, for example if you want everything minimal, +but multiple event loop support, async and child watchers and the poll +backend, use this: +.Sp +.Vb 5 +\& #define EV_FEATURES 0 +\& #define EV_MULTIPLICITY 1 +\& #define EV_USE_POLL 1 +\& #define EV_CHILD_ENABLE 1 +\& #define EV_ASYNC_ENABLE 1 +.Ve +.Sp +The actual value is a bitset, it can be a combination of the following +values (by default, all of these are enabled): +.RS 4 +.ie n .IP "1 \- faster/larger code" 4 +.el .IP "\f(CW1\fR \- faster/larger code" 4 +.IX Item "1 - faster/larger code" +Use larger code to speed up some operations. +.Sp +Currently this is used to override some inlining decisions (enlarging the +code size by roughly 30% on amd64). +.Sp +When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with +gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of +assertions. +.Sp +The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler +(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR). +.ie n .IP "2 \- faster/larger data structures" 4 +.el .IP "\f(CW2\fR \- faster/larger data structures" 4 +.IX Item "2 - faster/larger data structures" +Replaces the small 2\-heap for timer management by a faster 4\-heap, larger +hash table sizes and so on. This will usually further increase code size +and can additionally have an effect on the size of data structures at +runtime. +.Sp +The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler +(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR). +.ie n .IP "4 \- full \s-1API\s0 configuration" 4 +.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 +.IX Item "4 - full API configuration" +This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and +enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). +.ie n .IP "8 \- full \s-1API\s0" 4 +.el .IP "\f(CW8\fR \- full \s-1API\s0" 4 +.IX Item "8 - full API" +This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for +details on which parts of the \s-1API\s0 are still available without this +feature, and do not complain if this subset changes over time. +.ie n .IP "16 \- enable all optional watcher types" 4 +.el .IP "\f(CW16\fR \- enable all optional watcher types" 4 +.IX Item "16 - enable all optional watcher types" +Enables all optional watcher types. If you want to selectively enable +only some watcher types other than I/O and timers (e.g. prepare, +embed, async, child...) you can enable them manually by defining +\&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead. +.ie n .IP "32 \- enable all backends" 4 +.el .IP "\f(CW32\fR \- enable all backends" 4 +.IX Item "32 - enable all backends" +This enables all backends \- without this feature, you need to enable at +least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice). +.ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4 +.el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4 +.IX Item "64 - enable OS-specific helper APIs" +Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by +default. +.RE +.RS 4 +.Sp +Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR +reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb +code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O +watchers, timers and monotonic clock support. +.Sp +With an intelligent-enough linker (gcc+binutils are intelligent enough +when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by +your program might be left out as well \- a binary starting a timer and an +I/O watcher then might come out at only 5Kb. +.RE +.IP "\s-1EV_API_STATIC\s0" 4 +.IX Item "EV_API_STATIC" +If this symbol is defined (by default it is not), then all identifiers +will have static linkage. This means that libev will not export any +identifiers, and you cannot link against libev anymore. This can be useful +when you embed libev, only want to use libev functions in a single file, +and do not want its identifiers to be visible. +.Sp +To use this, define \f(CW\*(C`EV_API_STATIC\*(C'\fR and include \fIev.c\fR in the file that +wants to use libev. +.Sp +This option only works when libev is compiled with a C compiler, as \*(C+ +doesn't support the required declaration syntax. +.IP "\s-1EV_AVOID_STDIO\s0" 4 +.IX Item "EV_AVOID_STDIO" +If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio +functions (printf, scanf, perror etc.). This will increase the code size +somewhat, but if your program doesn't otherwise depend on stdio and your +libc allows it, this avoids linking in the stdio library which is quite +big. +.Sp +Note that error messages might become less precise when this option is +enabled. +.IP "\s-1EV_NSIG\s0" 4 +.IX Item "EV_NSIG" +The highest supported signal number, +1 (or, the number of +signals): Normally, libev tries to deduce the maximum number of signals +automatically, but sometimes this fails, in which case it can be +specified. Also, using a lower number than detected (\f(CW32\fR should be +good for about any system in existence) can save some memory, as libev +statically allocates some 12\-24 bytes per signal number. +.IP "\s-1EV_PID_HASHSIZE\s0" 4 +.IX Item "EV_PID_HASHSIZE" +\&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by +pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled), +usually more than enough. If you need to manage thousands of children you +might want to increase this value (\fImust\fR be a power of two). +.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 +.IX Item "EV_INOTIFY_HASHSIZE" +\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by +inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR +disabled), usually more than enough. If you need to manage thousands of +\&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a +power of two). +.IP "\s-1EV_USE_4HEAP\s0" 4 +.IX Item "EV_USE_4HEAP" +Heaps are not very cache-efficient. To improve the cache-efficiency of the +timer and periodics heaps, libev uses a 4\-heap when this symbol is defined +to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably +faster performance with many (thousands) of watchers. +.Sp +The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it +will be \f(CW0\fR. +.IP "\s-1EV_HEAP_CACHE_AT\s0" 4 +.IX Item "EV_HEAP_CACHE_AT" +Heaps are not very cache-efficient. To improve the cache-efficiency of the +timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within +the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), +which uses 8\-12 bytes more per watcher and a few hundred bytes more code, +but avoids random read accesses on heap changes. This improves performance +noticeably with many (hundreds) of watchers. +.Sp +The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it +will be \f(CW0\fR. +.IP "\s-1EV_VERIFY\s0" 4 +.IX Item "EV_VERIFY" +Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will +be done: If set to \f(CW0\fR, no internal verification code will be compiled +in. If set to \f(CW1\fR, then verification code will be compiled in, but not +called. If set to \f(CW2\fR, then the internal verification code will be +called once per loop, which can slow down libev. If set to \f(CW3\fR, then the +verification code will be called very frequently, which will slow down +libev considerably. +.Sp +Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you +disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported. +.Sp +The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it +will be \f(CW0\fR. +.IP "\s-1EV_COMMON\s0" 4 +.IX Item "EV_COMMON" +By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining +this macro to something else you can include more and other types of +members. You have to define it each time you include one of the files, +though, and it must be identical each time. +.Sp +For example, the perl \s-1EV\s0 module uses something like this: +.Sp +.Vb 3 +\& #define EV_COMMON \e +\& SV *self; /* contains this struct */ \e +\& SV *cb_sv, *fh /* note no trailing ";" */ +.Ve +.IP "\s-1EV_CB_DECLARE\s0 (type)" 4 +.IX Item "EV_CB_DECLARE (type)" +.PD 0 +.IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 +.IX Item "EV_CB_INVOKE (watcher, revents)" +.IP "ev_set_cb (ev, cb)" 4 +.IX Item "ev_set_cb (ev, cb)" +.PD +Can be used to change the callback member declaration in each watcher, +and the way callbacks are invoked and set. Must expand to a struct member +definition and a statement, respectively. See the \fIev.h\fR header file for +their default definitions. One possible use for overriding these is to +avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use +method calls instead of plain function calls in \*(C+. +.SS "\s-1EXPORTED API SYMBOLS\s0" +.IX Subsection "EXPORTED API SYMBOLS" +If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of +exported symbols, you can use the provided \fISymbol.*\fR files which list +all public symbols, one per line: +.PP +.Vb 2 +\& Symbols.ev for libev proper +\& Symbols.event for the libevent emulation +.Ve +.PP +This can also be used to rename all public symbols to avoid clashes with +multiple versions of libev linked together (which is obviously bad in +itself, but sometimes it is inconvenient to avoid this). +.PP +A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to +include before including \fIev.h\fR: +.PP +.Vb 1 +\& wrap.h +.Ve +.PP +This would create a file \fIwrap.h\fR which essentially looks like this: +.PP +.Vb 4 +\& #define ev_backend myprefix_ev_backend +\& #define ev_check_start myprefix_ev_check_start +\& #define ev_check_stop myprefix_ev_check_stop +\& ... +.Ve +.SS "\s-1EXAMPLES\s0" +.IX Subsection "EXAMPLES" +For a real-world example of a program the includes libev +verbatim, you can have a look at the \s-1EV\s0 perl module +(). It has the libev files in +the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public +interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file +will be compiled. It is pretty complex because it provides its own header +file. +.PP +The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file +that everybody includes and which overrides some configure choices: +.PP +.Vb 8 +\& #define EV_FEATURES 8 +\& #define EV_USE_SELECT 1 +\& #define EV_PREPARE_ENABLE 1 +\& #define EV_IDLE_ENABLE 1 +\& #define EV_SIGNAL_ENABLE 1 +\& #define EV_CHILD_ENABLE 1 +\& #define EV_USE_STDEXCEPT 0 +\& #define EV_CONFIG_H +\& +\& #include "ev++.h" +.Ve +.PP +And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: +.PP +.Vb 2 +\& #include "ev_cpp.h" +\& #include "ev.c" +.Ve +.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" +.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" +.SS "\s-1THREADS AND COROUTINES\s0" +.IX Subsection "THREADS AND COROUTINES" +\fI\s-1THREADS\s0\fR +.IX Subsection "THREADS" +.PP +All libev functions are reentrant and thread-safe unless explicitly +documented otherwise, but libev implements no locking itself. This means +that you can use as many loops as you want in parallel, as long as there +are no concurrent calls into any libev function with the same loop +parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter, +of course): libev guarantees that different event loops share no data +structures that need any locking. +.PP +Or to put it differently: calls with different loop parameters can be done +concurrently from multiple threads, calls with the same loop parameter +must be done serially (but can be done from different threads, as long as +only one thread ever is inside a call at any point in time, e.g. by using +a mutex per loop). +.PP +Specifically to support threads (and signal handlers), libev implements +so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of +concurrency on the same event loop, namely waking it up \*(L"from the +outside\*(R". +.PP +If you want to know which design (one loop, locking, or multiple loops +without or something else still) is best for your problem, then I cannot +help you, but here is some generic advice: +.IP "\(bu" 4 +most applications have a main thread: use the default libev loop +in that thread, or create a separate thread running only the default loop. +.Sp +This helps integrating other libraries or software modules that use libev +themselves and don't care/know about threading. +.IP "\(bu" 4 +one loop per thread is usually a good model. +.Sp +Doing this is almost never wrong, sometimes a better-performance model +exists, but it is always a good start. +.IP "\(bu" 4 +other models exist, such as the leader/follower pattern, where one +loop is handed through multiple threads in a kind of round-robin fashion. +.Sp +Choosing a model is hard \- look around, learn, know that usually you can do +better than you currently do :\-) +.IP "\(bu" 4 +often you need to talk to some other thread which blocks in the +event loop. +.Sp +\&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely +(or from signal contexts...). +.Sp +An example use would be to communicate signals or other events that only +work in the default loop by registering the signal watcher with the +default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop +watcher callback into the event loop interested in the signal. +.PP +See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0. +.PP +\fI\s-1COROUTINES\s0\fR +.IX Subsection "COROUTINES" +.PP +Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): +libev fully supports nesting calls to its functions from different +coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two +different coroutines, and switch freely between both coroutines running +the loop, as long as you don't confuse yourself). The only exception is +that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. +.PP +Care has been taken to ensure that libev does not keep local state inside +\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as +they do not call any callbacks. +.SS "\s-1COMPILER WARNINGS\s0" +.IX Subsection "COMPILER WARNINGS" +Depending on your compiler and compiler settings, you might get no or a +lot of warnings when compiling libev code. Some people are apparently +scared by this. +.PP +However, these are unavoidable for many reasons. For one, each compiler +has different warnings, and each user has different tastes regarding +warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when +targeting a specific compiler and compiler-version. +.PP +Another reason is that some compiler warnings require elaborate +workarounds, or other changes to the code that make it less clear and less +maintainable. +.PP +And of course, some compiler warnings are just plain stupid, or simply +wrong (because they don't actually warn about the condition their message +seems to warn about). For example, certain older gcc versions had some +warnings that resulted in an extreme number of false positives. These have +been fixed, but some people still insist on making code warn-free with +such buggy versions. +.PP +While libev is written to generate as few warnings as possible, +\&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev +with any compiler warnings enabled unless you are prepared to cope with +them (e.g. by ignoring them). Remember that warnings are just that: +warnings, not errors, or proof of bugs. +.SS "\s-1VALGRIND\s0" +.IX Subsection "VALGRIND" +Valgrind has a special section here because it is a popular tool that is +highly useful. Unfortunately, valgrind reports are very hard to interpret. +.PP +If you think you found a bug (memory leak, uninitialised data access etc.) +in libev, then check twice: If valgrind reports something like: +.PP +.Vb 3 +\& ==2274== definitely lost: 0 bytes in 0 blocks. +\& ==2274== possibly lost: 0 bytes in 0 blocks. +\& ==2274== still reachable: 256 bytes in 1 blocks. +.Ve +.PP +Then there is no memory leak, just as memory accounted to global variables +is not a memleak \- the memory is still being referenced, and didn't leak. +.PP +Similarly, under some circumstances, valgrind might report kernel bugs +as if it were a bug in libev (e.g. in realloc or in the poll backend, +although an acceptable workaround has been found here), or it might be +confused. +.PP +Keep in mind that valgrind is a very good tool, but only a tool. Don't +make it into some kind of religion. +.PP +If you are unsure about something, feel free to contact the mailing list +with the full valgrind report and an explanation on why you think this +is a bug in libev (best check the archives, too :). However, don't be +annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance +of learning how to interpret valgrind properly. +.PP +If you need, for some reason, empty reports from valgrind for your project +I suggest using suppression lists. +.SH "PORTABILITY NOTES" +.IX Header "PORTABILITY NOTES" +.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0" +.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" +GNU/Linux is the only common platform that supports 64 bit file/large file +interfaces but \fIdisables\fR them by default. +.PP +That means that libev compiled in the default environment doesn't support +files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. +.PP +Unfortunately, many programs try to work around this GNU/Linux issue +by enabling the large file \s-1API,\s0 which makes them incompatible with the +standard libev compiled for their system. +.PP +Likewise, libev cannot enable the large file \s-1API\s0 itself as this would +suddenly make it incompatible to the default compile time environment, +i.e. all programs not using special compile switches. +.SS "\s-1OS/X AND DARWIN BUGS\s0" +.IX Subsection "OS/X AND DARWIN BUGS" +The whole thing is a bug if you ask me \- basically any system interface +you touch is broken, whether it is locales, poll, kqueue or even the +OpenGL drivers. +.PP +\fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR +.IX Subsection "kqueue is buggy" +.PP +The kqueue syscall is broken in all known versions \- most versions support +only sockets, many support pipes. +.PP +Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this +rotten platform, but of course you can still ask for it when creating a +loop \- embedding a socket-only kqueue loop into a select-based one is +probably going to work well. +.PP +\fI\f(CI\*(C`poll\*(C'\fI is buggy\fR +.IX Subsection "poll is buggy" +.PP +Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR +implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6 +release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken. +.PP +Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on +this rotten platform, but of course you can still ask for it when creating +a loop. +.PP +\fI\f(CI\*(C`select\*(C'\fI is buggy\fR +.IX Subsection "select is buggy" +.PP +All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this +one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file +descriptors you can pass in to 1024 \- your program suddenly crashes when +you use more. +.PP +There is an undocumented \*(L"workaround\*(R" for this \- defining +\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR +work on \s-1OS/X.\s0 +.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0" +.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" +\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR +.IX Subsection "errno reentrancy" +.PP +The default compile environment on Solaris is unfortunately so +thread-unsafe that you can't even use components/libraries compiled +without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't +defined by default. A valid, if stupid, implementation choice. +.PP +If you want to use libev in threaded environments you have to make sure +it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined. +.PP +\fIEvent port backend\fR +.IX Subsection "Event port backend" +.PP +The scalable event interface for Solaris is called \*(L"event +ports\*(R". Unfortunately, this mechanism is very buggy in all major +releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get +a large number of spurious wakeups, make sure you have all the relevant +and latest kernel patches applied. No, I don't know which ones, but there +are multiple ones to apply, and afterwards, event ports actually work +great. +.PP +If you can't get it to work, you can try running the program by setting +the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and +\&\f(CW\*(C`select\*(C'\fR backends. +.SS "\s-1AIX POLL BUG\s0" +.IX Subsection "AIX POLL BUG" +\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around +this by trying to avoid the poll backend altogether (i.e. it's not even +compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine +with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway. +.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0" +.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" +\fIGeneral issues\fR +.IX Subsection "General issues" +.PP +Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev +requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 +model. Libev still offers limited functionality on this platform in +the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket +descriptors. This only applies when using Win32 natively, not when using +e.g. cygwin. Actually, it only applies to the microsofts own compilers, +as every compiler comes with a slightly differently broken/incompatible +environment. +.PP +Lifting these limitations would basically require the full +re-implementation of the I/O system. If you are into this kind of thing, +then note that glib does exactly that for you in a very portable way (note +also that glib is the slowest event library known to man). +.PP +There is no supported compilation method available on windows except +embedding it into other applications. +.PP +Sensible signal handling is officially unsupported by Microsoft \- libev +tries its best, but under most conditions, signals will simply not work. +.PP +Not a libev limitation but worth mentioning: windows apparently doesn't +accept large writes: instead of resulting in a partial write, windows will +either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large, +so make sure you only write small amounts into your sockets (less than a +megabyte seems safe, but this apparently depends on the amount of memory +available). +.PP +Due to the many, low, and arbitrary limits on the win32 platform and +the abysmal performance of winsockets, using a large number of sockets +is not recommended (and not reasonable). If your program needs to use +more than a hundred or so sockets, then likely it needs to use a totally +different implementation for windows, as libev offers the \s-1POSIX\s0 readiness +notification model, which cannot be implemented efficiently on windows +(due to Microsoft monopoly games). +.PP +A typical way to use libev under windows is to embed it (see the embedding +section for details) and use the following \fIevwrap.h\fR header file instead +of \fIev.h\fR: +.PP +.Vb 2 +\& #define EV_STANDALONE /* keeps ev from requiring config.h */ +\& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ +\& +\& #include "ev.h" +.Ve +.PP +And compile the following \fIevwrap.c\fR file into your project (make sure +you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!): +.PP +.Vb 2 +\& #include "evwrap.h" +\& #include "ev.c" +.Ve +.PP +\fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR +.IX Subsection "The winsocket select function" +.PP +The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it +requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is +also extremely buggy). This makes select very inefficient, and also +requires a mapping from file descriptors to socket handles (the Microsoft +C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the +discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and +\&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. +.PP +The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime +libraries and raw winsocket select is: +.PP +.Vb 2 +\& #define EV_USE_SELECT 1 +\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ +.Ve +.PP +Note that winsockets handling of fd sets is O(n), so you can easily get a +complexity in the O(nX) range when using win32. +.PP +\fILimited number of file descriptors\fR +.IX Subsection "Limited number of file descriptors" +.PP +Windows has numerous arbitrary (and low) limits on things. +.PP +Early versions of winsocket's select only supported waiting for a maximum +of \f(CW64\fR handles (probably owning to the fact that all windows kernels +can only wait for \f(CW64\fR things at the same time internally; Microsoft +recommends spawning a chain of threads and wait for 63 handles and the +previous thread in each. Sounds great!). +.PP +Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR +to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select +call (which might be in libev or elsewhere, for example, perl and many +other interpreters do their own select emulation on windows). +.PP +Another limit is the number of file descriptors in the Microsoft runtime +libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR +fetish or something like this inside Microsoft). You can increase this +by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR +(another arbitrary limit), but is broken in many versions of the Microsoft +runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets +(depending on windows version and/or the phase of the moon). To get more, +you need to wrap all I/O functions and provide your own fd management, but +the cost of calling select (O(nX)) will likely make this unworkable. +.SS "\s-1PORTABILITY REQUIREMENTS\s0" +.IX Subsection "PORTABILITY REQUIREMENTS" +In addition to a working ISO-C implementation and of course the +backend-specific APIs, libev relies on a few additional extensions: +.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 +.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 +.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." +Libev assumes not only that all watcher pointers have the same internal +structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also +assumes that the same (machine) code can be used to call any watcher +callback: The watcher callbacks have different type signatures, but libev +calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. +.IP "null pointers and integer zero are represented by 0 bytes" 4 +.IX Item "null pointers and integer zero are represented by 0 bytes" +Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and +relies on this setting pointers and integers to null. +.IP "pointer accesses must be thread-atomic" 4 +.IX Item "pointer accesses must be thread-atomic" +Accessing a pointer value must be atomic, it must both be readable and +writable in one piece \- this is the case on all current architectures. +.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 +.el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 +.IX Item "sig_atomic_t volatile must be thread-atomic as well" +The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as +\&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different +threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is +believed to be sufficiently portable. +.ie n .IP """sigprocmask"" must work in a threaded environment" 4 +.el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4 +.IX Item "sigprocmask must work in a threaded environment" +Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not +allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical +pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main +thread\*(R" or will block signals process-wide, both behaviours would +be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and +\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. +.Sp +The most portable way to handle signals is to block signals in all threads +except the initial one, and run the signal handling loop in the initial +thread as well. +.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 +.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 +.IX Item "long must be large enough for common memory allocation sizes" +To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally +instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX +systems (Microsoft...) this might be unexpectedly low, but is still at +least 31 bits everywhere, which is enough for hundreds of millions of +watchers. +.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 +.el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 +.IX Item "double must hold a time value in seconds with enough accuracy" +The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to +have at least 51 bits of mantissa (and 9 bits of exponent), which is +good enough for at least into the year 4000 with millisecond accuracy +(the design goal for libev). This requirement is overfulfilled by +implementations using \s-1IEEE 754,\s0 which is basically all existing ones. +.Sp +With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the +year 2255 (and millisecond accuracy till the year 287396 \- by then, libev +is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or +something like that, just kidding). +.PP +If you know of other additional requirements drop me a note. +.SH "ALGORITHMIC COMPLEXITIES" +.IX Header "ALGORITHMIC COMPLEXITIES" +In this section the complexities of (many of) the algorithms used inside +libev will be documented. For complexity discussions about backends see +the documentation for \f(CW\*(C`ev_default_init\*(C'\fR. +.PP +All of the following are about amortised time: If an array needs to be +extended, libev needs to realloc and move the whole array, but this +happens asymptotically rarer with higher number of elements, so O(1) might +mean that libev does a lengthy realloc operation in rare cases, but on +average it is much faster and asymptotically approaches constant time. +.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 +.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" +This means that, when you have a watcher that triggers in one hour and +there are 100 watchers that would trigger before that, then inserting will +have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. +.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 +.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" +That means that changing a timer costs less than removing/adding them, +as only the relative motion in the event queue has to be paid for. +.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4 +.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" +These just add the watcher into an array or at the head of a list. +.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4 +.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)" +.PD 0 +.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 +.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" +.PD +These watchers are stored in lists, so they need to be walked to find the +correct watcher to remove. The lists are usually short (you don't usually +have many watchers waiting for the same fd or signal: one is typical, two +is rare). +.IP "Finding the next timer in each loop iteration: O(1)" 4 +.IX Item "Finding the next timer in each loop iteration: O(1)" +By virtue of using a binary or 4\-heap, the next timer is always found at a +fixed position in the storage array. +.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 +.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" +A change means an I/O watcher gets started or stopped, which requires +libev to recalculate its status (and possibly tell the kernel, depending +on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used). +.IP "Activating one watcher (putting it into the pending state): O(1)" 4 +.IX Item "Activating one watcher (putting it into the pending state): O(1)" +.PD 0 +.IP "Priority handling: O(number_of_priorities)" 4 +.IX Item "Priority handling: O(number_of_priorities)" +.PD +Priorities are implemented by allocating some space for each +priority. When doing priority-based operations, libev usually has to +linearly search all the priorities, but starting/stopping and activating +watchers becomes O(1) with respect to priority handling. +.IP "Sending an ev_async: O(1)" 4 +.IX Item "Sending an ev_async: O(1)" +.PD 0 +.IP "Processing ev_async_send: O(number_of_async_watchers)" 4 +.IX Item "Processing ev_async_send: O(number_of_async_watchers)" +.IP "Processing signals: O(max_signal_number)" 4 +.IX Item "Processing signals: O(max_signal_number)" +.PD +Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR +calls in the current loop iteration and the loop is currently +blocked. Checking for async and signal events involves iterating over all +running async watchers or all signal numbers. +.SH "PORTING FROM LIBEV 3.X TO 4.X" +.IX Header "PORTING FROM LIBEV 3.X TO 4.X" +The major version 4 introduced some incompatible changes to the \s-1API.\s0 +.PP +At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions +for all changes, so most programs should still compile. The compatibility +layer might be removed in later versions of libev, so better update to the +new \s-1API\s0 early than late. +.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 +.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 +.IX Item "EV_COMPAT3 backwards compatibility mechanism" +The backward compatibility mechanism can be controlled by +\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0 +section. +.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 +.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 +.IX Item "ev_default_destroy and ev_default_fork have been removed" +These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: +.Sp +.Vb 2 +\& ev_loop_destroy (EV_DEFAULT_UC); +\& ev_loop_fork (EV_DEFAULT); +.Ve +.IP "function/symbol renames" 4 +.IX Item "function/symbol renames" +A number of functions and symbols have been renamed: +.Sp +.Vb 3 +\& ev_loop => ev_run +\& EVLOOP_NONBLOCK => EVRUN_NOWAIT +\& EVLOOP_ONESHOT => EVRUN_ONCE +\& +\& ev_unloop => ev_break +\& EVUNLOOP_CANCEL => EVBREAK_CANCEL +\& EVUNLOOP_ONE => EVBREAK_ONE +\& EVUNLOOP_ALL => EVBREAK_ALL +\& +\& EV_TIMEOUT => EV_TIMER +\& +\& ev_loop_count => ev_iteration +\& ev_loop_depth => ev_depth +\& ev_loop_verify => ev_verify +.Ve +.Sp +Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an +\&\f(CW\*(C`ev_loop_\*(C'\fR prefix, so it was removed; \f(CW\*(C`ev_loop\*(C'\fR, \f(CW\*(C`ev_unloop\*(C'\fR and +associated constants have been renamed to not collide with the \f(CW\*(C`struct +ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme +as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called +\&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR +typedef. +.ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4 +.el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4 +.IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES" +The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different +mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile +and work, but the library code will of course be larger. +.SH "GLOSSARY" +.IX Header "GLOSSARY" +.IP "active" 4 +.IX Item "active" +A watcher is active as long as it has been started and not yet stopped. +See \*(L"\s-1WATCHER STATES\*(R"\s0 for details. +.IP "application" 4 +.IX Item "application" +In this document, an application is whatever is using libev. +.IP "backend" 4 +.IX Item "backend" +The part of the code dealing with the operating system interfaces. +.IP "callback" 4 +.IX Item "callback" +The address of a function that is called when some event has been +detected. Callbacks are being passed the event loop, the watcher that +received the event, and the actual event bitset. +.IP "callback/watcher invocation" 4 +.IX Item "callback/watcher invocation" +The act of calling the callback associated with a watcher. +.IP "event" 4 +.IX Item "event" +A change of state of some external event, such as data now being available +for reading on a file descriptor, time having passed or simply not having +any other events happening anymore. +.Sp +In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or +\&\f(CW\*(C`EV_TIMER\*(C'\fR). +.IP "event library" 4 +.IX Item "event library" +A software package implementing an event model and loop. +.IP "event loop" 4 +.IX Item "event loop" +An entity that handles and processes external events and converts them +into callback invocations. +.IP "event model" 4 +.IX Item "event model" +The model used to describe how an event loop handles and processes +watchers and events. +.IP "pending" 4 +.IX Item "pending" +A watcher is pending as soon as the corresponding event has been +detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details. +.IP "real time" 4 +.IX Item "real time" +The physical time that is observed. It is apparently strictly monotonic :) +.IP "wall-clock time" 4 +.IX Item "wall-clock time" +The time and date as shown on clocks. Unlike real time, it can actually +be wrong and jump forwards and backwards, e.g. when you adjust your +clock. +.IP "watcher" 4 +.IX Item "watcher" +A data structure that describes interest in certain events. Watchers need +to be started (attached to an event loop) before they can receive events. +.SH "AUTHOR" +.IX Header "AUTHOR" +Marc Lehmann , with repeated corrections by Mikael +Magnusson and Emanuele Giaquinta, and minor corrections by many others. diff --git a/miniconda3/share/man/man3/ffi.3 b/miniconda3/share/man/man3/ffi.3 new file mode 100644 index 0000000000000000000000000000000000000000..1f1d3031c99772fb01aa08c126ea0e654aef5e2b --- /dev/null +++ b/miniconda3/share/man/man3/ffi.3 @@ -0,0 +1,41 @@ +.Dd February 15, 2008 +.Dt FFI 3 +.Sh NAME +.Nm FFI +.Nd Foreign Function Interface +.Sh LIBRARY +libffi, -lffi +.Sh SYNOPSIS +.In ffi.h +.Ft ffi_status +.Fo ffi_prep_cif +.Fa "ffi_cif *cif" +.Fa "ffi_abi abi" +.Fa "unsigned int nargs" +.Fa "ffi_type *rtype" +.Fa "ffi_type **atypes" +.Fc +.Ft void +.Fo ffi_prep_cif_var +.Fa "ffi_cif *cif" +.Fa "ffi_abi abi" +.Fa "unsigned int nfixedargs" +.Fa "unsigned int ntotalargs" +.Fa "ffi_type *rtype" +.Fa "ffi_type **atypes" +.Fc +.Ft void +.Fo ffi_call +.Fa "ffi_cif *cif" +.Fa "void (*fn)(void)" +.Fa "void *rvalue" +.Fa "void **avalue" +.Fc +.Sh DESCRIPTION +The foreign function interface provides a mechanism by which a function can +generate a call to another function at runtime without requiring knowledge of +the called function's interface at compile time. +.Sh SEE ALSO +.Xr ffi_prep_cif 3 , +.Xr ffi_prep_cif_var 3 , +.Xr ffi_call 3 diff --git a/miniconda3/share/man/man3/ffi_call.3 b/miniconda3/share/man/man3/ffi_call.3 new file mode 100644 index 0000000000000000000000000000000000000000..5351513f90d86e310cd8cffe31112c75057d664b --- /dev/null +++ b/miniconda3/share/man/man3/ffi_call.3 @@ -0,0 +1,103 @@ +.Dd February 15, 2008 +.Dt ffi_call 3 +.Sh NAME +.Nm ffi_call +.Nd Invoke a foreign function. +.Sh SYNOPSIS +.In ffi.h +.Ft void +.Fo ffi_call +.Fa "ffi_cif *cif" +.Fa "void (*fn)(void)" +.Fa "void *rvalue" +.Fa "void **avalue" +.Fc +.Sh DESCRIPTION +The +.Nm ffi_call +function provides a simple mechanism for invoking a function without +requiring knowledge of the function's interface at compile time. +.Fa fn +is called with the values retrieved from the pointers in the +.Fa avalue +array. The return value from +.Fa fn +is placed in storage pointed to by +.Fa rvalue . +.Fa cif +contains information describing the data types, sizes and alignments of the +arguments to and return value from +.Fa fn , +and must be initialized with +.Nm ffi_prep_cif +before it is used with +.Nm ffi_call . +.Pp +.Fa rvalue +must point to storage that is sizeof(ffi_arg) or larger for non-floating point +types. For smaller-sized return value types, the +.Nm ffi_arg +or +.Nm ffi_sarg +integral type must be used to hold +the return value. +.Sh EXAMPLES +.Bd -literal +#include +#include + +unsigned char +foo(unsigned int, float); + +int +main(int argc, const char **argv) +{ + ffi_cif cif; + ffi_type *arg_types[2]; + void *arg_values[2]; + ffi_status status; + + // Because the return value from foo() is smaller than sizeof(long), it + // must be passed as ffi_arg or ffi_sarg. + ffi_arg result; + + // Specify the data type of each argument. Available types are defined + // in . + arg_types[0] = &ffi_type_uint; + arg_types[1] = &ffi_type_float; + + // Prepare the ffi_cif structure. + if ((status = ffi_prep_cif(&cif, FFI_DEFAULT_ABI, + 2, &ffi_type_uint8, arg_types)) != FFI_OK) + { + // Handle the ffi_status error. + } + + // Specify the values of each argument. + unsigned int arg1 = 42; + float arg2 = 5.1; + + arg_values[0] = &arg1; + arg_values[1] = &arg2; + + // Invoke the function. + ffi_call(&cif, FFI_FN(foo), &result, arg_values); + + // The ffi_arg 'result' now contains the unsigned char returned from foo(), + // which can be accessed by a typecast. + printf("result is %hhu", (unsigned char)result); + + return 0; +} + +// The target function. +unsigned char +foo(unsigned int x, float y) +{ + unsigned char result = x - y; + return result; +} +.Ed +.Sh SEE ALSO +.Xr ffi 3 , +.Xr ffi_prep_cif 3 diff --git a/miniconda3/share/man/man3/ffi_prep_cif.3 b/miniconda3/share/man/man3/ffi_prep_cif.3 new file mode 100644 index 0000000000000000000000000000000000000000..ab2be8adc17a19af2507c495887fce1c31c7a4e7 --- /dev/null +++ b/miniconda3/share/man/man3/ffi_prep_cif.3 @@ -0,0 +1,68 @@ +.Dd February 15, 2008 +.Dt ffi_prep_cif 3 +.Sh NAME +.Nm ffi_prep_cif +.Nd Prepare a +.Nm ffi_cif +structure for use with +.Nm ffi_call +. +.Sh SYNOPSIS +.In ffi.h +.Ft ffi_status +.Fo ffi_prep_cif +.Fa "ffi_cif *cif" +.Fa "ffi_abi abi" +.Fa "unsigned int nargs" +.Fa "ffi_type *rtype" +.Fa "ffi_type **atypes" +.Fc +.Sh DESCRIPTION +The +.Nm ffi_prep_cif +function prepares a +.Nm ffi_cif +structure for use with +.Nm ffi_call +. +.Fa abi +specifies a set of calling conventions to use. +.Fa atypes +is an array of +.Fa nargs +pointers to +.Nm ffi_type +structs that describe the data type, size and alignment of each argument. +.Fa rtype +points to an +.Nm ffi_type +that describes the data type, size and alignment of the +return value. Note that to call a variadic function +.Nm ffi_prep_cif_var +must be used instead. +.Sh RETURN VALUES +Upon successful completion, +.Nm ffi_prep_cif +returns +.Nm FFI_OK . +It will return +.Nm FFI_BAD_TYPEDEF +if +.Fa cif +is +.Nm NULL +or +.Fa atypes +or +.Fa rtype +is malformed. If +.Fa abi +does not refer to a valid ABI, +.Nm FFI_BAD_ABI +will be returned. Available ABIs are +defined in +.Nm . +.Sh SEE ALSO +.Xr ffi 3 , +.Xr ffi_call 3 , +.Xr ffi_prep_cif_var 3 diff --git a/miniconda3/share/man/man3/ffi_prep_cif_var.3 b/miniconda3/share/man/man3/ffi_prep_cif_var.3 new file mode 100644 index 0000000000000000000000000000000000000000..7e19d0b070f17fed3f0890dd433e188b890d1466 --- /dev/null +++ b/miniconda3/share/man/man3/ffi_prep_cif_var.3 @@ -0,0 +1,73 @@ +.Dd January 25, 2011 +.Dt ffi_prep_cif_var 3 +.Sh NAME +.Nm ffi_prep_cif_var +.Nd Prepare a +.Nm ffi_cif +structure for use with +.Nm ffi_call +for variadic functions. +.Sh SYNOPSIS +.In ffi.h +.Ft ffi_status +.Fo ffi_prep_cif_var +.Fa "ffi_cif *cif" +.Fa "ffi_abi abi" +.Fa "unsigned int nfixedargs" +.Fa "unsigned int ntotalargs" +.Fa "ffi_type *rtype" +.Fa "ffi_type **atypes" +.Fc +.Sh DESCRIPTION +The +.Nm ffi_prep_cif_var +function prepares a +.Nm ffi_cif +structure for use with +.Nm ffi_call +for variadic functions. +.Fa abi +specifies a set of calling conventions to use. +.Fa atypes +is an array of +.Fa ntotalargs +pointers to +.Nm ffi_type +structs that describe the data type, size and alignment of each argument. +.Fa rtype +points to an +.Nm ffi_type +that describes the data type, size and alignment of the +return value. +.Fa nfixedargs +must contain the number of fixed (non-variadic) arguments. +Note that to call a non-variadic function +.Nm ffi_prep_cif +must be used. +.Sh RETURN VALUES +Upon successful completion, +.Nm ffi_prep_cif_var +returns +.Nm FFI_OK . +It will return +.Nm FFI_BAD_TYPEDEF +if +.Fa cif +is +.Nm NULL +or +.Fa atypes +or +.Fa rtype +is malformed. If +.Fa abi +does not refer to a valid ABI, +.Nm FFI_BAD_ABI +will be returned. Available ABIs are +defined in +.Nm +. +.Sh SEE ALSO +.Xr ffi 3 , +.Xr ffi_call 3 , +.Xr ffi_prep_cif 3 diff --git a/miniconda3/share/man/man3/gettext.3 b/miniconda3/share/man/man3/gettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..8a6e4ce0cb4eb120cb7d5ae6e7892840d32b0df3 --- /dev/null +++ b/miniconda3/share/man/man3/gettext.3 @@ -0,0 +1,99 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH GETTEXT 3 "November 2024" "GNU gettext 0.25.1" +.SH NAME +gettext, dgettext, dcgettext \- translate message +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * gettext (const char * " msgid ); +.BI "char * dgettext (const char * " domainname ", const char * " msgid ); +.BI "char * dcgettext (const char * " domainname ", const char * " msgid , +.BI " int " category ); +.fi +.SH DESCRIPTION +The \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions attempt to +translate a text string into the user's native language, by looking up the +translation in a message catalog. +.PP +The \fImsgid\fP argument identifies the message to be translated. By +convention, it is the English version of the message, with non-ASCII +characters replaced by ASCII approximations. This choice allows the +translators to work with message catalogs, called PO files, that contain +both the English and the translated versions of each message, and can be +installed using the \fBmsgfmt\fP utility. +.PP +A message domain is a set of translatable \fImsgid\fP messages. Usually, +every software package has its own message domain. The domain name is used +to determine the message catalog where the translation is looked up; it must +be a non-empty string. For the \fBgettext\fP function, it is specified through +a preceding \fBtextdomain\fP call. For the \fBdgettext\fP and \fBdcgettext\fP +functions, it is passed as the \fIdomainname\fP argument; if this argument is +NULL, the domain name specified through a preceding \fBtextdomain\fP call is +used instead. +.PP +Translation lookup operates in the context of the current locale. For the +\fBgettext\fP and \fBdgettext\fP functions, the \fBLC_MESSAGES\fP locale +facet is used. It is determined by a preceding call to the \fBsetlocale\fP +function. \fBsetlocale (LC_ALL, "")\fP initializes the \fBLC_MESSAGES\fP locale +based on the first nonempty value of the three environment variables +\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP; see \fBsetlocale\fP(3). For the +\fBdcgettext\fP function, the locale facet is determined by the \fIcategory\fP +argument, which should be one of the \fBLC_xxx\fP constants defined in the + header, excluding \fBLC_ALL\fP. In both cases, the functions also +use the \fBLC_CTYPE\fP locale facet in order to convert the translated message +from the translator's codeset to the current locale's codeset, unless +overridden by a prior call to the \fBbind_textdomain_codeset\fP function. +.PP +The message catalog used by the functions is at the pathname +\fIdirname\fP/\fIlocale\fP/\fIcategory\fP/\fIdomainname\fP.mo. Here +\fIdirname\fP is the directory specified through \fBbindtextdomain\fP. Its +default is system and configuration dependent; typically it is +\fIprefix\fP/share/locale, where \fIprefix\fP is the installation prefix of the +package. \fIlocale\fP is the name of the current locale facet; the GNU +implementation also tries generalizations, such as the language name without +the territory name. \fIcategory\fP is \fBLC_MESSAGES\fP for the \fBgettext\fP +and \fBdgettext\fP functions, or the argument passed to the \fBdcgettext\fP +function. +.PP +If the \fBLANGUAGE\fP environment variable is set to a nonempty value, and the +locale is not the "C" locale, the value of \fBLANGUAGE\fP is assumed to contain +a colon separated list of locale names. The functions will attempt to look up +a translation of \fImsgid\fP in each of the locales in turn. This is a GNU +extension. +.PP +In the "C" locale, or if none of the used catalogs contain a translation for +\fImsgid\fP, the \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions +return \fImsgid\fP. +.SH "RETURN VALUE" +If a translation was found in one of the specified catalogs, it is converted +to the locale's codeset and returned. The resulting string is statically +allocated and must not be modified or freed. Otherwise \fImsgid\fP is returned. +.SH ERRORS +\fBerrno\fP is not modified. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.PP +When an empty string is used for \fImsgid\fP, the functions may return a +nonempty string. +.SH "SEE ALSO" +.BR ngettext (3), +.BR dngettext (3), +.BR dcngettext (3), +.BR setlocale (3), +.BR textdomain (3), +.BR bindtextdomain (3), +.BR bind_textdomain_codeset (3), +.BR msgfmt (1) diff --git a/miniconda3/share/man/man3/history.3 b/miniconda3/share/man/man3/history.3 new file mode 100644 index 0000000000000000000000000000000000000000..53be12014358a2e4ab808860b449070d9f40aa55 --- /dev/null +++ b/miniconda3/share/man/man3/history.3 @@ -0,0 +1,799 @@ +.\" +.\" MAN PAGE COMMENTS to +.\" +.\" Chet Ramey +.\" Information Network Services +.\" Case Western Reserve University +.\" chet.ramey@case.edu +.\" +.\" Last Change: Tue Dec 31 13:35:52 EST 2024 +.\" +.TH HISTORY 3 "2024 December 31" "GNU History 8.3" +.\" +.ie \n(.g \{\ +.ds ' \(aq +.ds " \(dq +.ds ^ \(ha +.ds ~ \(ti +.\} +.el \{\ +.ds ' ' +.\" \*" is not usable in macro arguments on AT&T troff (DWB, Solaris 10) +.ds " ""\" two adjacent quotes and no space before this comment +.ds ^ ^ +.ds ~ ~ +.\} +. +.\" Fix broken EX/EE macros on DWB troff. +.\" Detect it: only DWB sets up a `)Y` register. +.if \n(.g .nr )Y 0 \" silence "groff -wreg" warning +.if \n()Y \{\ +.\" Revert the undesired changes to indentation. +.am EX +.in -5n +.. +.am EE +.in +5n +.. +.\} +. +.\" File Name macro. This used to be `.PN', for Path Name, +.\" but Sun doesn't seem to like that very much. +.\" \% at the beginning of the string protects the filename from hyphenation. +.\" +.de FN +\%\fI\|\\$1\|\fP +.. +.\" +.\" Quotation macro: generate consistent quoted strings that don't rely +.\" on the presence of the `CW' constant-width font. +.\" +.de Q +.ie \n(.g \(lq\\$1\(rq\\$2 +.el \{\ +. if t ``\\$1''\\$2 +. if n "\\$1"\\$2 +.\} +.. +.ds lp \fR\|(\fP +.ds rp \fR\|)\fP +.\" FnN return-value fun-name N arguments +.de F1 +\fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3\fP\\*(rp +.br +.. +.de F2 +.if t \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3,\|\\$4\fP\\*(rp +.if n \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3, \\$4\fP\\*(rp +.br +.. +.de F3 +.if t \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3,\|\\$4,\|\\$5\fP\|\\*(rp +.if n \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3, \\$4, \\$5\fP\\*(rp +.br +.. +.de Vb +\fI\\$1\fP \fB\\$2\fP +.br +.. +.SH NAME +history \- GNU History Library +.SH COPYRIGHT +.if t The GNU History Library is Copyright \(co 1989-2025 by the Free Software Foundation, Inc. +.if n The GNU History Library is Copyright (C) 1989-2025 by the Free Software Foundation, Inc. +.SH DESCRIPTION +Many programs read input from the user a line at a time. +The GNU +History library is able to keep track of those lines, associate arbitrary +data with each line, and utilize information from previous lines when +composing new ones. +.PP +The History library provides functions that allow applications to their +\fIhistory\fP, the set of previously-typed lines, +which it keeps in a list. +Applications can choose which lines to save into a history list, how +many commands to save, save a history list to a file, read a history +list from a file, and display lines from the history in various +formats. +.SH "HISTORY EXPANSION" +The history library supports a history expansion feature that +is identical to the history expansion in +.BR bash . +This section describes what syntax features are available. +.PP +History expansions introduce words from the history list into +the input stream, making it easy to repeat commands, insert the +arguments to a previous command into the current input line, or +fix errors in previous commands quickly. +.PP +History expansion is usually performed immediately after a complete line +is read. +It takes place in two parts. +The first is to determine which history list entry +to use during substitution. +The second is to select portions of that entry to include into +the current one. +.PP +The entry selected from the history is the \fIevent\fP, +and the portions of that entry that are acted upon are \fIwords\fP. +Various \fImodifiers\fP are available to manipulate the selected words. +The entry is split into words in the same fashion as \fBbash\fP +does when reading input, +so that several words that would otherwise be separated +are considered one word when surrounded by quotes (see the +description of \fBhistory_tokenize()\fP below). +The \fIevent designator\fP selects the event, the optional +\fIword designator\fP selects words from the event, and +various optional \fImodifiers\fP are available to manipulate the +selected words. +.PP +History expansions are introduced by the appearance of the +history expansion character, which is \^\fB!\fP\^ by default. +History expansions may appear anywhere in the input, but do not nest. +.PP +Only backslash (\^\fB\e\fP\^) and single quotes can quote +the history expansion character. +.PP +There is a special abbreviation for substitution, active when the +\fIquick substitution\fP character (default \fB\*^\fP) +is the first character on the line. +It selects the previous history list entry, using an event designator +equivalent to \fB!!\fP, +and substitutes one string for another in that entry. +It is described below under \fBEvent Designators\fP. +This is the only history expansion that does not begin with the history +expansion character. +.SS Event Designators +An event designator is a reference to an entry in the history list. +The event designator +consists of the portion of the word beginning with the history +expansion character and ending with the word designator if present, +or the end of the word. +Unless the reference is absolute, events are relative to the current +position in the history list. +.PP +.PD 0 +.TP +.B ! +Start a history substitution, except when followed by a +.BR blank , +newline, carriage return, =, +or (. +.TP +.B !\fIn\fP +Refer to history list entry +.IR n . +.TP +.B !\-\fIn\fP +Refer to the current entry minus +.IR n . +.TP +.B !! +Refer to the previous entry. +This is a synonym for +.Q !\-1 . +.TP +.B !\fIstring\fP +Refer to the most recent command preceding the current position in the +history list starting with +.IR string . +.TP +.B !?\fIstring\fR\fB[?]\fP +Refer to the most recent command preceding the current position in the +history list containing +.IR string . +The trailing \fB?\fP may be omitted if +.I string +is followed immediately by a newline. +If \fIstring\fP is missing, this uses +the string from the most recent search; +it is an error if there is no previous search string. +.TP +.B \d\s+2\*^\s-2\u\fIstring1\fP\d\s+2\*^\s-2\u\fIstring2\fP\d\s+2\*^\s-2\u +.\" was .B \*^\fIstring1\fP\*^\fIstring2\fP\*^ +Quick substitution. +Repeat the previous command, replacing +.I string1 +with +.IR string2 . +Equivalent to +.Q !!:s\d\s+2\*^\s-2\u\fIstring1\fP\d\s+2\*^\s-2\u\fIstring2\fP\d\s+2\*^\s-2\u +.\" was .Q !!:s\*^\fIstring1\fP\*^\fIstring2\fP\*^ +(see \fBModifiers\fP below). +.TP +.B !# +The entire command line typed so far. +.PD +.SS Word Designators +Word designators are used to select desired words from the event. +They are optional; if the word designator isn't supplied, the history +expansion uses the entire event. +A +.B : +separates the event specification from the word designator. +It may be omitted if the word designator begins with a +.BR \*^ , +.BR $ , +.BR * , +.BR \- , +or +.BR % . +Words are numbered from the beginning of the line, +with the first word being denoted by 0 (zero). +Words are inserted into the current line separated by single spaces. +.PP +.PD 0 +.TP +.B 0 (zero) +The zeroth word. +For the shell, and many other applications, this is the command word. +.TP +.I n +The \fIn\fPth word. +.TP +.B \*^ +The first argument: word 1. +.TP +.B $ +The last word. +This is usually the last argument, but expands to the +zeroth word if there is only one word in the line. +.TP +.B % +The first word matched by the most recent +.Q ?\fIstring\fP? +search, +if the search string begins with a character that is part of a word. +By default, searches begin at the end of each line and proceed to the +beginning, so the first word matched is the one closest to the end of +the line. +.TP +.I x\fB\-\fPy +A range of words; +.Q \-\fIy\fP +abbreviates +.Q 0\-\fIy\fP . +.TP +.B * +All of the words but the zeroth. +This is a synonym for +.Q \fI1\-$\fP . +It is not an error to use +.B * +if there is just one word in the event; +it expands to the empty string in that case. +.TP +.B x* +Abbreviates \fIx\-$\fP. +.TP +.B x\- +Abbreviates \fIx\-$\fP like \fBx*\fP, but omits the last word. +If \fBx\fP is missing, it defaults to 0. +.PD +.PP +If a word designator is supplied without an event specification, the +previous command is used as the event, equivalent to \fB!!\fP. +.SS Modifiers +After the optional word designator, the expansion may include a +sequence of one or more of the following modifiers, each preceded by a +.Q : . +These modify, or edit, the word or words selected from the history event. +.PP +.PD 0 +.TP +.B h +Remove a trailing filename component, leaving only the head. +.TP +.B t +Remove all leading filename components, leaving the tail. +.TP +.B r +Remove a trailing suffix of the form \fI.xxx\fP, leaving the +basename. +.TP +.B e +Remove all but the trailing suffix. +.TP +.B p +Print the new command but do not execute it. +.TP +.B q +Quote the substituted words, escaping further substitutions. +.TP +.B x +Quote the substituted words as with +.BR q , +but break into words at +.B blanks +and newlines. +The \fBq\fP and \fBx\fP modifiers are mutually exclusive; +expansion uses the last one supplied. +.TP +.B s/\fIold\fP/\fInew\fP/ +Substitute +.I new +for the first occurrence of +.I old +in the event line. +Any character may be used as the delimiter in place of /. +The final delimiter is optional if it is the last character of the +event line. +A single backslash quotes the delimiter in +.I old +and +.IR new . +If & appears in +.IR new , +it is replaced with +.IR old . +A single backslash quotes the &. +If +.I old +is null, it is set to the last +.I old +substituted, or, if no previous history substitutions took place, +the last +.I string +in a +.B !?\fIstring\fP[?] +search. +If +.I new +is null, each matching +.I old +is deleted. +.TP +.B & +Repeat the previous substitution. +.TP +.B g +Cause changes to be applied over the entire event line. +This is used in conjunction with +.Q \fB:s\fP +(e.g., +.Q \fB:gs/\fIold\fP/\fInew\fP/\fR ) +or +.Q \fB:&\fP . +If used with +.Q \fB:s\fP , +any delimiter can be used in place of /, +and the final delimiter is optional +if it is the last character of the event line. +An \fBa\fP may be used as a synonym for \fBg\fP. +.TP +.B G +Apply the following +.Q \fBs\fP +or +.Q \fB&\fP +modifier once to each word in the event line. +.PD +.SH "PROGRAMMING WITH HISTORY FUNCTIONS" +This section describes how to use the History library in other programs. +.SS "Introduction to History" +A programmer using the History library has available functions +for remembering lines on a history list, associating arbitrary data +with a line, removing lines from the list, searching through the list +for a line containing an arbitrary text string, and referencing any line +in the list directly. In addition, a history \fIexpansion\fP function +is available which provides for a consistent user interface across +different programs. +.PP +The user using programs written with the History library has the +benefit of a consistent user interface with a set of well-known +commands for manipulating the text of previous lines and using that text +in new commands. The basic history manipulation commands are +identical to +the history substitution provided by \fBbash\fP. +.PP +The programmer can also use the readline library, which +includes some history manipulation by default, and has the added +advantage of command line editing. +.PP +Before declaring any functions using any functionality the History +library provides in other code, an application writer should include +the file +.FN +in any file that uses the +History library's features. It supplies extern declarations for all +of the library's public functions and variables, and declares all of +the public data structures. +.SS History Storage +The history list is an array of history entries. A history entry is +declared as follows: +.PP +.Vb "typedef void *" histdata_t; +.PP +.nf +.EX +typedef struct _hist_entry { + char *line; + char *timestamp; + histdata_t data; +} HIST_ENTRY; +.EE +.fi +.PP +The history list itself might therefore be declared as +.PP +.Vb "HIST_ENTRY **" the_history_list; +.PP +The state of the History library is encapsulated into a single structure: +.PP +.nf +.EX +/* + * A structure used to pass around the current state of the history. + */ +typedef struct _hist_state { + HIST_ENTRY **entries; /* Pointer to entry records. */ + int offset; /* The current record. */ + int length; /* Number of records in list. */ + int size; /* Number of records allocated. */ + int flags; +} HISTORY_STATE; +.EE +.fi +.PP +If the flags member includes \fBHS_STIFLED\fP, the history has been +stifled. +.SH "History Functions" +This section describes the calling sequence for the various functions +exported by the GNU History library. +.SS Initializing History and State Management +This section describes functions used to initialize and manage +the state of the History library when you want to use the history +functions in your program. +.PP +.F1 void using_history void +Begin a session in which the history functions might be used. This +initializes the interactive variables. +.PP +.F1 "HISTORY_STATE *" history_get_history_state void +Return a structure describing the current state of the input history. +.PP +.F1 void history_set_history_state "HISTORY_STATE *state" +Set the state of the history list according to \fIstate\fP. +.SS History List Management +These functions manage individual entries on the history list, or set +parameters managing the list itself. +.PP +.F1 void add_history "const char *string" +Place \fIstring\fP at the end of the history list. The associated data +field (if any) is set to \fBNULL\fP. +If the maximum number of history entries has been set using +\fBstifle_history()\fP, and the new number of history entries would exceed +that maximum, the oldest history entry is removed. +.PP +.F1 void add_history_time "const char *string" +Change the time stamp associated with the most recent history entry to +\fIstring\fP. +.PP +.F1 "HIST_ENTRY *" remove_history "int which" +Remove history entry at offset \fIwhich\fP from the history. The +removed element is returned so you can free the line, data, +and containing structure. +.PP +.F1 "histdata_t" free_history_entry "HIST_ENTRY *histent" +Free the history entry \fIhistent\fP and any history library private +data associated with it. Returns the application-specific data +so the caller can dispose of it. +.PP +.F3 "HIST_ENTRY *" replace_history_entry "int which" "const char *line" "histdata_t data" +Make the history entry at offset \fIwhich\fP have \fIline\fP and \fIdata\fP. +This returns the old entry so the caller can dispose of any +application-specific data. In the case +of an invalid \fIwhich\fP, a \fBNULL\fP pointer is returned. +.PP +.F1 void clear_history "void" +Clear the history list by deleting all the entries. +.PP +.F1 void stifle_history "int max" +Stifle the history list, remembering only the last \fImax\fP entries. +The history list will contain only \fImax\fP entries at a time. +.PP +.F1 int unstifle_history "void" +Stop stifling the history. This returns the previously-set +maximum number of history entries (as set by \fBstifle_history()\fP). +history was stifled. +The value is positive if the history was +stifled, negative if it wasn't. +.PP +.F1 int history_is_stifled "void" +Returns non-zero if the history is stifled, zero if it is not. +.SS Information About the History List +These functions return information about the entire history list or +individual list entries. +.PP +.F1 "HIST_ENTRY **" history_list "void" +Return a \fBNULL\fP terminated array of \fIHIST_ENTRY *\fP which is the +current input history. Element 0 of this list is the beginning of time. +If there is no history, return \fBNULL\fP. +.PP +.F1 int where_history "void" +Returns the offset of the current history element. +.PP +.F1 "HIST_ENTRY *" current_history "void" +Return the history entry at the current position, as determined by +\fBwhere_history()\fP. If there is no entry there, return a \fBNULL\fP +pointer. +.PP +.F1 "HIST_ENTRY *" history_get "int offset" +Return the history entry at position \fIoffset\fP. +The range of valid values of \fIoffset\fP starts at \fBhistory_base\fP +and ends at \fBhistory_length\fP \- 1. +If there is no entry there, or if \fIoffset\fP is outside the valid +range, return a \fBNULL\fP pointer. +.PP +.F1 "time_t" history_get_time "HIST_ENTRY *" +Return the time stamp associated with the history entry passed as the argument. +.PP +.F1 int history_total_bytes "void" +Return the number of bytes that the primary history entries are using. +This function returns the sum of the lengths of all the lines in the +history. +.SS Moving Around the History List +These functions allow the current index into the history list to be +set or changed. +.PP +.F1 int history_set_pos "int pos" +Set the current history offset to \fIpos\fP, an absolute index +into the list. +Returns 1 on success, 0 if \fIpos\fP is less than zero or greater +than the number of history entries. +.PP +.F1 "HIST_ENTRY *" previous_history "void" +Back up the current history offset to the previous history entry, and +return a pointer to that entry. If there is no previous entry, return +a \fBNULL\fP pointer. +.PP +.F1 "HIST_ENTRY *" next_history "void" +If the current history offset refers to a valid history entry, +increment the current history offset. +If the possibly-incremented history offset refers to a valid history +entry, return a pointer to that entry; +otherwise, return a \fBNULL\fP pointer. +.SS Searching the History List +These functions allow searching of the history list for entries containing +a specific string. Searching may be performed both forward and backward +from the current history position. The search may be \fIanchored\fP, +meaning that the string must match at the beginning of the history entry. +.PP +.F2 int history_search "const char *string" "int direction" +Search the history for \fIstring\fP, starting at the current history offset. +If \fIdirection\fP is less than 0, then the search is through +previous entries, otherwise through subsequent entries. +If \fIstring\fP is found, then +the current history index is set to that history entry, and the value +returned is the offset in the line of the entry where +\fIstring\fP was found. +Otherwise, nothing is changed, and the function returns \-1. +.PP +.F2 int history_search_prefix "const char *string" "int direction" +Search the history for \fIstring\fP, starting at the current history +offset. The search is anchored: matching lines must begin with +\fIstring\fP. If \fIdirection\fP is less than 0, then the search is +through previous entries, otherwise through subsequent entries. +If \fIstring\fP is found, then the +current history index is set to that entry, and the return value is 0. +Otherwise, nothing is changed, and the function returns \-1. +.PP +.F3 int history_search_pos "const char *string" "int direction" "int pos" +Search for \fIstring\fP in the history list, starting at \fIpos\fP, an +absolute index into the list. If \fIdirection\fP is negative, the search +proceeds backward from \fIpos\fP, otherwise forward. Returns the absolute +index of the history element where \fIstring\fP was found, or \-1 otherwise. +.SS Managing the History File +The History library can read the history from and write it to a file. +This section documents the functions for managing a history file. +.PP +.F1 int read_history "const char *filename" +Add the contents of \fIfilename\fP to the history list, a line at a time. +If \fIfilename\fP is \fBNULL\fP, then read from \fI\*~/.history\fP. +Returns 0 if successful, or \fBerrno\fP if not. +.PP +.F3 int read_history_range "const char *filename" "int from" "int to" +Read a range of lines from \fIfilename\fP, adding them to the history list. +Start reading at line \fIfrom\fP and end at \fIto\fP. +If \fIfrom\fP is zero, start at the beginning. If \fIto\fP is less than +\fIfrom\fP, then read until the end of the file. If \fIfilename\fP is +\fBNULL\fP, then read from \fI\*~/.history\fP. Returns 0 if successful, +or \fBerrno\fP if not. +.PP +.F1 int write_history "const char *filename" +Write the current history to \fIfilename\fP, overwriting \fIfilename\fP +if necessary. +If \fIfilename\fP is \fBNULL\fP, then write the history list to \fI\*~/.history\fP. +Returns 0 on success, or \fBerrno\fP on a read or write error. +.PP +.F2 int append_history "int nelements" "const char *filename" +Append the last \fInelements\fP of the history list to \fIfilename\fP. +If \fIfilename\fP is \fBNULL\fP, then append to \fI\*~/.history\fP. +Returns 0 on success, or \fBerrno\fP on a read or write error. +.PP +.F2 int history_truncate_file "const char *filename" "int nlines" +Truncate the history file \fIfilename\fP, leaving only the last +\fInlines\fP lines. +If \fIfilename\fP is \fBNULL\fP, then \fI\*~/.history\fP is truncated. +Returns 0 on success, or \fBerrno\fP on failure. +.SS History Expansion +These functions implement history expansion. +.PP +.F2 int history_expand "const char *string" "char **output" +Expand \fIstring\fP, placing the result into \fIoutput\fP, a pointer +to a string. Returns: +.RS +.PD 0 +.TP +0 +If no expansions took place (or, if the only change in +the text was the removal of escape characters preceding the history expansion +character); +.TP +1 +if expansions did take place; +.TP +\-1 +if there was an error in expansion; +.TP +2 +if the returned line should be displayed, but not executed, +as with the \fB:p\fP modifier. +.PD +.RE +If an error occurred in expansion, then \fIoutput\fP contains a descriptive +error message. +.PP +.F3 "char *" get_history_event "const char *string" "int *cindex" "int qchar" +Returns the text of the history event beginning at \fIstring\fP + +\fI*cindex\fP. \fI*cindex\fP is modified to point to after the event +specifier. At function entry, \fIcindex\fP points to the index into +\fIstring\fP where the history event specification begins. \fIqchar\fP +is a character that is allowed to end the event specification in addition +to the +.Q normal +terminating characters. +.PP +.F1 "char **" history_tokenize "const char *string" +Return an array of tokens parsed out of \fIstring\fP, much as the +shell might. +The tokens are split on the characters in the +\fBhistory_word_delimiters\fP variable, +and shell quoting conventions are obeyed. +.PP +.F3 "char *" history_arg_extract "int first" "int last" "const char *string" +Extract a string segment consisting of the \fIfirst\fP through \fIlast\fP +arguments present in \fIstring\fP. Arguments are split using +\fBhistory_tokenize()\fP. +.SS History Variables +This section describes the externally-visible variables exported by +the GNU History Library. +.PP +.Vb int history_base +The logical offset of the first entry in the history list. +.PP +.Vb int history_length +The number of entries currently stored in the history list. +.PP +.Vb int history_max_entries +The maximum number of history entries. This must be changed using +\fBstifle_history()\fP. +.PP +.Vb int history_write_timestamps +If non-zero, timestamps are written to the history file, so they can be +preserved between sessions. The default value is 0, meaning that +timestamps are not saved. +The current timestamp format uses the value of \fIhistory_comment_char\fP +to delimit timestamp entries in the history file. +If that variable does +not have a value (the default), +the history library will not write timestamps. +.PP +.Vb char history_expansion_char +The character that introduces a history event. +The default is \fB!\fP. +Setting this to 0 inhibits history expansion. +.PP +.Vb char history_subst_char +The character that invokes word substitution if found at the start of +a line. +The default is \fB\*^\fP. +.PP +.Vb char history_comment_char +During tokenization, if this character is seen as the first character +of a word, then it and all subsequent characters up to a newline are +ignored, suppressing history expansion for the remainder of the line. +This is disabled by default. +.PP +.Vb "char *" history_word_delimiters +The characters that separate tokens for \fBhistory_tokenize()\fP. +The default value is \fB\*"\ \et\en()<>;&|\*"\fP. +.PP +.Vb "char *" history_no_expand_chars +The list of characters which inhibit history expansion if found immediately +following \fBhistory_expansion_char\fP. The default is space, tab, newline, +\fB\er\fP, and \fB=\fP. +.PP +.Vb "char *" history_search_delimiter_chars +The list of additional characters which can delimit a history search +string, in addition to space, tab, \fI:\fP and \fI?\fP in the case of +a substring search. The default is empty. +.PP +.Vb int history_quotes_inhibit_expansion +If non-zero, the history expansion code implements shell-like quoting: +single-quoted words are not scanned for the history expansion +character or the history comment character, and double-quoted words may +have history expansion performed, since single quotes are not special +within double quotes. +The default value is 0. +.PP +.Vb int history_quoting_state +An application may set this variable to indicate that the current line +being expanded is subject to existing quoting. +If set to \fI\*'\fP, +history expansion assumes that the line is single-quoted and +inhibit expansion until it reads an unquoted closing single quote; +if set to \fI\*"\fP, history expansion assumes the line is double quoted +until it reads an unquoted closing double quote. +If set to zero, the default, +history expansion assumes the line is not quoted and +treats quote characters within the line as described above. +This is only effective if \fBhistory_quotes_inhibit_expansion\fP is set. +.PP +.Vb "rl_linebuf_func_t *" history_inhibit_expansion_function +This should be set to the address of a function that takes two arguments: +a \fBchar *\fP (\fIstring\fP) +and an \fBint\fP index into that string (\fIi\fP). +It should return a non-zero value if the history expansion starting at +\fIstring[i]\fP should not be performed; zero if the expansion should +be done. +It is intended for use by applications like \fBbash\fP that use the history +expansion character for additional purposes. +By default, this variable is set to \fBNULL\fP. +.SH FILES +.PD 0 +.TP +.FN \*~/.history +Default filename for reading and writing saved history +.PD +.SH "SEE ALSO" +.PD 0 +.TP +\fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey +.TP +\fIThe Gnu History Library\fP, Brian Fox and Chet Ramey +.TP +\fIbash\fP(1) +.TP +\fIreadline\fP(3) +.PD +.SH AUTHORS +Brian Fox, Free Software Foundation +.br +bfox@gnu.org +.PP +Chet Ramey, Case Western Reserve University +.br +chet.ramey@case.edu +.SH BUG REPORTS +If you find a bug in the +.B history +library, you should report it. But first, you should +make sure that it really is a bug, and that it appears in the latest +version of the +.B history +library that you have. +.PP +Once you have determined that a bug actually exists, mail a +bug report to \fIbug\-readline\fP@\fIgnu.org\fP. +If you have a fix, you are welcome to mail that +as well! Suggestions and +.Q philosophical +bug reports may be mailed +to \fIbug\-readline\fP@\fIgnu.org\fP or posted to the Usenet +newsgroup +.BR gnu.bash.bug . +.PP +Comments and bug reports concerning +this manual page should be directed to +.IR chet.ramey@case.edu . diff --git a/miniconda3/share/man/man3/libarchive.3 b/miniconda3/share/man/man3/libarchive.3 new file mode 100644 index 0000000000000000000000000000000000000000..c67172bf654f3d731e28f4af61efb1137674f9f9 --- /dev/null +++ b/miniconda3/share/man/man3/libarchive.3 @@ -0,0 +1,297 @@ +.\" Copyright (c) 2003-2007 Tim Kientzle +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd March 18, 2012 +.Dt LIBARCHIVE 3 +.Os +.Sh NAME +.Nm libarchive +.Nd functions for reading and writing streaming archives +.Sh OVERVIEW +The +.Nm +library provides a flexible interface for reading and writing +archives in various formats such as tar and cpio. +.Nm +also supports reading and writing archives compressed using +various compression filters such as gzip and bzip2. +The library is inherently stream-oriented; readers serially iterate through +the archive, writers serially add things to the archive. +In particular, note that there is currently no built-in support for +random access nor for in-place modification. +.Pp +When reading an archive, the library automatically detects the +format and the compression. +The library currently has read support for: +.Bl -bullet -compact +.It +old-style tar archives, +.It +most variants of the POSIX +.Dq ustar +format, +.It +the POSIX +.Dq pax interchange +format, +.It +GNU-format tar archives, +.It +most common cpio archive formats, +.It +7-Zip archives, +.It +ar archives (including GNU/SysV and BSD extensions), +.It +Microsoft CAB archives, +.It +ISO9660 CD images (including RockRidge and Joliet extensions), +.It +LHA archives, +.It +mtree file tree descriptions, +.It +RAR and most RAR5 archives, +.It +WARC archives, +.It +XAR archives, +.It +Zip archives. +.El +The library automatically detects archives compressed with +.Xr compress 1 , +.Xr bzip2 1 , +.Xr grzip 1 , +.Xr gzip 1 , +.Xr lrzip 1 , +.Xr lz4 1 , +.Xr lzip 1 , +.Xr lzop 1 , +.Xr xz 1 , +or +.Xr zstd 1 +and decompresses them transparently. Decompression of some formats +requires external decompressor utilities. +It can similarly detect and decode archives processed with +.Xr uuencode 1 +or which have an +.Xr rpm 1 +header. +.Pp +When writing an archive, you can specify the compression +to be used and the format to use. +The library can write +.Bl -bullet -compact +.It +POSIX-standard +.Dq ustar +archives, +.It +POSIX +.Dq pax interchange format +archives, +.It +cpio archives, +.It +7-Zip archives, +.It +ar archives, +.It +two different variants of shar archives, +.It +ISO9660 CD images, +.It +mtree file tree descriptions, +.It +XAR archives, +.It +Zip archive. +.El +Pax interchange format is an extension of the tar archive format that +eliminates essentially all of the limitations of historic tar formats +in a standard fashion that is supported +by POSIX-compliant +.Xr pax 1 +implementations on many systems as well as several newer implementations of +.Xr tar 1 . +Note that the default write format will suppress the pax extended +attributes for most entries; explicitly requesting pax format will +enable those attributes for all entries. +.Pp +The read and write APIs are accessed through the +.Fn archive_read_XXX +functions and the +.Fn archive_write_XXX +functions, respectively, and either can be used independently +of the other. +.Pp +The rest of this manual page provides an overview of the library +operation. +More detailed information can be found in the individual manual +pages for each API or utility function. +.\" +.Sh READING AN ARCHIVE +See +.Xr archive_read 3 . +.\" +.Sh WRITING AN ARCHIVE +See +.Xr archive_write 3 . +.\" +.Sh WRITING ENTRIES TO DISK +The +.Xr archive_write_disk 3 +API allows you to write +.Xr archive_entry 3 +objects to disk using the same API used by +.Xr archive_write 3 . +The +.Xr archive_write_disk 3 +API is used internally by +.Fn archive_read_extract ; +using it directly can provide greater control over how entries +get written to disk. +This API also makes it possible to share code between +archive-to-archive copy and archive-to-disk extraction +operations. +.Sh READING ENTRIES FROM DISK +The +.Xr archive_read_disk 3 +supports for populating +.Xr archive_entry 3 +objects from information in the filesystem. +This includes the information accessible from the +.Xr stat 2 +system call as well as ACLs, extended attributes, +and other metadata. +The +.Xr archive_read_disk 3 +API also supports iterating over directory trees, +which allows directories of files to be read using +an API compatible with +the +.Xr archive_read 3 +API. +.Sh DESCRIPTION +Detailed descriptions of each function are provided by the +corresponding manual pages. +.Pp +All of the functions utilize an opaque +.Tn struct archive +datatype that provides access to the archive contents. +.Pp +The +.Tn struct archive_entry +structure contains a complete description of a single archive +entry. +It uses an opaque interface that is fully documented in +.Xr archive_entry 3 . +.Pp +Users familiar with historic formats should be aware that the newer +variants have eliminated most restrictions on the length of textual fields. +Clients should not assume that filenames, link names, user names, or +group names are limited in length. +In particular, pax interchange format can easily accommodate pathnames +in arbitrary character sets that exceed +.Va PATH_MAX . +.Sh RETURN VALUES +Most functions return +.Cm ARCHIVE_OK +(zero) on success, non-zero on error. +The return value indicates the general severity of the error, ranging +from +.Cm ARCHIVE_WARN , +which indicates a minor problem that should probably be reported +to the user, to +.Cm ARCHIVE_FATAL , +which indicates a serious problem that will prevent any further +operations on this archive. +On error, the +.Fn archive_errno +function can be used to retrieve a numeric error code (see +.Xr errno 2 ) . +The +.Fn archive_error_string +returns a textual error message suitable for display. +.Pp +.Fn archive_read_new +and +.Fn archive_write_new +return pointers to an allocated and initialized +.Tn struct archive +object. +.Pp +.Fn archive_read_data +and +.Fn archive_write_data +return a count of the number of bytes actually read or written. +A value of zero indicates the end of the data for this entry. +A negative value indicates an error, in which case the +.Fn archive_errno +and +.Fn archive_error_string +functions can be used to obtain more information. +.Sh ENVIRONMENT +There are character set conversions within the +.Xr archive_entry 3 +functions that are impacted by the currently-selected locale. +.Sh SEE ALSO +.Xr tar 1 , +.Xr archive_entry 3 , +.Xr archive_read 3 , +.Xr archive_util 3 , +.Xr archive_write 3 , +.Xr tar 5 +.Sh HISTORY +The +.Nm libarchive +library first appeared in +.Fx 5.3 . +.Sh AUTHORS +.An -nosplit +The +.Nm libarchive +library was originally written by +.An Tim Kientzle Aq kientzle@acm.org . +.Sh BUGS +Some archive formats support information that is not supported by +.Tn struct archive_entry . +Such information cannot be fully archived or restored using this library. +This includes, for example, comments, character sets, +or the arbitrary key/value pairs that can appear in +pax interchange format archives. +.Pp +Conversely, of course, not all of the information that can be +stored in an +.Tn struct archive_entry +is supported by all formats. +For example, cpio formats do not support nanosecond timestamps; +old tar formats do not support large device numbers. +.Pp +The ISO9660 reader cannot yet read all ISO9660 images; +it should learn how to seek. +.Pp +The AR writer requires the client program to use +two passes, unlike all other libarchive writers. diff --git a/miniconda3/share/man/man3/libarchive_changes.3 b/miniconda3/share/man/man3/libarchive_changes.3 new file mode 100644 index 0000000000000000000000000000000000000000..fd0e721053cac025a56fbc0e75af86595a893428 --- /dev/null +++ b/miniconda3/share/man/man3/libarchive_changes.3 @@ -0,0 +1,339 @@ +.\" Copyright (c) 2011 Tim Kientzle +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 23, 2011 +.Dt LIBARCHIVE_CHANGES 3 +.Os +.Sh NAME +.Nm libarchive_changes +.Nd changes in libarchive interface +.\" +.Sh CHANGES IN LIBARCHIVE 3 +This page describes user-visible changes in libarchive3, and lists +public functions and other symbols changed, deprecated or removed +in libarchive3, along with their replacements if any. +.\" +.Ss Multiple Filters +.\" +Libarchive2 permitted a single (input or output) filter active +on an archive. +Libarchive3 extends this into a variable-length stack. +Where +.Fn archive_write_set_compression_XXX +would replace any existing filter, +.Fn archive_write_add_filter_XXX +extends the write pipeline with another filter. +.\" +.Ss Character Set Handling +.\" +Libarchive2 assumed that the local platform uses +.Tn Unicode +as the native +.Tn wchar_t +encoding, which is true on +.Tn Windows , +modern +.Tn Linux , +and a few other systems, but is certainly not universal. +As a result, pax format archives were written incorrectly on some +systems, since pax format requires +.Tn UTF-8 +and libarchive 2 incorrectly +assumed that +.Tn wchar_t +strings can be easily converted to +.Tn UTF-8 . +.Pp +Libarchive3 uses the standard iconv library to convert between character +sets and is introducing the notion of a +.Dq default character set for the archive . +To support this, +.Tn archive_entry +objects can now be bound to a particular archive when they are created. +The automatic character set conversions performed by +.Tn archive_entry +objects when reading and writing filenames, usernames, and other strings +will now use an appropriate default character set: +.Pp +If the +.Tn archive_entry +object is bound to an archive, it will use the +default character set for that archive. +.Pp +The platform default character encoding (as returned by +.Fn nl_langinfo CHARSET ) +will be used if nothing else is specified. +.Pp +Libarchive3 also introduces charset options to many of the archive +readers and writers to control the character set that will be used for +filenames written in those archives. +When possible, this will be set automatically based on information in +the archive itself. +Combining this with the notion of a default character set for the +archive should allow you to configure libarchive to read archives from +other platforms and have the filenames and other information +transparently converted to the character encoding suitable for your +application. +.\" +.Ss Prototype Changes +.\" +These changes break binary compatibility; libarchive3 has a new shared +library version to reflect these changes. +The library now uses portable wide types such as +.Tn int64_t +instead of less-portable types such as +.Tn off_t , +.Tn gid_t , +.Tn uid_t , +and +.Tn ino_t . +.Pp +There are a few cases where these changes will affect your source code: +.Bl -bullet -width ind +.It +In some cases, libarchive's wider types will introduce the possibility +of truncation: for example, on a system with a 16-bit +.Tn uid_t , you risk having uid +.Li 65536 +be truncated to uid +.Li 0 , +which can cause serious security problems. +.It +Typedef function pointer types will be incompatible. +For example, if you define custom skip callbacks, you may have to use +code similar to the following if you want to support building against +libarchive2 and libarchive3: +.Bd -literal +#if ARCHIVE_VERSION_NUMBER < 3000000 +typedef off_t myoff_t; +#else +typedef int64_t myoff_t; +#endif + +myoff_t +my_skip_function(struct archive *a, void *v, myoff_t o) +{ + ... implementation ... +} +.Ed +.El +.Pp +Affected functions: +.Pp +.Bl -bullet -compact +.It +.Xo +.Fn archive_entry_gid , +.Fn archive_entry_set_gid +.Xc +.It +.Xo +.Fn archive_entry_uid , +.Fn archive_entry_set_uid +.Xc +.It +.Xo +.Fn archive_entry_ino , +.Fn archive_entry_set_ino +.Xc +.It +.Xo +.Fn archive_read_data_block , +.Fn archive_write_data_block +.Xc +.It +.Xo +.Fn archive_read_disk_gname , +.Fn archive_read_disk_uname +.Xc +.It +.Xo +.Fn archive_read_disk_set_gname_lookup , +.Fn archive_read_disk_set_group_lookup , +.Fn archive_read_disk_set_uname_lookup , +.Fn archive_read_disk_set_user_lookup +.Xc +.It +.Fn archive_skip_callback +.It +.Xo +.Fn archive_read_extract_set_skip_file , +.Fn archive_write_disk_set_skip_file , +.Fn archive_write_set_skip_file +.Xc +.It +.Xo +.Fn archive_write_disk_set_group_lookup , +.Fn archive_write_disk_set_user_lookup +.Xc +.El +.Pp +Where these functions or their arguments took or returned +.Tn gid_t , +.Tn ino_t , +.Tn off_t , +or +.Tn uid_t +they now take or return +.Tn int64_t +or equivalent. +.\" +.Ss Deprecated Symbols +.\" +Symbols deprecated in libarchive3 will be removed in libarchive4. +These symbols, along with their replacements if any, are listed below: +.\" +.Bl -tag -width ind +.It Fn archive_position_compressed , Fn archive_position_uncompressed +.Fn archive_filter_bytes +.It Fn archive_compression +.Fn archive_filter_code +.It Fn archive_compression_name +.Fn archive_filter_name +.It Fn archive_read_finish , Fn archive_write_finish +.Fn archive_read_free , +.Fn archive_write_free +.It Fn archive_read_open_file , Fn archive_write_open_file +.Fn archive_read_open_filename , +.Fn archive_write_open_filename +.It Fn archive_read_support_compression_all +.\" archive_read_support_compression_* -> archive_read_support_filter_* +.Fn archive_read_support_filter_all +.It Fn archive_read_support_compression_bzip2 +.Fn archive_read_support_filter_bzip2 +.It Fn archive_read_support_compression_compress +.Fn archive_read_support_filter_compress +.It Fn archive_read_support_compression_gzip +.Fn archive_read_support_filter_gzip +.It Fn archive_read_support_compression_lzip +.Fn archive_read_support_filter_lzip +.It Fn archive_read_support_compression_lzma +.Fn archive_read_support_filter_lzma +.It Fn archive_read_support_compression_none +.Fn archive_read_support_filter_none +.It Fn archive_read_support_compression_program +.Fn archive_read_support_filter_program +.It Fn archive_read_support_compression_program_signature +.Fn archive_read_support_filter_program_signature +.It Fn archive_read_support_compression_rpm +.Fn archive_read_support_filter_rpm +.It Fn archive_read_support_compression_uu +.Fn archive_read_support_filter_uu +.It Fn archive_read_support_compression_xz +.Fn archive_read_support_filter_xz +.\" archive_write_set_compression_* -> archive_write_add_filter_* +.It Fn archive_write_set_compression_bzip2 +.Fn archive_write_add_filter_bzip2 +.It Fn archive_write_set_compression_compress +.Fn archive_write_add_filter_compress +.It Fn archive_write_set_compression_gzip +.Fn archive_write_add_filter_gzip +.It Fn archive_write_set_compression_lzip +.Fn archive_write_add_filter_lzip +.It Fn archive_write_set_compression_lzma +.Fn archive_write_add_filter_lzma +.It Fn archive_write_set_compression_none +.Fn archive_write_add_filter_none +.It Fn archive_write_set_compression_program +.Fn archive_write_add_filter_program +.It Fn archive_write_set_compression_filter +.Fn archive_write_add_filter_filter +.El +.\" +.Ss Removed Symbols +.\" +These symbols, listed below along with their replacements if any, +were deprecated in libarchive2, and are not part of libarchive3. +.\" +.Bl -tag -width ind +.It Fn archive_api_feature +.Fn archive_version_number +.It Fn archive_api_version +.Fn archive_version_number +.It Fn archive_version +.Fn archive_version_string +.It Fn archive_version_stamp +.Fn archive_version_number +.It Fn archive_read_set_filter_options +.Fn archive_read_set_options +or +.Fn archive_read_set_filter_option +.It Fn archive_read_set_format_options +.Fn archive_read_set_options +or +.Fn archive_read_set_format_option +.It Fn archive_write_set_filter_options +.Fn archive_write_set_options +or +.Fn archive_write_set_filter_option +.It Fn archive_write_set_format_options +.Fn archive_write_set_options +or +.Fn archive_write_set_format_option +.It Dv ARCHIVE_API_FEATURE +.Dv ARCHIVE_VERSION_NUMBER +.It Dv ARCHIVE_API_VERSION +.Dv ARCHIVE_VERSION_NUMBER +.It Dv ARCHIVE_VERSION_STAMP +.Dv ARCHIVE_VERSION_NUMBER +.It Dv ARCHIVE_LIBRARY_VERSION +.Dv ARCHIVE_VERSION_STRING +.\" +.It Dv ARCHIVE_COMPRESSION_NONE +.Dv ARCHIVE_FILTER_NONE +.It Dv ARCHIVE_COMPRESSION_GZIP +.Dv ARCHIVE_FILTER_GZIP +.It Dv ARCHIVE_COMPRESSION_BZIP2 +.Dv ARCHIVE_FILTER_BZIP2 +.It Dv ARCHIVE_COMPRESSION_COMPRESS +.Dv ARCHIVE_FILTER_COMPRESS +.It Dv ARCHIVE_COMPRESSION_PROGRAM +.Dv ARCHIVE_FILTER_PROGRAM +.It Dv ARCHIVE_COMPRESSION_LZMA +.Dv ARCHIVE_FILTER_LZMA +.It Dv ARCHIVE_COMPRESSION_XZ +.Dv ARCHIVE_FILTER_XZ +.It Dv ARCHIVE_COMPRESSION_UU +.Dv ARCHIVE_FILTER_UU +.It Dv ARCHIVE_COMPRESSION_RPM +.Dv ARCHIVE_FILTER_RPM +.It Dv ARCHIVE_COMPRESSION_LZIP +.Dv ARCHIVE_FILTER_LZIP +.\" +.It Dv ARCHIVE_BYTES_PER_RECORD +.Li 512 +.It Dv ARCHIVE_DEFAULT_BYTES_PER_BLOCK +.Li 10240 +.El +.Sh SEE ALSO +.Xr archive_read 3 , +.Xr archive_read_filter 3 , +.Xr archive_read_format 3 , +.Xr archive_read_set_options 3 , +.Xr archive_util 3 , +.Xr archive_write 3 , +.Xr archive_write_filter 3 , +.Xr archive_write_format 3 , +.Xr archive_write_set_options 3 , +.Xr libarchive 3 diff --git a/miniconda3/share/man/man3/libarchive_internals.3 b/miniconda3/share/man/man3/libarchive_internals.3 new file mode 100644 index 0000000000000000000000000000000000000000..2978b48c3e97b3549b9e84abfae89f53d68fb49d --- /dev/null +++ b/miniconda3/share/man/man3/libarchive_internals.3 @@ -0,0 +1,363 @@ +.\" Copyright (c) 2003-2007 Tim Kientzle +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd January 26, 2011 +.Dt LIBARCHIVE_INTERNALS 3 +.Os +.Sh NAME +.Nm libarchive_internals +.Nd description of libarchive internal interfaces +.Sh OVERVIEW +The +.Nm libarchive +library provides a flexible interface for reading and writing +streaming archive files such as tar and cpio. +Internally, it follows a modular layered design that should +make it easy to add new archive and compression formats. +.Sh GENERAL ARCHITECTURE +Externally, libarchive exposes most operations through an +opaque, object-style interface. +The +.Xr archive_entry 3 +objects store information about a single filesystem object. +The rest of the library provides facilities to write +.Xr archive_entry 3 +objects to archive files, +read them from archive files, +and write them to disk. +(There are plans to add a facility to read +.Xr archive_entry 3 +objects from disk as well.) +.Pp +The read and write APIs each have four layers: a public API +layer, a format layer that understands the archive file format, +a compression layer, and an I/O layer. +The I/O layer is completely exposed to clients who can replace +it entirely with their own functions. +.Pp +In order to provide as much consistency as possible for clients, +some public functions are virtualized. +Eventually, it should be possible for clients to open +an archive or disk writer, and then use a single set of +code to select and write entries, regardless of the target. +.Sh READ ARCHITECTURE +From the outside, clients use the +.Xr archive_read 3 +API to manipulate an +.Nm archive +object to read entries and bodies from an archive stream. +Internally, the +.Nm archive +object is cast to an +.Nm archive_read +object, which holds all read-specific data. +The API has four layers: +The lowest layer is the I/O layer. +This layer can be overridden by clients, but most clients use +the packaged I/O callbacks provided, for example, by +.Xr archive_read_open_memory 3 , +and +.Xr archive_read_open_fd 3 . +The compression layer calls the I/O layer to +read bytes and decompresses them for the format layer. +The format layer unpacks a stream of uncompressed bytes and +creates +.Nm archive_entry +objects from the incoming data. +The API layer tracks overall state +(for example, it prevents clients from reading data before reading a header) +and invokes the format and compression layer operations +through registered function pointers. +In particular, the API layer drives the format-detection process: +When opening the archive, it reads an initial block of data +and offers it to each registered compression handler. +The one with the highest bid is initialized with the first block. +Similarly, the format handlers are polled to see which handler +is the best for each archive. +(Prior to 2.4.0, the format bidders were invoked for each +entry, but this design hindered error recovery.) +.Ss I/O Layer and Client Callbacks +The read API goes to some lengths to be nice to clients. +As a result, there are few restrictions on the behavior of +the client callbacks. +.Pp +The client read callback is expected to provide a block +of data on each call. +A zero-length return does indicate end of file, but otherwise +blocks may be as small as one byte or as large as the entire file. +In particular, blocks may be of different sizes. +.Pp +The client skip callback returns the number of bytes actually +skipped, which may be much smaller than the skip requested. +The only requirement is that the skip not be larger. +In particular, clients are allowed to return zero for any +skip that they don't want to handle. +The skip callback must never be invoked with a negative value. +.Pp +Keep in mind that not all clients are reading from disk: +clients reading from networks may provide different-sized +blocks on every request and cannot skip at all; +advanced clients may use +.Xr mmap 2 +to read the entire file into memory at once and return the +entire file to libarchive as a single block; +other clients may begin asynchronous I/O operations for the +next block on each request. +.Ss Decompression Layer +The decompression layer not only handles decompression, +it also buffers data so that the format handlers see a +much nicer I/O model. +The decompression API is a two stage peek/consume model. +A read_ahead request specifies a minimum read amount; +the decompression layer must provide a pointer to at least +that much data. +If more data is immediately available, it should return more: +the format layer handles bulk data reads by asking for a minimum +of one byte and then copying as much data as is available. +.Pp +A subsequent call to the +.Fn consume +function advances the read pointer. +Note that data returned from a +.Fn read_ahead +call is guaranteed to remain in place until +the next call to +.Fn read_ahead . +Intervening calls to +.Fn consume +should not cause the data to move. +.Pp +Skip requests must always be handled exactly. +Decompression handlers that cannot seek forward should +not register a skip handler; +the API layer fills in a generic skip handler that reads and discards data. +.Pp +A decompression handler has a specific lifecycle: +.Bl -tag -compact -width indent +.It Registration/Configuration +When the client invokes the public support function, +the decompression handler invokes the internal +.Fn __archive_read_register_compression +function to provide bid and initialization functions. +This function returns +.Cm NULL +on error or else a pointer to a +.Cm struct decompressor_t . +This structure contains a +.Va void * config +slot that can be used for storing any customization information. +.It Bid +The bid function is invoked with a pointer and size of a block of data. +The decompressor can access its config data +through the +.Va decompressor +element of the +.Cm archive_read +object. +The bid function is otherwise stateless. +In particular, it must not perform any I/O operations. +.Pp +The value returned by the bid function indicates its suitability +for handling this data stream. +A bid of zero will ensure that this decompressor is never invoked. +Return zero if magic number checks fail. +Otherwise, your initial implementation should return the number of bits +actually checked. +For example, if you verify two full bytes and three bits of another +byte, bid 19. +Note that the initial block may be very short; +be careful to only inspect the data you are given. +(The current decompressors require two bytes for correct bidding.) +.It Initialize +The winning bidder will have its init function called. +This function should initialize the remaining slots of the +.Va struct decompressor_t +object pointed to by the +.Va decompressor +element of the +.Va archive_read +object. +In particular, it should allocate any working data it needs +in the +.Va data +slot of that structure. +The init function is called with the block of data that +was used for tasting. +At this point, the decompressor is responsible for all I/O +requests to the client callbacks. +The decompressor is free to read more data as and when +necessary. +.It Satisfy I/O requests +The format handler will invoke the +.Va read_ahead , +.Va consume , +and +.Va skip +functions as needed. +.It Finish +The finish method is called only once when the archive is closed. +It should release anything stored in the +.Va data +and +.Va config +slots of the +.Va decompressor +object. +It should not invoke the client close callback. +.El +.Ss Format Layer +The read formats have a similar lifecycle to the decompression handlers: +.Bl -tag -compact -width indent +.It Registration +Allocate your private data and initialize your pointers. +.It Bid +Formats bid by invoking the +.Fn read_ahead +decompression method but not calling the +.Fn consume +method. +This allows each bidder to look ahead in the input stream. +Bidders should not look further ahead than necessary, as long +look aheads put pressure on the decompression layer to buffer +lots of data. +Most formats only require a few hundred bytes of look ahead; +look aheads of a few kilobytes are reasonable. +(The ISO9660 reader sometimes looks ahead by 48k, which +should be considered an upper limit.) +.It Read header +The header read is usually the most complex part of any format. +There are a few strategies worth mentioning: +For formats such as tar or cpio, reading and parsing the header is +straightforward since headers alternate with data. +For formats that store all header data at the beginning of the file, +the first header read request may have to read all headers into +memory and store that data, sorted by the location of the file +data. +Subsequent header read requests will skip forward to the +beginning of the file data and return the corresponding header. +.It Read Data +The read data interface supports sparse files; this requires that +each call return a block of data specifying the file offset and +size. +This may require you to carefully track the location so that you +can return accurate file offsets for each read. +Remember that the decompressor will return as much data as it has. +Generally, you will want to request one byte, +examine the return value to see how much data is available, and +possibly trim that to the amount you can use. +You should invoke consume for each block just before you return it. +.It Skip All Data +The skip data call should skip over all file data and trailing padding. +This is called automatically by the API layer just before each +header read. +It is also called in response to the client calling the public +.Fn data_skip +function. +.It Cleanup +On cleanup, the format should release all of its allocated memory. +.El +.Ss API Layer +XXX to do XXX +.Sh WRITE ARCHITECTURE +The write API has a similar set of four layers: +an API layer, a format layer, a compression layer, and an I/O layer. +The registration here is much simpler because only +one format and one compression can be registered at a time. +.Ss I/O Layer and Client Callbacks +XXX To be written XXX +.Ss Compression Layer +XXX To be written XXX +.Ss Format Layer +XXX To be written XXX +.Ss API Layer +XXX To be written XXX +.Sh WRITE_DISK ARCHITECTURE +The write_disk API is intended to look just like the write API +to clients. +Since it does not handle multiple formats or compression, it +is not layered internally. +.Sh GENERAL SERVICES +The +.Nm archive_read , +.Nm archive_write , +and +.Nm archive_write_disk +objects all contain an initial +.Nm archive +object which provides common support for a set of standard services. +(Recall that ANSI/ISO C90 guarantees that you can cast freely between +a pointer to a structure and a pointer to the first element of that +structure.) +The +.Nm archive +object has a magic value that indicates which API this object +is associated with, +slots for storing error information, +and function pointers for virtualized API functions. +.Sh MISCELLANEOUS NOTES +Connecting existing archiving libraries into libarchive is generally +quite difficult. +In particular, many existing libraries strongly assume that you +are reading from a file; they seek forwards and backwards as necessary +to locate various pieces of information. +In contrast, libarchive never seeks backwards in its input, which +sometimes requires very different approaches. +.Pp +For example, libarchive's ISO9660 support operates very differently +from most ISO9660 readers. +The libarchive support utilizes a work-queue design that +keeps a list of known entries sorted by their location in the input. +Whenever libarchive's ISO9660 implementation is asked for the next +header, checks this list to find the next item on the disk. +Directories are parsed when they are encountered and new +items are added to the list. +This design relies heavily on the ISO9660 image being optimized so that +directories always occur earlier on the disk than the files they +describe. +.Pp +Depending on the specific format, such approaches may not be possible. +The ZIP format specification, for example, allows archivers to store +key information only at the end of the file. +In theory, it is possible to create ZIP archives that cannot +be read without seeking. +Fortunately, such archives are very rare, and libarchive can read +most ZIP archives, though it cannot always extract as much information +as a dedicated ZIP program. +.Sh SEE ALSO +.Xr archive_entry 3 , +.Xr archive_read 3 , +.Xr archive_write 3 , +.Xr archive_write_disk 3 , +.Xr libarchive 3 +.Sh HISTORY +The +.Nm libarchive +library first appeared in +.Fx 5.3 . +.Sh AUTHORS +.An -nosplit +The +.Nm libarchive +library was written by +.An Tim Kientzle Aq kientzle@acm.org . diff --git a/miniconda3/share/man/man3/libsolv-bindings.3 b/miniconda3/share/man/man3/libsolv-bindings.3 new file mode 100644 index 0000000000000000000000000000000000000000..d5533d0d922d5c1bc40562f92b9b06bf78224688 --- /dev/null +++ b/miniconda3/share/man/man3/libsolv-bindings.3 @@ -0,0 +1,7084 @@ +'\" t +.\" Title: Libsolv-Bindings +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 07/09/2024 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "LIBSOLV\-BINDINGS" "3" "07/09/2024" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +libsolv-bindings \- access libsolv from perl/python/ruby +.SH "DESCRIPTION" +.sp +Libsolv\(cqs language bindings offer an abstract, object orientated interface to the library\&. The supported languages are currently perl, python, ruby and tcl\&. All example code (except in the specifics sections, of course) lists first the \(lqC\-ish\(rq interface, then the syntax for perl, python, and ruby (in that order)\&. +.SH "PERL SPECIFICS" +.sp +Libsolv\(cqs perl bindings can be loaded with the following statement: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBuse solv\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Objects are either created by calling the new() method on a class or they are returned by calling methods on other objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +my \fI$pool\fR \fB= solv::Pool\->new()\fR; +my \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->add_repo("my_first_repo")\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Swig encapsulates all objects as tied hashes, thus the attributes can be accessed by treating the object as standard hash reference: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fI$pool\fR\fB\->{appdata} = 42\fR; +\fBprintf "appdata is %d\en",\fR \fI$pool\fR\fB\->{appdata}\fR; +.fi +.if n \{\ +.RE +.\} +.sp +A special exception to this are iterator objects, they are encapsulated as tied arrays so that it is possible to iterate with a for() statement: +.sp +.if n \{\ +.RS 4 +.\} +.nf +my \fI$iter\fR \fB=\fR \fI$pool\fR\fB\->solvables_iter()\fR; +\fBfor my\fR \fI$solvable\fR \fB(\fR\fI@$iter\fR\fB) { \&.\&.\&. }\fR; +.fi +.if n \{\ +.RE +.\} +.sp +As a downside of this approach, iterator objects cannot have attributes\&. +.sp +If an array needs to be passed to a method it is usually done by reference, if a method returns an array it returns it on the perl stack: +.sp +.if n \{\ +.RS 4 +.\} +.nf +my \fI@problems\fR \fB=\fR \fI$solver\fR\fB\->solve(\e\fR\fI@jobs\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Due to a bug in swig, stringification does not work for libsolv\(cqs objects\&. Instead, you have to call the object\(cqs str() method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBprint\fR \fI$dep\fR\fB\->str() \&. "\e\fR\fIn\fR\fB"\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Swig implements all constants as numeric variables (instead of the more natural constant subs), so don\(cqt forget the leading \(lq$\(rq when accessing a constant\&. Also do not forget to prepend the namespace of the constant: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fI$pool\fR\fB\->set_flag($solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR; +.fi +.if n \{\ +.RE +.\} +.SH "PYTHON SPECIFICS" +.sp +The python bindings can be loaded with: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBimport solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Objects are either created by calling the constructor method for a class or they are returned by calling methods on other objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR \fB= solv\&.Pool()\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo("my_first_repo")\fR +.fi +.if n \{\ +.RE +.\} +.sp +Attributes can be accessed as usual: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB\&.appdata = 42\fR +\fBprint "appdata is %d" % (\fR\fIpool\fR\fB\&.appdata)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterators also work as expected: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter():\fR +.fi +.if n \{\ +.RE +.\} +.sp +Arrays are passed and returned as list objects: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIjobs\fR \fB= []\fR +\fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +The bindings define stringification for many classes, some also have a \fIrepr\fR method to ease debugging\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBprint\fR \fIdep\fR +\fBprint repr(\fR\fIrepo\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Constants are attributes of the corresponding classes: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB\&.set_flag(solv\&.Pool\&.POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR; +.fi +.if n \{\ +.RE +.\} +.SH "RUBY SPECIFICS" +.sp +The ruby bindings can be loaded with: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBrequire \*(Aqsolv\*(Aq\fR +.fi +.if n \{\ +.RE +.\} +.sp +Objects are either created by calling the new method on a class or they are returned by calling methods on other objects\&. Note that all classes start with an uppercase letter in ruby, so the class is called \(lqSolv\(rq\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR \fB= Solv::Pool\&.new\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo("my_first_repo")\fR +.fi +.if n \{\ +.RE +.\} +.sp +Attributes can be accessed as usual: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB\&.appdata = 42\fR +\fBputs "appdata is #{\fR\fIpool\fR\fB\&.appdata}"\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterators also work as expected: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter() do \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.sp +Arrays are passed and returned as array objects: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIjobs\fR \fB= []\fR +\fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Most classes define a to_s method, so objects can be easily stringified\&. Many also define an inspect() method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBputs\fR \fIdep\fR +\fBputs\fR \fIrepo\fR\fB\&.inspect\fR +.fi +.if n \{\ +.RE +.\} +.sp +Constants live in the namespace of the class they belong to: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB\&.set_flag(Solv::Pool::POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Note that boolean methods have an added trailing \(lq?\(rq, to be consistent with other ruby modules: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBputs "empty" if\fR \fIrepo\fR\fB\&.isempty?\fR +.fi +.if n \{\ +.RE +.\} +.SH "TCL SPECIFICS" +.sp +Libsolv\(cqs tcl bindings can be loaded with the following statement: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBpackage require solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Objects are either created by calling class name prefixed with \(lqnew_\(rq, or they are returned by calling methods on other objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBset pool [solv::new_Pool]\fR +\fBset repo [\fR\fI$pool\fR \fBadd_repo "my_first_repo"]\fR +.fi +.if n \{\ +.RE +.\} +.sp +Swig provides a \(lqcget\(rq method to read object attributes, and a \(lqconfigure\(rq method to write them: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fI$pool\fR \fBconfigure \-appdata 42\fR +\fBputs "appdata is [\fR\fI$pool\fR \fBcget \-appdata]"\fR +.fi +.if n \{\ +.RE +.\} +.sp +The tcl bindings provide a little helper to work with iterators in a foreach style: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBset iter [\fR\fI$pool\fR \fBsolvables_iter]\fR +\fBsolv::iter s\fR \fI$iter\fR \fB{ \&.\&.\&. }\fR +.fi +.if n \{\ +.RE +.\} +.sp +libsolv\(cqs arrays are mapped to tcl\(cqs lists: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBset jobs [list\fR \fI$job1 $job2\fR\fB]\fR +\fBset problems [\fR\fI$solver\fR \fBsolve\fR \fI$jobs\fR\fB]\fR +\fBputs "We have [llength\fR \fI$problems\fR\fB] problems\&.\&.\&."\fR +.fi +.if n \{\ +.RE +.\} +.sp +Stringification is done by calling the object\(cqs \(lqstr\(rq method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBputs [\fR\fI$dep\fR \fBstr]\fR +.fi +.if n \{\ +.RE +.\} +.sp +There is one exception: you have to use \(lqstringify\(rq for Datamatch objects, as swig reports a clash with the \(lqstr\(rq attribute\&. +.sp +Some classes also support a \(lq==\(rq method for equality tests, and a \(lq!=\(rq method\&. +.sp +Swig implements all constants as numeric variables, constants belonging to a libsolv class are prefixed with the class name: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fI$pool\fR \fBset_flag\fR \fI$solv::Pool_POOL_FLAG_OBSOLETEUSESCOLORS\fR \fB1\fR +\fBputs [\fR\fI$solvable\fR \fBlookup_str\fR \fI$solv::SOLVABLE_SUMMARY\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.SH "LUA SPECIFICS" +.sp +Libsolv\(cqs lua bindings can be loaded with the following statement: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBrequire("solv")\fR +.fi +.if n \{\ +.RE +.\} +.sp +Objects are either created by calling the constructor method for a class or they are returned by calling methods on other objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR \fB= solv\&.Pool()\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB:add_repo("my_first_repo")\fR +.fi +.if n \{\ +.RE +.\} +.sp +Note the \(lq:method\(rq syntax that makes lua add the object as first argument\&. +.sp +Attributes can be accessed as usual: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB\&.appdata = 42\fR +\fBprint("appdata is "\&.\&.pool\&.appdata)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterators also work as expected: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables do \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.sp +Note that some functions return a table instead of an iterator, so you need to use \(lqipairs\(rq for iteration: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor\fR \fI_\fR\fB,solvable\fR \fBin ipairs(\fR\fIjob\fR\fB\&.solvables()) do \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.sp +Arrays are passed and returned as tables: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIjobs\fR \fB= {}\fR +\fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR +\fBif #problems != 0 then \&.\&.\&.\fR +.fi +.if n \{\ +.RE +.\} +.sp +The bindings define a \(lq__tostring\(rq method for many classes: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBprint(\fR\fIdep\fR\fB)\fR +\fBprint(("Package: %\fR\fIs\fR\fB"):format(\fR\fIsolvable\fR\fB))\fR +.fi +.if n \{\ +.RE +.\} +.sp +Constants live in the namespace of the class they belong to: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIpool\fR\fB:set_flag(Solv\&.Pool\&.POOL_FLAG_OBSOLETEUSESCOLORS, 1)\fR; +.fi +.if n \{\ +.RE +.\} +.SH "THE SOLV CLASS" +.sp +This is the main namespace of the library, you cannot create objects of this type but it contains some useful constants\&. +.SS "CONSTANTS" +.sp +Relational flag constants, the first three can be or\-ed together +.PP +\fBREL_LT\fR +.RS 4 +the \(lqless than\(rq bit +.RE +.PP +\fBREL_EQ\fR +.RS 4 +the \(lqequals to\(rq bit +.RE +.PP +\fBREL_GT\fR +.RS 4 +the \(lqgreater than\(rq bit +.RE +.PP +\fBREL_ARCH\fR +.RS 4 +used for relations that describe an extra architecture filter, the version part of the relation is interpreted as architecture\&. +.RE +.sp +Special Solvable Ids +.PP +\fBSOLVID_META\fR +.RS 4 +Access the meta section of a repository or repodata area\&. This is like an extra Solvable that has the Id SOLVID_META\&. +.RE +.PP +\fBSOLVID_POS\fR +.RS 4 +Use the data position stored inside of the pool instead of accessing some solvable by Id\&. The bindings have the Datapos objects as an abstraction mechanism, so you most likely do not need this constant\&. +.RE +.sp +Constant string Ids +.PP +\fBID_NULL\fR +.RS 4 +Always zero +.RE +.PP +\fBID_EMPTY\fR +.RS 4 +Always one, describes the empty string +.RE +.PP +\fBSOLVABLE_NAME\fR +.RS 4 +The keyname Id of the name of the solvable\&. +.RE +.PP +\fB\&...\fR +.RS 4 +see the libsolv\-constantids manpage for a list of fixed Ids\&. +.RE +.SH "THE POOL CLASS" +.sp +The pool is libsolv\(cqs central resource manager\&. A pool consists of Solvables, Repositories, Dependencies, each indexed by Ids\&. +.SS "CLASS METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *Pool()\fR +my \fI$pool\fR \fB= solv::Pool\->new()\fR; +\fIpool\fR \fB= solv\&.Pool()\fR +\fIpool\fR \fB= Solv::Pool\&.new()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a new pool instance\&. In most cases you just need one pool\&. Note that the returned object "owns" the pool, i\&.e\&. if the object is freed, the pool is also freed\&. You can use the disown method to break this ownership relation\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid *appdata;\fR /* read/write */ +\fI$pool\fR\fB\->{appdata}\fR +\fIpool\fR\fB\&.appdata\fR +\fIpool\fR\fB\&.appdata\fR +.fi +.if n \{\ +.RE +.\} +.sp +Application specific data that may be used in any way by the code using the pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable solvables[];\fR /* read only */ +my \fI$solvable\fR \fB=\fR \fI$pool\fR\fB\->{solvables}\->[\fR\fI$solvid\fR\fB]\fR; +\fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.solvables[\fR\fIsolvid\fR\fB]\fR +\fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.solvables[\fR\fIsolvid\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.sp +Look up a Solvable by its id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo repos[];\fR /* read only */ +my \fI$repo\fR \fB=\fR \fI$pool\fR\fB\->{repos}\->[\fR\fI$repoid\fR\fB]\fR; +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.repos[\fR\fIrepoid\fR\fB]\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.repos[\fR\fIrepoid\fR\fB]\fR +.fi +.if n \{\ +.RE +.\} +.sp +Look up a Repository by its id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo *installed;\fR /* read/write */ +\fI$pool\fR\fB\->{installed} =\fR \fI$repo\fR; +\fIpool\fR\fB\&.installed =\fR \fIrepo\fR +\fIpool\fR\fB\&.installed =\fR \fIrepo\fR +.fi +.if n \{\ +.RE +.\} +.sp +Define which repository contains all the installed packages\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *errstr;\fR /* read only */ +my \fI$err\fR \fB=\fR \fI$pool\fR\fB\->{errstr}\fR; +\fIerr\fR \fB=\fR \fIpool\fR\fB\&.errstr\fR +\fIerr\fR \fB=\fR \fIpool\fR\fB\&.errstr\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the last error string that was stored in the pool\&. +.SS "CONSTANTS" +.PP +\fBPOOL_FLAG_PROMOTEEPOCH\fR +.RS 4 +Promote the epoch of the providing dependency to the requesting dependency if it does not contain an epoch\&. Used at some time in old rpm versions, modern systems should never need this\&. +.RE +.PP +\fBPOOL_FLAG_FORBIDSELFCONFLICTS\fR +.RS 4 +Disallow the installation of packages that conflict with themselves\&. Debian always allows self\-conflicting packages, rpm used to forbid them but switched to also allowing them since rpm\-4\&.9\&.0\&. +.RE +.PP +\fBPOOL_FLAG_OBSOLETEUSESPROVIDES\fR +.RS 4 +Make obsolete type dependency match against provides instead of just the name and version of packages\&. Very old versions of rpm used the name/version, then it got switched to provides and later switched back again to just name/version\&. +.RE +.PP +\fBPOOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES\fR +.RS 4 +An implicit obsoletes is the internal mechanism to remove the old package on an update\&. The default is to remove all packages with the same name, rpm\-5 switched to also removing packages providing the same name\&. +.RE +.PP +\fBPOOL_FLAG_OBSOLETEUSESCOLORS\fR +.RS 4 +Rpm\(cqs multilib implementation distinguishes between 32bit and 64bit packages (the terminology is that they have a different color)\&. If obsoleteusescolors is set, packages with different colors will not obsolete each other\&. +.RE +.PP +\fBPOOL_FLAG_IMPLICITOBSOLETEUSESCOLORS\fR +.RS 4 +Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if packages of the same name can be installed in parallel\&. For current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true (this is the default if FEDORA is defined when libsolv is compiled)\&. +.RE +.PP +\fBPOOL_FLAG_NOINSTALLEDOBSOLETES\fR +.RS 4 +Since version 4\&.9\&.0 rpm considers the obsoletes of installed packages when checking for dependency conflicts, thus you may not install a package that is obsoleted by some other installed package unless you also erase the other package\&. +.RE +.PP +\fBPOOL_FLAG_HAVEDISTEPOCH\fR +.RS 4 +Mandriva added a new field called distepoch that gets checked in version comparison if the epoch/version/release of two packages are the same\&. +.RE +.PP +\fBPOOL_FLAG_NOOBSOLETESMULTIVERSION\fR +.RS 4 +If a package is installed in multiversion mode, rpm used to ignore both the implicit obsoletes and the obsolete dependency of a package\&. This was changed to ignoring just the implicit obsoletes, thus you may install multiple versions of the same name, but obsoleted packages still get removed\&. +.RE +.PP +\fBPOOL_FLAG_ADDFILEPROVIDESFILTERED\fR +.RS 4 +Make the addfileprovides method only add files from the standard locations (i\&.e\&. the \(lqbin\(rq and \(lqetc\(rq directories)\&. This is useful if you have only few packages that use non\-standard file dependencies, but you still want the fast speed that addfileprovides() generates\&. +.RE +.PP +\fBPOOL_FLAG_NOWHATPROVIDESAUX\fR +.RS 4 +Disable the creation of the auxiliary whatprovides index\&. This saves a bit of memory but also makes the whatprovides lookups a bit slower\&. +.RE +.PP +\fBPOOL_FLAG_WHATPROVIDESWITHDISABLED\fR +.RS 4 +Make the whatprovides index also contain disabled packages\&. This means that you do not need to recreate the index if a package is enabled/disabled, i\&.e\&. the pool→considered bitmap is changed\&. +.RE +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid free()\fR +\fI$pool\fR\fB\->free()\fR; +\fIpool\fR\fB\&.free()\fR +\fIpool\fR\fB\&.free()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Force a free of the pool\&. After this call, you must not access any object that still references the pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid disown()\fR +\fI$pool\fR\fB\->disown()\fR; +\fIpool\fR\fB\&.disown()\fR +\fIpool\fR\fB\&.disown()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Break the ownership relation between the binding object and the pool\&. After this call, the pool will not get freed even if the object goes out of scope\&. This also means that you must manually call the free method to free the pool data\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid setdebuglevel(int\fR \fIlevel\fR\fB)\fR +\fI$pool\fR\fB\->setdebuglevel(\fR\fI$level\fR\fB)\fR; +\fIpool\fR\fB\&.setdebuglevel(\fR\fIlevel\fR\fB)\fR +\fIpool\fR\fB\&.setdebuglevel(\fR\fIlevel\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set the debug level\&. A value of zero means no debug output, the higher the value, the more output is generated\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint set_flag(int\fR \fIflag\fR\fB, int\fR \fIvalue\fR\fB)\fR +my \fI$oldvalue\fR \fB=\fR \fI$pool\fR\fB\->set_flag(\fR\fI$flag\fR\fB,\fR \fI$value\fR\fB)\fR; +\fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR +\fIoldvalue\fR \fB=\fR \fIpool\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint get_flag(int\fR \fIflag\fR\fB)\fR +my \fI$value\fR \fB=\fR \fI$pool\fR\fB\->get_flag(\fR\fI$flag\fR\fB)\fR; +\fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR +\fIvalue\fR \fB=\fR \fIpool\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set/get a pool specific flag\&. The flags define how the system works, e\&.g\&. how the package manager treats obsoletes\&. The default flags should be sane for most applications, but in some cases you may want to tweak a flag, for example if you want to solve package dependencies for some other system\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_rootdir(const char *\fR\fIrootdir\fR\fB)\fR +\fI$pool\fR\fB\->set_rootdir(\fR\fIrootdir\fR\fB)\fR; +\fIpool\fR\fB\&.set_rootdir(\fR\fIrootdir\fR\fB)\fR +\fIpool\fR\fB\&.set_rootdir(\fR\fIrootdir\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *get_rootdir()\fR +my \fI$rootdir\fR \fB=\fR \fI$pool\fR\fB\->get_rootdir()\fR; +\fIrootdir\fR \fB=\fR \fIpool\fR\fB\&.get_rootdir()\fR +\fIrootdir\fR \fB=\fR \fIpool\fR\fB\&.get_rootdir()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set/get the rootdir to use\&. This is useful if you want package management to work only in some directory, for example if you want to setup a chroot jail\&. Note that the rootdir will only be prepended to file paths if the \fBREPO_USE_ROOTDIR\fR flag is used\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid setarch(const char *\fR\fIarch\fR \fB= 0)\fR +\fI$pool\fR\fB\->setarch()\fR; +\fIpool\fR\fB\&.setarch()\fR +\fIpool\fR\fB\&.setarch()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set the architecture for your system\&. The architecture is used to determine which packages are installable\&. It defaults to the result of \(lquname \-m\(rq\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo add_repo(const char *\fR\fIname\fR\fB)\fR +\fI$repo\fR \fB=\fR \fI$pool\fR\fB\->add_repo(\fR\fI$name\fR\fB)\fR; +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo(\fR\fIname\fR\fB)\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.add_repo(\fR\fIname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a Repository with the specified name to the pool\&. The repository is empty on creation, use the repository methods to populate it with packages\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepoiterator repos_iter()\fR +\fBfor my\fR \fI$repo\fR \fB(\fR\fI@\fR\fB{\fR\fI$pool\fR\fB\->repos_iter()})\fR +\fBfor\fR \fIrepo\fR \fBin\fR \fIpool\fR\fB\&.repos_iter():\fR +\fBfor\fR \fIrepo\fR \fBin\fR \fIpool\fR\fB\&.repos_iter()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the existing repositories\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvableiterator solvables_iter()\fR +\fBfor my\fR \fI$solvable\fR \fB(\fR\fI@\fR\fB{\fR\fI$pool\fR\fB\->solvables_iter()})\fR +\fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter():\fR +\fBfor\fR \fIsolvable\fR \fBin\fR \fIpool\fR\fB\&.solvables_iter()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the existing solvables\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep Dep(const char *\fR\fIstr\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$dep\fR \fB=\fR \fI$pool\fR\fB\->Dep(\fR\fI$string\fR\fB)\fR; +\fIdep\fR \fB=\fR \fIpool\fR\fB\&.Dep(\fR\fIstring\fR\fB)\fR +\fIdep\fR \fB=\fR \fIpool\fR\fB\&.Dep(\fR\fIstring\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create an object describing a string or dependency\&. If the string is currently not in the pool and \fIcreate\fR is false, \fBundef\fR/\fBNone\fR/\fBnil\fR is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid addfileprovides()\fR +\fI$pool\fR\fB\->addfileprovides()\fR; +\fIpool\fR\fB\&.addfileprovides()\fR +\fIpool\fR\fB\&.addfileprovides()\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *addfileprovides_queue()\fR +my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->addfileprovides_queue()\fR; +\fIids\fR \fB=\fR \fIpool\fR\fB\&.addfileprovides_queue()\fR +\fIids\fR \fB=\fR \fIpool\fR\fB\&.addfileprovides_queue()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Some package managers like rpm allow dependencies on files contained in other packages\&. To allow libsolv to deal with those dependencies in an efficient way, you need to call the addfileprovides method after creating and reading all repositories\&. This method will scan all dependency for file names and then scan all packages for matching files\&. If a filename has been matched, it will be added to the provides list of the corresponding package\&. The addfileprovides_queue variant works the same way but returns an array containing all file dependencies\&. This information can be stored in the meta section of the repositories to speed up the next time the repository is loaded and addfileprovides is called\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid createwhatprovides()\fR +\fI$pool\fR\fB\->createwhatprovides()\fR; +\fIpool\fR\fB\&.createwhatprovides()\fR +\fIpool\fR\fB\&.createwhatprovides()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create the internal \(lqwhatprovides\(rq hash over all of the provides of all installable packages\&. This method must be called before doing any lookups on provides\&. It\(cqs encouraged to do it right after all repos are set up, usually right after the call to addfileprovides()\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *whatprovides(DepId\fR \fIdep\fR\fB)\fR +my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->whatprovides(\fR\fI$dep\fR\fB)\fR; +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatprovides(\fR\fIdep\fR\fB)\fR +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatprovides(\fR\fIdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that provide the specified dependency\&. You can use either a Dep object or a simple Id as argument\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *best_solvables(Solvable *\fR\fIsolvables\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->best_solvables(\fR\fI$solvables\fR\fB)\fR; +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.best_solvables(\fR\fIsolvables\fR\fB)\fR +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.best_solvables(\fR\fIsolvables\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Filter list of solvables by repo priority, architecture and version\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *whatcontainsdep(Id\fR \fIkeyname\fR\fB, DepId\fR \fIdep\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->whatcontainsdep(\fR\fI$keyname\fR\fB,\fR \fI$dep\fR\fB)\fR; +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatcontainsdep(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatcontainsdep(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables for which keyname contains the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *whatmatchesdep(Id\fR \fIkeyname\fR\fB, DepId\fR \fIdep\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->whatmatchesdep(\fR\fI$keyname\fR\fB,\fR \fI$sdep\fR\fB)\fR; +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatmatchesdep(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatmatchesdep(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that have dependencies in keyname that match the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *whatmatchessolvable(Id\fR \fIkeyname\fR\fB, Solvable\fR \fIsolvable\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI@solvables\fR \fB=\fR \fI$pool\fR\fB\->whatmatchessolvable(\fR\fI$keyname\fR\fB,\fR \fI$solvable\fR\fB)\fR; +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatmatchessolvable(\fR\fIkeyname\fR\fB,\fR \fIsolvable\fR\fB)\fR +\fIsolvables\fR \fB=\fR \fIpool\fR\fB\&.whatmatchessolvable(\fR\fIkeyname\fR\fB,\fR \fIsolvable\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that match package dependencies against solvable\(cqs provides\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *matchprovidingids(const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR +my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->matchprovidingids(\fR\fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIids\fR \fB=\fR \fIpool\fR\fB\&.matchprovidingids(\fR\fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIids\fR \fB=\fR \fIpool\fR\fB\&.matchprovidingids(\fR\fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Search the names of all provides and return the ones matching the specified string\&. See the Dataiterator class for the allowed flags\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId towhatprovides(Id *\fR\fIids\fR\fB)\fR +my \fI$offset\fR \fB=\fR \fI$pool\fR\fB\->towhatprovides(\e\fR\fI@ids\fR\fB)\fR; +\fIoffset\fR \fB=\fR \fIpool\fR\fB\&.towhatprovides(\fR\fIids\fR\fB)\fR +\fIoffset\fR \fB=\fR \fIpool\fR\fB\&.towhatprovides(\fR\fIids\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +\(lqInternalize\(rq an array containing Ids\&. The returned value can be used to create solver jobs working on a specific set of packages\&. See the Solver class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_namespaceproviders(DepId\fR \fIns\fR\fB, DepId\fR \fIevr\fR\fB, bool\fR \fIvalue\fR \fB= 1)\fR +\fI$pool\fR\fB\->set_namespaceproviders(\fR\fI$ns\fR\fB,\fR \fI$evr\fR\fB, 1)\fR; +\fIpool\fR\fB\&.set_namespaceproviders(\fR\fIns\fR\fB,\fR \fIevr\fR\fB,\fR \fITrue\fR\fB)\fR +\fIpool\fR\fB\&.set_namespaceproviders(\fR\fIns\fR\fB,\fR \fIevr\fR\fB,\fR \fItrue\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Manually set a namespace provides entry in the whatprovides index\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid flush_namespaceproviders(DepId\fR \fIns\fR\fB, DepId\fR \fIevr\fR\fB)\fR +\fI$pool\fR\fB\->flush_namespaceproviders(\fR\fI$ns\fR\fB,\fR \fI$evr\fR\fB)\fR; +\fI$pool\fR\fB\&.flush_namespaceproviders(\fR\fIns\fR\fB,\fR \fIevr\fR\fB)\fR +\fI$pool\fR\fB\&.flush_namespaceproviders(\fR\fIns\fR\fB,\fR \fIevr\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Flush the cache of all namespaceprovides matching the specified namespace dependency\&. You can use zero as a wildcard argument\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isknownarch(DepId\fR \fIid\fR\fB)\fR +my \fI$bool\fR \fB=\fR \fI$pool\fR\fB\->isknownarch(\fR\fI$id\fR\fB)\fR; +\fIbool\fR \fB=\fR \fIpool\fR\fB\&.isknownarch(\fR\fIid\fR\fB)\fR +\fIbool\fR \fB=\fR \fIpool\fR\fB\&.isknownarch?(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the specified Id describes a known architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver Solver()\fR +my \fI$solver\fR \fB=\fR \fI$pool\fR\fB\->Solver()\fR; +\fIsolver\fR \fB=\fR \fIpool\fR\fB\&.Solver()\fR +\fIsolver\fR \fB=\fR \fIpool\fR\fB\&.Solver()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a new solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBJob Job(int\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR +my \fI$job\fR \fB=\fR \fI$pool\fR\fB\->Job(\fR\fI$how\fR\fB,\fR \fI$what\fR\fB)\fR; +\fIjob\fR \fB=\fR \fIpool\fR\fB\&.Job(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR +\fIjob\fR \fB=\fR \fIpool\fR\fB\&.Job(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a new Job object\&. Kind of low level, in most cases you would instead use a Selection or Dep job constructor\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection()\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->Selection()\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection()\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create an empty selection\&. Useful as a starting point for merging other selections\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection_all()\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->Selection_all()\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection_all()\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.Selection_all()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a selection containing all packages\&. Useful as starting point for intersecting other selections or for update/distupgrade jobs\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection select(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR\fB)\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->select(\fR\fI$name\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a selection by matching packages against the specified string\&. See the Selection class for a list of flags and how to create solver jobs from a selection\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection matchdeps(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->matchdeps(\fR\fI$name\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchdeps(\fR\fIname\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchdeps(\fR\fIname\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a selection by matching package dependencies against the specified string\&. This can be used if you want to match other dependency types than \(lqprovides\(rq\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection matchdepid(DepId\fR \fIdep\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->matchdepid(\fR\fI$dep\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchdepid(\fR\fIdep\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchdepid(\fR\fIdep\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a selection by matching package dependencies against the specified dependency\&. This may be faster than matchdeps and also works with complex dependencies\&. The downside is that you cannot use globs or case insensitive matching\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection matchsolvable(Solvable\fR \fIsolvable\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI$sel\fR \fB=\fR \fI$pool\fR\fB\->matchsolvable(\fR\fI$solvable\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchsolvable(\fR\fIsolvable\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR \fB=\fR \fIpool\fR\fB\&.matchsolvable(\fR\fIsolvable\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a selection by matching package dependencies against the specified solvable\(cqs provides\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid setpooljobs(Jobs *\fR\fIjobs\fR\fB)\fR +\fI$pool\fR\fB\->setpooljobs(\e\fR\fI@jobs\fR\fB)\fR; +\fIpool\fR\fB\&.setpooljobs(\fR\fIjobs\fR\fB)\fR +\fIpool\fR\fB\&.setpooljobs(\fR\fIjobs\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBJob *getpooljobs()\fR +\fI@jobs\fR \fB=\fR \fI$pool\fR\fB\->getpooljobs()\fR; +\fIjobs\fR \fB=\fR \fIpool\fR\fB\&.getpooljobs()\fR +\fIjobs\fR \fB=\fR \fIpool\fR\fB\&.getpooljobs()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Get/Set fixed jobs stored in the pool\&. Those jobs are automatically appended to all solver jobs, they are meant for fixed configurations like which packages can be multiversion installed, which packages were userinstalled, or which packages must not be erased\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_loadcallback(Callable *\fR\fIcallback\fR\fB)\fR +\fI$pool\fR\fB\->setloadcallback(\e\fR\fI&callbackfunction\fR\fB)\fR; +\fIpool\fR\fB\&.setloadcallback(\fR\fIcallbackfunction\fR\fB)\fR +\fIpool\fR\fB\&.setloadcallback { |\fR\fIrepodata\fR\fB| \&.\&.\&. }\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set the callback function called when repository metadata needs to be loaded on demand\&. To make use of this feature, you need to create repodata stubs that tell the library which data is available but not loaded\&. If later on the data needs to be accessed, the callback function is called with a repodata argument\&. You can then load the data (maybe fetching it first from a remote server)\&. The callback should return true if the data has been made available\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +/* bindings only */ +\fI$pool\fR\fB\->appdata_disown()\fR +\fIpool\fR\fB\&.appdata_disown()\fR +\fIpool\fR\fB\&.appdata_disown()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Decrement the reference count of the appdata object\&. This can be used to break circular references (e\&.g\&. if the pool\(cqs appdata value points to some meta data structure that contains a pool handle)\&. If used incorrectly, this method can lead to application crashes, so beware\&. (This method is a no\-op for ruby and tcl\&.) +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *get_considered_list()\fR +my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->get_considered_list()\fR; +\fIids\fR \fB=\fR \fIpool\fR\fB\&.get_considered_list()\fR +\fIids\fR \fB=\fR \fIpool\fR\fB\&.get_considered_list()\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_considered_list(Id *\fR\fIids\fR\fB)\fR +\fI$pool\fR\fB\->set_considered_list(\e\fR\fI@ids\fR\fB)\fR; +\fIpool\fR\fB\&.set_considered_list(\fR\fIids\fR\fB)\fR +\fIpool\fR\fB\&.set_considered_list(\fR\fIids\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Get/set the list of solvables that are eligible for installation\&. Note that you need to recreate the whatprovides hash after changing the list\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *get_disabled_list()\fR +my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->get_disabled_list()\fR; +\fIids\fR \fB=\fR \fIpool\fR\fB\&.get_disabled_list()\fR +\fIids\fR \fB=\fR \fIpool\fR\fB\&.get_disabled_list()\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_disabled_list(Id *\fR\fIids\fR\fB)\fR +\fI$pool\fR\fB\->set_disabled_list(\e\fR\fI@ids\fR\fB)\fR; +\fIpool\fR\fB\&.set_disabled_list(\fR\fIids\fR\fB)\fR +\fIpool\fR\fB\&.set_disabled_list(\fR\fIids\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Get/set the list of solvables that are not eligible for installation\&. This is basically the inverse of the \(lqconsidered\(rq methods above, i\&.e\&. calling \(lqset_disabled_list()\(rq with an empty list will make all solvables eligible for installation\&. Note you need to recreate the whatprovides hash after changing the list\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *solvableset2str(Solvable *\fR\fIsolvables\fR\fB)\fR +my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvableset2str(\fR\fI$solvables\fR\fB)\fR; +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvableset2str(\fR\fIsolvables\fR\fB)\fR +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvableset2str(\fR\fIsolvables\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing a list of solvables\&. The method tries to reduce the output by using version ranges if possible\&. +.SS "DATA RETRIEVAL METHODS" +.sp +In the following functions, the \fIkeyname\fR argument describes what to retrieve\&. For the standard cases you can use the available Id constants\&. For example, +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$solv::SOLVABLE_SUMMARY\fR +\fBsolv\&.SOLVABLE_SUMMARY\fR +\fBSolv::SOLVABLE_SUMMARY\fR +.fi +.if n \{\ +.RE +.\} +.sp +selects the \(lqSummary\(rq entry of a solvable\&. The \fIsolvid\fR argument selects the desired solvable by Id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$string\fR \fB=\fR \fI$pool\fR\fB\->lookup_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId lookup_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$id\fR \fB=\fR \fI$pool\fR\fB\->lookup_id(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIid\fR \fB=\fR \fIpool\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIid\fR \fB=\fR \fIpool\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long lookup_num(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR +my \fI$num\fR \fB=\fR \fI$pool\fR\fB\->lookup_num(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fInum\fR \fB=\fR \fIpool\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fInum\fR \fB=\fR \fIpool\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool lookup_void(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$bool\fR \fB=\fR \fI$pool\fR\fB\->lookup_void(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIbool\fR \fB=\fR \fIpool\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIbool\fR \fB=\fR \fIpool\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *lookup_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->lookup_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIids\fR \fB=\fR \fIpool\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIids\fR \fB=\fR \fIpool\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum lookup_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$chksum\fR \fB=\fR \fI$pool\fR\fB\->lookup_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIchksum\fR \fB=\fR \fIpool\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIchksum\fR \fB=\fR \fIpool\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Lookup functions\&. Return the data element stored in the specified solvable\&. You should probably use the methods of the Solvable class instead\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator(Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$pool\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator_solvid(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$pool\fR\fB\->Dataiterator(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIpool\fR\fB\&.Dataiterator(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the matching data elements\&. See the Dataiterator class for more information\&. The Dataiterator method iterates over all solvables in the pool, whereas the Dataiterator_solvid only iterates over the specified solvable\&. +.SS "ID METHODS" +.sp +The following methods deal with Ids, i\&.e\&. integers representing objects in the pool\&. They are considered \(lqlow level\(rq, in most cases you would not use them but instead the object orientated methods\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo id2repo(Id\fR \fIid\fR\fB)\fR +\fI$repo\fR \fB=\fR \fI$pool\fR\fB\->id2repo(\fR\fI$id\fR\fB)\fR; +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.id2repo(\fR\fIid\fR\fB)\fR +\fIrepo\fR \fB=\fR \fIpool\fR\fB\&.id2repo(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Lookup an existing Repository by id\&. You can also do this by using the \fBrepos\fR attribute\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable id2solvable(Id\fR \fIid\fR\fB)\fR +\fI$solvable\fR \fB=\fR \fI$pool\fR\fB\->id2solvable(\fR\fI$id\fR\fB)\fR; +\fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.id2solvable(\fR\fIid\fR\fB)\fR +\fIsolvable\fR \fB=\fR \fIpool\fR\fB\&.id2solvable(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Lookup an existing Repository by id\&. You can also do this by using the \fBsolvables\fR attribute\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *solvid2str(Id\fR \fIid\fR\fB)\fR +my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvid2str(\fR\fI$id\fR\fB)\fR; +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvid2str(\fR\fIid\fR\fB)\fR +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvid2str(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the Solvable with the specified id\&. The string consists of the name, version, and architecture of the Solvable\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *solvidset2str(Id *\fR\fIsolvids\fR\fB)\fR +my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvidset2str(\e\fR\fI@solvids\fR\fB)\fR; +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvidset2str(\fR\fIsolvids\fR\fB)\fR +\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvidset2str(\fR\fIsolvids\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing a list of solvables\&. The method tries to reduce the output by using version ranges if possible\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId str2id(const char *\fR\fIstr\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$id\fR \fB=\fR \fIpool\fR\fB\->str2id(\fR\fI$string\fR\fB)\fR; +\fIid\fR \fB=\fR \fIpool\fR\fB\&.str2id(\fR\fIstring\fR\fB)\fR +\fIid\fR \fB=\fR \fIpool\fR\fB\&.str2id(\fR\fIstring\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *id2str(Id\fR \fIid\fR\fB)\fR +\fI$string\fR \fB=\fR \fIpool\fR\fB\->id2str(\fR\fI$id\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.id2str(\fR\fIid\fR\fB)\fR +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.id2str(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convert a string into an Id and back\&. If the string is currently not in the pool and \fIcreate\fR is false, zero is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId rel2id(Id\fR \fIname\fR\fB, Id\fR \fIevr\fR\fB, int\fR \fIflags\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$id\fR \fB=\fR \fIpool\fR\fB\->rel2id(\fR\fI$nameid\fR\fB,\fR \fI$evrid\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIid\fR \fB=\fR \fIpool\fR\fB\&.rel2id(\fR\fInameid\fR\fB,\fR \fIevrid\fR\fB,\fR \fIflags\fR\fB)\fR +\fIid\fR \fB=\fR \fIpool\fR\fB\&.rel2id(\fR\fInameid\fR\fB,\fR \fIevrid\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a \(lqrelational\(rq dependency\&. Such dependencies consist of a name part, \fIflags\fR describing the relation, and a version part\&. The flags are: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$solv::REL_EQ | $solv::REL_GT | $solv::REL_LT\fR +\fBsolv\&.REL_EQ | solv\&.REL_GT | solv\&.REL_LT\fR +\fBSolv::REL_EQ | Solv::REL_GT | Solv::REL_LT\fR +.fi +.if n \{\ +.RE +.\} +.sp +Thus, if you want a \(lq<=\(rq relation, you would use \fBREL_LT | REL_EQ\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id2langid(Id\fR \fIid\fR\fB, const char *\fR\fIlang\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$id\fR \fB=\fR \fI$pool\fR\fB\->id2langid(\fR\fI$id\fR\fB,\fR \fI$language\fR\fB)\fR; +\fIid\fR \fB=\fR \fIpool\fR\fB\&.id2langid(\fR\fIid\fR\fB,\fR \fIlanguage\fR\fB)\fR +\fIid\fR \fB=\fR \fIpool\fR\fB\&.id2langid(\fR\fIid\fR\fB,\fR \fIlanguage\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a language specific Id from some other id\&. This function simply converts the id into a string, appends a dot and the specified language to the string and converts the result back into an Id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *dep2str(Id\fR \fIid\fR\fB)\fR +\fI$string\fR \fB=\fR \fIpool\fR\fB\->dep2str(\fR\fI$id\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.dep2str(\fR\fIid\fR\fB)\fR +\fIstring\fR \fB=\fR \fIpool\fR\fB\&.dep2str(\fR\fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convert a dependency id into a string\&. If the id is just a string, this function has the same effect as id2str()\&. For relational dependencies, the result is the correct \(lqname relation evr\(rq string\&. +.SH "THE DEPENDENCY CLASS" +.sp +The dependency class is an object orientated way to work with strings and dependencies\&. Internally, dependencies are represented as Ids, i\&.e\&. simple numbers\&. Dependency objects can be constructed by using the Pool\(cqs Dep() method\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$dep\fR\fB\->{pool}\fR +\fIdep\fR\fB\&.pool\fR +\fIdep\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back reference to the pool this dependency belongs to\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$dep\fR\fB\->{id}\fR +\fIdep\fR\fB\&.id\fR +\fIdep\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of this dependency\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep Rel(int\fR \fIflags\fR\fB, DepId\fR \fIevrid\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$reldep\fR \fB=\fR \fI$dep\fR\fB\->Rel(\fR\fI$flags\fR\fB,\fR \fI$evrdep\fR\fB)\fR; +\fIreldep\fR \fB=\fR \fIdep\fR\fB\&.Rel(\fR\fIflags\fR\fB,\fR \fIevrdep\fR\fB)\fR +\fIreldep\fR \fB=\fR \fIdep\fR\fB\&.Rel(\fR\fIflags\fR\fB,\fR \fIevrdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a relational dependency from the caller dependency, the flags, and a dependency describing the \(lqversion\(rq part\&. See the pool\(cqs rel2id method for a description of the flags\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection_name(int\fR \fIsetflags\fR \fB= 0)\fR +my \fI$sel\fR \fB=\fR \fI$dep\fR\fB\->Selection_name()\fR; +\fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_name()\fR +\fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_name()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a Selection from a dependency\&. The selection consists of all packages that have a name equal to the dependency\&. If the dependency is of a relational type, the packages version must also fulfill the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection_provides(int\fR \fIsetflags\fR \fB= 0)\fR +my \fI$sel\fR \fB=\fR \fI$dep\fR\fB\->Selection_provides()\fR; +\fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_provides()\fR +\fIsel\fR \fB=\fR \fIdep\fR\fB\&.Selection_provides()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a Selection from a dependency\&. The selection consists of all packages that have at least one provides matching the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *str()\fR +my \fI$str\fR \fB=\fR \fI$dep\fR\fB\->str()\fR; +\fIstr\fR \fB=\fR \fI$dep\fR\fB\&.str()\fR +\fIstr\fR \fB=\fR \fI$dep\fR\fB\&.str()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$dep\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIdep\fR\fB)\fR +\fIstr\fR \fB=\fR \fIdep\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Same as calling the str() method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$dep1\fR \fB==\fR \fI$dep2\fR\fB)\fR +\fBif\fR \fIdep1\fR \fB==\fR \fIdep2\fR\fB:\fR +\fBif\fR \fIdep1\fR \fB==\fR \fIdep2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two dependencies are equal if they are part of the same pool and have the same ids\&. +.SH "THE REPOSITORY CLASS" +.sp +A Repository describes a group of packages, normally coming from the same source\&. Repositories are created by the Pool\(cqs add_repo() method\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$repo\fR\fB\->{pool}\fR +\fIrepo\fR\fB\&.pool\fR +\fIrepo\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back reference to the pool this dependency belongs to\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$repo\fR\fB\->{id}\fR +\fIrepo\fR\fB\&.id\fR +\fIrepo\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *name;\fR /* read/write */ +\fI$repo\fR\fB\->{name}\fR +\fIrepo\fR\fB\&.name\fR +\fIrepo\fR\fB\&.name\fR +.fi +.if n \{\ +.RE +.\} +.sp +The repositories name\&. To libsolv, the name is just a string with no specific meaning\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint priority;\fR /* read/write */ +\fI$repo\fR\fB\->{priority}\fR +\fIrepo\fR\fB\&.priority\fR +\fIrepo\fR\fB\&.priority\fR +.fi +.if n \{\ +.RE +.\} +.sp +The priority of the repository\&. A higher number means that packages of this repository will be chosen over other repositories, even if they have a greater package version\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint subpriority;\fR /* read/write */ +\fI$repo\fR\fB\->{subpriority}\fR +\fIrepo\fR\fB\&.subpriority\fR +\fIrepo\fR\fB\&.subpriority\fR +.fi +.if n \{\ +.RE +.\} +.sp +The sub\-priority of the repository\&. This value is compared when the priorities of two repositories are the same\&. It is useful to make the library prefer on\-disk repositories to remote ones\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint nsolvables;\fR /* read only */ +\fI$repo\fR\fB\->{nsolvables}\fR +\fIrepo\fR\fB\&.nsolvables\fR +\fIrepo\fR\fB\&.nsolvables\fR +.fi +.if n \{\ +.RE +.\} +.sp +The number of solvables in this repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid *appdata;\fR /* read/write */ +\fI$repo\fR\fB\->{appdata}\fR +\fIrepo\fR\fB\&.appdata\fR +\fIrepo\fR\fB\&.appdata\fR +.fi +.if n \{\ +.RE +.\} +.sp +Application specific data that may be used in any way by the code using the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDatapos *meta;\fR /* read only */ +\fI$repo\fR\fB\->{meta}\fR +\fIrepo\fR\fB\&.meta\fR +\fIrepo\fR\fB\&.meta\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a Datapos object of the repodata\(cqs metadata\&. You can use the lookup methods of the Datapos class to lookup metadata attributes, like the repository timestamp\&. +.SS "CONSTANTS" +.PP +\fBREPO_REUSE_REPODATA\fR +.RS 4 +Reuse the last repository data area (\(lqrepodata\(rq) instead of creating a new area\&. +.RE +.PP +\fBREPO_NO_INTERNALIZE\fR +.RS 4 +Do not internalize the added repository data\&. This is useful if you plan to add more data because internalization is a costly operation\&. +.RE +.PP +\fBREPO_LOCALPOOL\fR +.RS 4 +Use the repodata\(cqs pool for Id storage instead of the global pool\&. Useful if you don\(cqt want to pollute the global pool with many unneeded ids, like when storing the filelist\&. +.RE +.PP +\fBREPO_USE_LOADING\fR +.RS 4 +Use the repodata that is currently being loaded instead of creating a new one\&. This only makes sense if used in a load callback\&. +.RE +.PP +\fBREPO_EXTEND_SOLVABLES\fR +.RS 4 +Do not create new solvables for the new data, but match existing solvables and add the data to them\&. Repository metadata is often split into multiple parts, with one primary file describing all packages and other parts holding information that is normally not needed, like the changelog\&. +.RE +.PP +\fBREPO_USE_ROOTDIR\fR +.RS 4 +Prepend the pool\(cqs rootdir to the path when doing file operations\&. +.RE +.PP +\fBREPO_NO_LOCATION\fR +.RS 4 +Do not add a location element to the solvables\&. Useful if the solvables are not in the final position, so you can add the correct location later in your code\&. +.RE +.PP +\fBSOLV_ADD_NO_STUBS\fR +.RS 4 +Do not create stubs for repository parts that can be downloaded on demand\&. +.RE +.PP +\fBSUSETAGS_RECORD_SHARES\fR +.RS 4 +This is specific to the add_susetags() method\&. Susetags allows one to refer to already read packages to save disk space\&. If this data sharing needs to work over multiple calls to add_susetags, you need to specify this flag so that the share information is made available to subsequent calls\&. +.RE +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid free(bool\fR \fIreuseids\fR \fB= 0)\fR +\fI$repo\fR\fB\->free()\fR; +\fIrepo\fR\fB\&.free()\fR +\fIrepo\fR\fB\&.free()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Free the repository and all solvables it contains\&. If \fIreuseids\fR is set to true, the solvable ids and the repository id may be reused by the library when added new solvables\&. Thus you should leave it false if you are not sure that somebody holds a reference\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid empty(bool\fR \fIreuseids\fR \fB= 0)\fR +\fI$repo\fR\fB\->empty()\fR; +\fIrepo\fR\fB\&.empty()\fR +\fIrepo\fR\fB\&.empty()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Free all the solvables in a repository\&. The repository will be empty after this call\&. See the free() method for the meaning of \fIreuseids\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isempty()\fR +\fI$repo\fR\fB\->isempty()\fR +\fIrepo\fR\fB\&.empty()\fR +\fIrepo\fR\fB\&.empty?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if there are no solvables in this repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid internalize()\fR +\fI$repo\fR\fB\->internalize()\fR; +\fIrepo\fR\fB\&.internalize()\fR +\fIrepo\fR\fB\&.internalize()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Internalize added data\&. Data must be internalized before it is available to the lookup and data iterator functions\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool write(FILE *\fR\fIfp\fR\fB)\fR +\fI$repo\fR\fB\->write(\fR\fI$fp\fR\fB)\fR +\fIrepo\fR\fB\&.write(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.write(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Write a repo as a \(lqsolv\(rq file\&. These files can be read very fast and thus are a good way to cache repository data\&. Returns false if there was some error writing the file\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvableiterator solvables_iter()\fR +\fBfor my\fR \fI$solvable\fR \fB(\fR\fI@\fR\fB{\fR\fI$repo\fR\fB\->solvables_iter()})\fR +\fBfor\fR \fIsolvable\fR \fBin\fR \fIrepo\fR\fB\&.solvables_iter():\fR +\fBfor\fR \fIsolvable\fR \fBin\fR \fIrepo\fR\fB\&.solvables_iter()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over all solvables in a repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepodata add_repodata(int\fR \fIflags\fR \fB= 0)\fR +my \fI$repodata\fR \fB=\fR \fI$repo\fR\fB\->add_repodata()\fR; +\fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.add_repodata()\fR +\fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.add_repodata()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a new repodata area to the repository\&. This is normally automatically done by the repo_add methods, so you need this method only in very rare circumstances\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid create_stubs()\fR +\fI$repo\fR\fB\->create_stubs()\fR; +\fIrepo\fR\fB\&.create_stubs()\fR +\fIrepo\fR\fB\&.create_stubs()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Calls the create_stubs() repodata method for the last repodata of the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool iscontiguous()\fR +\fI$repo\fR\fB\->iscontiguous()\fR +\fIrepo\fR\fB\&.iscontiguous()\fR +\fIrepo\fR\fB\&.iscontiguous?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the solvables of this repository are all in a single block with no holes, i\&.e\&. they have consecutive ids\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepodata first_repodata()\fR +my \fI$repodata\fR \fB=\fR \fI$repo\fR\fB\->first_repodata()\fR; +\fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.first_repodata()\fR +\fIrepodata\fR \fB=\fR \fIrepo\fR\fB\&.first_repodata()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Checks if all repodatas but the first repodata are extensions, and return the first repodata if this is the case\&. Useful if you want to do a store/retrieve sequence on the repository to reduce the memory using and enable paging, as this does not work if the repository contains multiple non\-extension repodata areas\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection(int\fR \fIsetflags\fR \fB= 0)\fR +my \fI$sel\fR \fB=\fR \fI$repo\fR\fB\->Selection()\fR; +\fIsel\fR \fB=\fR \fIrepo\fR\fB\&.Selection()\fR +\fIsel\fR \fB=\fR \fIrepo\fR\fB\&.Selection()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a Selection consisting of all packages in the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator(Id\fR \fIkey\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$repo\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator_meta(Id\fR \fIkey\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$repo\fR\fB\->Dataiterator_meta(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator_meta(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIrepo\fR\fB\&.Dataiterator_meta(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the matching data elements in this repository\&. See the Dataiterator class for more information\&. The Dataiterator() method iterates over all solvables in a repository, whereas the Dataiterator_meta method only iterates over the repository\(cqs meta data\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$repo\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIrepo\fR\fB)\fR +\fIstr\fR \fB=\fR \fIrepo\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the name of the repository, or "Repo#" if no name is set\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$repo1\fR \fB==\fR \fI$repo2\fR\fB)\fR +\fBif\fR \fIrepo1\fR \fB==\fR \fIrepo2\fR\fB:\fR +\fBif\fR \fIrepo1\fR \fB==\fR \fIrepo2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two repositories are equal if they belong to the same pool and have the same id\&. +.SS "DATA ADD METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable add_solvable()\fR +\fI$repo\fR\fB\->add_solvable()\fR; +\fIrepo\fR\fB\&.add_solvable()\fR +\fIrepo\fR\fB\&.add_solvable()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a single empty solvable to the repository\&. Returns a Solvable object, see the Solvable class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_solv(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_solv(\fR\fI$name\fR\fB)\fR; +\fIrepo\fR\fB\&.add_solv(\fR\fIname\fR\fB)\fR +\fIrepo\fR\fB\&.add_solv(\fR\fIname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_solv(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_solv(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Read a \(lqsolv\(rq file and add its contents to the repository\&. These files can be written with the write() method and are normally used as fast cache for repository metadata\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_rpmdb(int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_rpmdb()\fR; +\fIrepo\fR\fB\&.add_rpmdb()\fR +\fIrepo\fR\fB\&.add_rpmdb()\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_rpmdb_reffp(FILE *\fR\fIreffp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_rpmdb_reffp(\fR\fI$reffp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_rpmdb_reffp(\fR\fIreffp\fR\fB)\fR +\fIrepo\fR\fB\&.add_rpmdb_reffp(\fR\fIreffp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the rpm database to the repository\&. If a solv file containing an old version of the database is available, it can be passed as reffp to speed up reading\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable add_rpm(const char *\fR\fIfilename\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_rpm(\fR\fI$filename\fR\fB)\fR; +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_rpm(\fR\fIfilename\fR\fB)\fR +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_rpm(\fR\fIfilename\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the metadata of a single rpm package to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_rpmdb_pubkeys(int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_rpmdb_pubkeys()\fR; +\fIrepo\fR\fB\&.add_rpmdb_pubkeys()\fR +\fIrepo\fR\fB\&.add_rpmdb_pubkeys()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add all pubkeys contained in the rpm database to the repository\&. Note that newer rpm versions also allow storing the pubkeys in some directory instead of the rpm database\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable add_pubkey(const char *\fR\fIkeyfile\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_pubkey(\fR\fI$keyfile\fR\fB)\fR; +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_pubkey(\fR\fIkeyfile\fR\fB)\fR +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_pubkey(\fR\fIkeyfile\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a pubkey from a file to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_rpmmd(FILE *\fR\fIfp\fR\fB, const char *\fR\fIlanguage\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_rpmmd(\fR\fI$fp\fR\fB,\fR \fIundef\fR\fB)\fR; +\fIrepo\fR\fB\&.add_rpmmd(\fR\fIfp\fR\fB,\fR \fINone\fR\fB)\fR +\fIrepo\fR\fB\&.add_rpmmd(\fR\fIfp\fR\fB,\fR \fInil\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add metadata stored in the "rpm\-md" format (i\&.e\&. from files in the \(lqrepodata\(rq directory) to a repository\&. Supported files are "primary", "filelists", "other", "suseinfo"\&. Do not forget to specify the \fBREPO_EXTEND_SOLVABLES\fR for extension files like "filelists" and "other"\&. Use the \fIlanguage\fR parameter if you have language extension files, otherwise simply use a \fBundef\fR/\fBNone\fR/\fBnil\fR parameter\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_repomdxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_repomdxml(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_repomdxml(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_repomdxml(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the repomd\&.xml meta description from the "rpm\-md" format to the repository\&. This file contains information about the repository like keywords, and also a list of all database files with checksums\&. The data is added to the "meta" section of the repository, i\&.e\&. no package gets created\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_updateinfoxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_updateinfoxml(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_updateinfoxml(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_updateinfoxml(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the updateinfo\&.xml file containing available maintenance updates to the repository\&. All updates are created as special packages that have a "patch:" prefix in their name\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_deltainfoxml(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_deltainfoxml(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_deltainfoxml(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_deltainfoxml(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the deltainfo\&.xml file (also called prestodelta\&.xml) containing available delta\-rpms to the repository\&. The data is added to the "meta" section, i\&.e\&. no package gets created\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_debdb(int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_debdb()\fR; +\fIrepo\fR\fB\&.add_debdb()\fR +\fIrepo\fR\fB\&.add_debdb()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the debian installed package database to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_debpackages(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_debpackages(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_debpackages(\fR\fI$fp\fR\fB)\fR +\fIrepo\fR\fB\&.add_debpackages(\fR\fI$fp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the debian repository metadata (the "packages" file) to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable add_deb(const char *\fR\fIfilename\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +my \fI$solvable\fR \fB=\fR \fI$repo\fR\fB\->add_deb(\fR\fI$filename\fR\fB)\fR; +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_deb(\fR\fIfilename\fR\fB)\fR +\fIsolvable\fR \fB=\fR \fIrepo\fR\fB\&.add_deb(\fR\fIfilename\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the metadata of a single deb package to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_mdk(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_mdk(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_mdk(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the mageia/mandriva repository metadata (the "synthesis\&.hdlist" file) to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_mdk_info(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_mdk_info(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_mdk_info(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_mdk_info(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Extend the packages from the synthesis file with the info\&.xml and files\&.xml data\&. Do not forget to specify \fBREPO_EXTEND_SOLVABLES\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_arch_repo(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_arch_repo(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_arch_repo(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_arch_repo(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the archlinux repository metadata (the "\&.db\&.tar" file) to the repository\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_arch_local(const char *\fR\fIdir\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_arch_local(\fR\fI$dir\fR\fB)\fR; +\fIrepo\fR\fB\&.add_arch_local(\fR\fIdir\fR\fB)\fR +\fIrepo\fR\fB\&.add_arch_local(\fR\fIdir\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the archlinux installed package database to the repository\&. The \fIdir\fR parameter is usually set to "/var/lib/pacman/local"\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_content(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_content(\fR\fI$fp\fR\fB)\fR; +\fIrepo\fR\fB\&.add_content(\fR\fIfp\fR\fB)\fR +\fIrepo\fR\fB\&.add_content(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the \(lqcontent\(rq meta description from the susetags format to the repository\&. This file contains information about the repository like keywords, and also a list of all database files with checksums\&. The data is added to the "meta" section of the repository, i\&.e\&. no package gets created\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_susetags(FILE *\fR\fIfp\fR\fB, Id\fR \fIdefvendor\fR\fB, const char *\fR\fIlanguage\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_susetags(\fR\fI$fp\fR\fB,\fR \fI$defvendor\fR\fB,\fR \fI$language\fR\fB)\fR; +\fIrepo\fR\fB\&.add_susetags(\fR\fIfp\fR\fB,\fR \fIdefvendor\fR\fB,\fR \fIlanguage\fR\fB)\fR +\fIrepo\fR\fB\&.add_susetags(\fR\fIfp\fR\fB,\fR \fIdefvendor\fR\fB,\fR \fIlanguage\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add repository metadata in the susetags format to the repository\&. Like with add_rpmmd, you can specify a language if you have language extension files\&. The \fIdefvendor\fR parameter provides a default vendor for packages with missing vendors, it is usually provided in the content file\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_products(const char *\fR\fIdir\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$repo\fR\fB\->add_products(\fR\fI$dir\fR\fB)\fR; +\fIrepo\fR\fB\&.add_products(\fR\fIdir\fR\fB)\fR +\fIrepo\fR\fB\&.add_products(\fR\fIdir\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the installed SUSE products database to the repository\&. The \fIdir\fR parameter is usually "/etc/products\&.d"\&. +.SH "THE SOLVABLE CLASS" +.sp +A solvable describes all the information of one package\&. Each solvable belongs to one repository, it can be added and filled manually but in most cases solvables will get created by the repo_add methods\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo *repo;\fR /* read only */ +\fI$solvable\fR\fB\->{repo}\fR +\fIsolvable\fR\fB\&.repo\fR +\fIsolvable\fR\fB\&.repo\fR +.fi +.if n \{\ +.RE +.\} +.sp +The repository this solvable belongs to\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$solvable\fR\fB\->{pool}\fR +\fIsolvable\fR\fB\&.pool\fR +\fIsolvable\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +The pool this solvable belongs to, same as the pool of the repo\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$solvable\fR\fB\->{id}\fR +\fIsolvable\fR\fB\&.id\fR +\fIsolvable\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The specific id of the solvable\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *name;\fR /* read/write */ +\fI$solvable\fR\fB\->{name}\fR +\fIsolvable\fR\fB\&.name\fR +\fIsolvable\fR\fB\&.name\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *evr;\fR /* read/write */ +\fI$solvable\fR\fB\->{evr}\fR +\fIsolvable\fR\fB\&.evr\fR +\fIsolvable\fR\fB\&.evr\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *arch;\fR /* read/write */ +\fI$solvable\fR\fB\->{arch}\fR +\fIsolvable\fR\fB\&.arch\fR +\fIsolvable\fR\fB\&.arch\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *vendor;\fR /* read/write */ +\fI$solvable\fR\fB\->{vendor}\fR +\fIsolvable\fR\fB\&.vendor\fR +\fIsolvable\fR\fB\&.vendor\fR +.fi +.if n \{\ +.RE +.\} +.sp +Easy access to often used attributes of solvables\&. They are internally stored as Ids\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId nameid;\fR /* read/write */ +\fI$solvable\fR\fB\->{nameid}\fR +\fIsolvable\fR\fB\&.nameid\fR +\fIsolvable\fR\fB\&.nameid\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId evrid;\fR /* read/write */ +\fI$solvable\fR\fB\->{evrid}\fR +\fIsolvable\fR\fB\&.evrid\fR +\fIsolvable\fR\fB\&.evrid\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId archid;\fR /* read/write */ +\fI$solvable\fR\fB\->{archid}\fR +\fIsolvable\fR\fB\&.archid\fR +\fIsolvable\fR\fB\&.archid\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId vendorid;\fR /* read/write */ +\fI$solvable\fR\fB\->{vendorid}\fR +\fIsolvable\fR\fB\&.vendorid\fR +\fIsolvable\fR\fB\&.vendorid\fR +.fi +.if n \{\ +.RE +.\} +.sp +Raw interface to the ids\&. Useful if you want to search for a specific id and want to avoid the string compare overhead\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_str(Id\fR \fIkeyname\fR\fB)\fR +my \fI$string\fR \fB=\fR \fI$solvable\fR\fB\->lookup_str(\fR\fI$keyname\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR +\fIstring\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId lookup_id(Id\fR \fIkeyname\fR\fB)\fR +my \fI$id\fR \fB=\fR \fI$solvable\fR\fB\->lookup_id(\fR\fI$keyname\fR\fB)\fR; +\fIid\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR +\fIid\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long lookup_num(Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR +my \fI$num\fR \fB=\fR \fI$solvable\fR\fB\->lookup_num(\fR\fI$keyname\fR\fB)\fR; +\fInum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR +\fInum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool lookup_void(Id\fR \fIkeyname\fR\fB)\fR +my \fI$bool\fR \fB=\fR \fI$solvable\fR\fB\->lookup_void(\fR\fI$keyname\fR\fB)\fR; +\fIbool\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR +\fIbool\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum lookup_checksum(Id\fR \fIkeyname\fR\fB)\fR +my \fI$chksum\fR \fB=\fR \fI$solvable\fR\fB\->lookup_checksum(\fR\fI$keyname\fR\fB)\fR; +\fIchksum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR +\fIchksum\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *lookup_idarray(Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI@ids\fR \fB=\fR \fI$solvable\fR\fB\->lookup_idarray(\fR\fI$keyname\fR\fB)\fR; +\fIids\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR +\fIids\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *lookup_deparray(Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +my \fI@deps\fR \fB=\fR \fI$solvable\fR\fB\->lookup_deparray(\fR\fI$keyname\fR\fB)\fR; +\fIdeps\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_deparray(\fR\fIkeyname\fR\fB)\fR +\fIdeps\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_deparray(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Generic lookup methods\&. Retrieve data stored for the specific keyname\&. The lookup_idarray() method will return an array of Ids, use lookup_deparray if you want an array of Dependency objects instead\&. Some Id arrays contain two parts of data divided by a specific marker, for example the provides array uses the SOLVABLE_FILEMARKER id to store both the ids provided by the package and the ids added by the addfileprovides method\&. The default, \-1, translates to the correct marker for the keyname and returns the first part of the array, use 1 to select the second part or 0 to retrieve all ids including the marker\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_location(unsigned int *\fR\fIOUTPUT\fR\fB)\fR +my \fB(\fR\fI$location\fR\fB,\fR \fI$mediano\fR\fB) =\fR \fI$solvable\fR\fB\->lookup_location()\fR; +\fIlocation\fR\fB,\fR \fImediano\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_location()\fR +\fIlocation\fR\fB,\fR \fImediano\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_location()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a tuple containing the on\-media location and an optional media number for multi\-part repositories (e\&.g\&. repositories spawning multiple DVDs)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_sourcepkg()\fR +my \fI$sourcepkg\fR \fB=\fR \fI$solvable\fR\fB\->lookup_sourcepkg()\fR; +\fIsourcepkg\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_sourcepkg()\fR +\fIsourcepkg\fR \fB=\fR \fIsolvable\fR\fB\&.lookup_sourcepkg()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a sourcepkg name associated with solvable\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator(Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$solvable\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIsolvable\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIsolvable\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the matching data elements\&. See the Dataiterator class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_deparray(Id\fR \fIkeyname\fR\fB, DepId\fR \fIdep\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +\fI$solvable\fR\fB\->add_deparray(\fR\fI$keyname\fR\fB,\fR \fI$dep\fR\fB)\fR; +\fIsolvable\fR\fB\&.add_deparray(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +\fIsolvable\fR\fB\&.add_deparray(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a new dependency to the attributes stored in keyname\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid unset(Id\fR \fIkeyname\fR\fB)\fR +\fI$solvable\fR\fB\->unset(\fR\fI$keyname\fR\fB)\fR; +\fIsolvable\fR\fB\&.unset(\fR\fIkeyname\fR\fB)\fR +\fIsolvable\fR\fB\&.unset(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Delete data stored for the specific keyname\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool installable()\fR +\fI$solvable\fR\fB\->installable()\fR +\fIsolvable\fR\fB\&.installable()\fR +\fIsolvable\fR\fB\&.installable?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the solvable is installable on the system\&. Solvables are not installable if the system does not support their architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isinstalled()\fR +\fI$solvable\fR\fB\->isinstalled()\fR +\fIsolvable\fR\fB\&.isinstalled()\fR +\fIsolvable\fR\fB\&.isinstalled?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the solvable is installed on the system\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool identical(Solvable *\fR\fIother\fR\fB)\fR +\fI$solvable\fR\fB\->identical(\fR\fI$other\fR\fB)\fR +\fIsolvable\fR\fB\&.identical(\fR\fIother\fR\fB)\fR +\fIsolvable\fR\fB\&.identical?(\fR\fIother\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the two solvables are identical\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint evrcmp(Solvable *\fR\fIother\fR\fB)\fR +\fI$solvable\fR\fB\->evrcmp(\fR\fI$other\fR\fB)\fR +\fIsolvable\fR\fB\&.evrcmp(\fR\fIother\fR\fB)\fR +\fIsolvable\fR\fB\&.evrcmp(\fR\fIother\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Returns \-1 if the epoch/version/release of the solvable is less than the one from the other solvable, 1 if it is greater, and 0 if they are equal\&. Note that "equal" does not mean that the evr is identical\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint matchesdep(Id\fR \fIkeyname\fR\fB, DepId\fR \fIid\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +\fI$solvable\fR\fB\->matchesdep(\fR\fI$keyname\fR\fB,\fR \fI$dep\fR\fB)\fR +\fIsolvable\fR\fB\&.matchesdep(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +\fIsolvable\fR\fB\&.matchesdep?(\fR\fIkeyname\fR\fB,\fR \fIdep\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the dependencies stored in keyname match the specified dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection Selection(int\fR \fIsetflags\fR \fB= 0)\fR +my \fI$sel\fR \fB=\fR \fI$solvable\fR\fB\->Selection()\fR; +\fIsel\fR \fB=\fR \fIsolvable\fR\fB\&.Selection()\fR +\fIsel\fR \fB=\fR \fIsolvable\fR\fB\&.Selection()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a Selection containing just the single solvable\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *str()\fR +my \fI$str\fR \fB=\fR \fI$solvable\fR\fB\->str()\fR; +\fIstr\fR \fB=\fR \fI$solvable\fR\fB\&.str()\fR +\fIstr\fR \fB=\fR \fI$solvable\fR\fB\&.str()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the solvable\&. The string consists of the name, version, and architecture of the Solvable\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$solvable\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIsolvable\fR\fB)\fR +\fIstr\fR \fB=\fR \fIsolvable\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Same as calling the str() method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$solvable1\fR \fB==\fR \fI$solvable2\fR\fB)\fR +\fBif\fR \fIsolvable1\fR \fB==\fR \fIsolvable2\fR\fB:\fR +\fBif\fR \fIsolvable1\fR \fB==\fR \fIsolvable2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two solvables are equal if they are part of the same pool and have the same ids\&. +.SH "THE DATAITERATOR CLASS" +.sp +Dataiterators can be used to do complex string searches or to iterate over arrays\&. They can be created via the constructors in the Pool, Repo, and Solvable classes\&. The Repo and Solvable constructors will limit the search to the repository or the specific package\&. +.SS "CONSTANTS" +.PP +\fBSEARCH_STRING\fR +.RS 4 +Return a match if the search string matches the value\&. +.RE +.PP +\fBSEARCH_STRINGSTART\fR +.RS 4 +Return a match if the value starts with the search string\&. +.RE +.PP +\fBSEARCH_STRINGEND\fR +.RS 4 +Return a match if the value ends with the search string\&. +.RE +.PP +\fBSEARCH_SUBSTRING\fR +.RS 4 +Return a match if the search string can be matched somewhere in the value\&. +.RE +.PP +\fBSEARCH_GLOB\fR +.RS 4 +Do a glob match of the search string against the value\&. +.RE +.PP +\fBSEARCH_REGEX\fR +.RS 4 +Do a regular expression match of the search string against the value\&. +.RE +.PP +\fBSEARCH_NOCASE\fR +.RS 4 +Ignore case when matching strings\&. Works for all the above match types\&. +.RE +.PP +\fBSEARCH_FILES\fR +.RS 4 +Match the complete filenames of the file list, not just the base name\&. +.RE +.PP +\fBSEARCH_COMPLETE_FILELIST\fR +.RS 4 +When matching the file list, check every file of the package not just the subset from the primary metadata\&. +.RE +.PP +\fBSEARCH_CHECKSUMS\fR +.RS 4 +Allow the matching of checksum entries\&. +.RE +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid prepend_keyname(Id\fR \fIkeyname\fR\fB)\fR; +\fI$di\fR\fB\->prepend_keyname(\fR\fI$keyname\fR\fB)\fR; +\fIdi\fR\fB\&.prepend_keyname(\fR\fIkeyname\fR\fB)\fR +\fIdi\fR\fB\&.prepend_keyname(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Do a sub\-search in the array stored in keyname\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid skip_solvable()\fR; +\fI$di\fR\fB\->skip_solvable()\fR; +\fIdi\fR\fB\&.skip_solvable()\fR +\fIdi\fR\fB\&.skip_solvable()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Stop matching the current solvable and advance to the next one\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate through the matches\&. If there is a match, the object in d will be of type Datamatch\&. +.SH "THE DATAMATCH CLASS" +.sp +Objects of this type will be created for every value matched by a dataiterator\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$d\fR\fB\->{pool}\fR +\fId\fR\fB\&.pool\fR +\fId\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo *repo;\fR /* read only */ +\fI$d\fR\fB\->{repo}\fR +\fId\fR\fB\&.repo\fR +\fId\fR\fB\&.repo\fR +.fi +.if n \{\ +.RE +.\} +.sp +The repository containing the matched object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvable;\fR /* read only */ +\fI$d\fR\fB\->{solvable}\fR +\fId\fR\fB\&.solvable\fR +\fId\fR\fB\&.solvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The solvable containing the value that was matched\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId solvid;\fR /* read only */ +\fI$d\fR\fB\->{solvid}\fR +\fId\fR\fB\&.solvid\fR +\fId\fR\fB\&.solvid\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the solvable that matched\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fIkey_id\fR; +\fI$d\fR\fB\->{\fR\fIkey_id\fR\fB}\fR +\fId\fR\fB\&.key_id\fR +\fId\fR\fB\&.key_id\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *\fR\fIkey_idstr\fR; +\fI$d\fR\fB\->{\fR\fIkey_idstr\fR\fB}\fR +\fId\fR\fB\&.key_idstr\fR +\fId\fR\fB\&.key_idstr\fR +.fi +.if n \{\ +.RE +.\} +.sp +The keyname that matched, either as id or string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fItype_id\fR; +\fI$d\fR\fB\->{\fR\fItype_id\fR\fB}\fR +\fId\fR\fB\&.type_id\fR +\fId\fR\fB\&.type_id\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *\fR\fItype_idstr\fR; +\fI$d\fR\fB\->{\fR\fItype_idstr\fR\fB}\fR; +\fId\fR\fB\&.type_idstr\fR +\fId\fR\fB\&.type_idstr\fR +.fi +.if n \{\ +.RE +.\} +.sp +The key type of the value that was matched, either as id or string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fIid\fR; +\fI$d\fR\fB\->{id}\fR +\fId\fR\fB\&.id\fR +\fId\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fIidstr\fR; +\fI$d\fR\fB\->{idstr}\fR +\fId\fR\fB\&.idstr\fR +\fId\fR\fB\&.idstr\fR +.fi +.if n \{\ +.RE +.\} +.sp +The Id of the value that was matched (only valid for id types), either as id or string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep;\fR /* read only */ +\fI$d\fR\fB\->{dep}\fR +\fId\fR\fB\&.dep\fR +\fId\fR\fB\&.dep\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the value that was matched converted to a dependency object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *\fR\fIstr\fR; +\fI$d\fR\fB\->{str}\fR +\fId\fR\fB\&.str\fR +\fId\fR\fB\&.str\fR +.fi +.if n \{\ +.RE +.\} +.sp +The string value that was matched (only valid for string types)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long\fR \fInum\fR; +\fI$d\fR\fB\->{num}\fR +\fId\fR\fB\&.num\fR +\fId\fR\fB\&.num\fR +.fi +.if n \{\ +.RE +.\} +.sp +The numeric value that was matched (only valid for numeric types)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned int\fR \fInum2\fR; +\fI$d\fR\fB\->{num2}\fR +\fId\fR\fB\&.num2\fR +\fId\fR\fB\&.num2\fR +.fi +.if n \{\ +.RE +.\} +.sp +The secondary numeric value that was matched (only valid for types containing two values)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned int\fR \fIbinary\fR; +\fI$d\fR\fB\->{binary}\fR +\fId\fR\fB\&.binary\fR +\fId\fR\fB\&.binary\fR +.fi +.if n \{\ +.RE +.\} +.sp +The value in binary form, useful for checksums and other data that cannot be represented as a string\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDatapos pos()\fR +my \fI$pos\fR \fB=\fR \fI$d\fR\fB\->pos()\fR; +\fIpos\fR \fB=\fR \fId\fR\fB\&.pos()\fR +\fIpos\fR \fB=\fR \fId\fR\fB\&.pos()\fR +.fi +.if n \{\ +.RE +.\} +.sp +The position object of the current match\&. It can be used to do sub\-searches starting at the match (if it is of an array type)\&. See the Datapos class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDatapos parentpos()\fR +my \fI$pos\fR \fB=\fR \fI$d\fR\fB\->parentpos()\fR; +\fIpos\fR \fB=\fR \fId\fR\fB\&.parentpos()\fR +\fIpos\fR \fB=\fR \fId\fR\fB\&.parentpos()\fR +.fi +.if n \{\ +.RE +.\} +.sp +The position object of the array containing the current match\&. It can be used to do sub\-searches, see the Datapos class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$d\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fId\fR\fB)\fR +\fIstr\fR \fB=\fR \fId\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the stringification of the matched value\&. Stringification depends on the search flags, for file list entries it will return just the base name unless SEARCH_FILES is used, for checksums it will return an empty string unless SEARCH_CHECKSUMS is used\&. Numeric values are currently stringified to an empty string\&. +.SH "THE SELECTION CLASS" +.sp +Selections are a way to easily deal with sets of packages\&. There are multiple constructors to create them, the most useful is probably the select() method in the Pool class\&. +.SS "CONSTANTS" +.PP +\fBSELECTION_NAME\fR +.RS 4 +Create the selection by matching package names\&. +.RE +.PP +\fBSELECTION_PROVIDES\fR +.RS 4 +Create the selection by matching package provides\&. +.RE +.PP +\fBSELECTION_FILELIST\fR +.RS 4 +Create the selection by matching package files\&. +.RE +.PP +\fBSELECTION_CANON\fR +.RS 4 +Create the selection by matching the canonical representation of the package\&. This is normally a combination of the name, the version, and the architecture of a package\&. +.RE +.PP +\fBSELECTION_DOTARCH\fR +.RS 4 +Allow an "\&." suffix when matching names or provides\&. +.RE +.PP +\fBSELECTION_REL\fR +.RS 4 +Allow the specification of a relation when matching names or dependencies, e\&.g\&. "name >= 1\&.2"\&. +.RE +.PP +\fBSELECTION_GLOB\fR +.RS 4 +Allow glob matching for package names, package provides, and file names\&. +.RE +.PP +\fBSELECTION_NOCASE\fR +.RS 4 +Ignore case when matching package names, package provides, and file names\&. +.RE +.PP +\fBSELECTION_FLAT\fR +.RS 4 +Return only one selection element describing the selected packages\&. The default is to create multiple elements for all globbed packages\&. Multiple elements are useful if you want to turn the selection into an install job, in that case you want an install job for every globbed package\&. +.RE +.PP +\fBSELECTION_SKIP_KIND\fR +.RS 4 +Remove a "packagekind:" prefix from the package names\&. +.RE +.PP +\fBSELECTION_MATCH_DEPSTR\fR +.RS 4 +When matching dependencies, do a string match on the result of dep2str instead of using the normal dependency intersect algorithm\&. +.RE +.PP +\fBSELECTION_INSTALLED_ONLY\fR +.RS 4 +Limit the package search to installed packages\&. +.RE +.PP +\fBSELECTION_SOURCE_ONLY\fR +.RS 4 +Limit the package search to source packages only\&. +.RE +.PP +\fBSELECTION_WITH_SOURCE\fR +.RS 4 +Extend the package search to also match source packages\&. The default is only to match binary packages\&. +.RE +.PP +\fBSELECTION_WITH_DISABLED\fR +.RS 4 +Extend the package search to also include disabled packages\&. +.RE +.PP +\fBSELECTION_WITH_BADARCH\fR +.RS 4 +Extend the package search to also include packages that are not installable on the configured architecture\&. +.RE +.PP +\fBSELECTION_WITH_ALL\fR +.RS 4 +Shortcut for selecting the three modifiers above\&. +.RE +.PP +\fBSELECTION_ADD\fR +.RS 4 +Add the result of the match to the current selection instead of replacing it\&. +.RE +.PP +\fBSELECTION_SUBTRACT\fR +.RS 4 +Remove the result of the match to the current selection instead of replacing it\&. +.RE +.PP +\fBSELECTION_FILTER\fR +.RS 4 +Intersect the result of the match to the current selection instead of replacing it\&. +.RE +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$d\fR\fB\->{pool}\fR +\fId\fR\fB\&.pool\fR +\fId\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint flags;\fR /* read only */ +\fI$sel\fR\fB\->{flags}\fR +\fIflags\fR \fB=\fR \fIsel\fR\fB\&.flags\fR +\fIflags\fR \fB=\fR \fIsel\fR\fB\&.flags\fR +.fi +.if n \{\ +.RE +.\} +.sp +The result flags of the selection\&. The flags are a subset of the ones used when creating the selection, they describe which method was used to get the result\&. For example, if you create the selection with \(lqSELECTION_NAME | SELECTION_PROVIDES\(rq, the resulting flags will either be SELECTION_NAME or SELECTION_PROVIDES depending if there was a package that matched the name or not\&. If there was no match at all, the flags will be zero\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isempty()\fR +\fI$sel\fR\fB\->isempty()\fR +\fIsel\fR\fB\&.isempty()\fR +\fIsel\fR\fB\&.isempty?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return true if the selection is empty, i\&.e\&. no package could be matched\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSelection clone(int\fR \fIflags\fR \fB= 0)\fR +my \fI$cloned\fR \fB=\fR \fI$sel\fR\fB\->clone()\fR; +\fIcloned\fR \fB=\fR \fIsel\fR\fB\&.clone()\fR +\fIcloned\fR \fB=\fR \fIsel\fR\fB\&.clone()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a copy of a selection\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid filter(Selection *\fR\fIother\fR\fB)\fR +\fI$sel\fR\fB\->filter(\fR\fI$other\fR\fB)\fR; +\fIsel\fR\fB\&.filter(\fR\fIother\fR\fB)\fR +\fIsel\fR\fB\&.filter(\fR\fIother\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Intersect two selections\&. Packages will only stay in the selection if there are also included in the other selecting\&. Does an in\-place modification\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add(Selection *\fR\fIother\fR\fB)\fR +\fI$sel\fR\fB\->add(\fR\fI$other\fR\fB)\fR; +\fIsel\fR\fB\&.add(\fR\fIother\fR\fB)\fR +\fIsel\fR\fB\&.add(\fR\fIother\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Build the union of two selections\&. All packages of the other selection will be added to the set of packages of the selection object\&. Does an in\-place modification\&. Note that the selection flags are no longer meaningful after the add operation\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid subtract(Selection *\fR\fIother\fR\fB)\fR +\fI$sel\fR\fB\->subtract(\fR\fI$other\fR\fB)\fR; +\fIsel\fR\fB\&.subtract(\fR\fIother\fR\fB)\fR +\fIsel\fR\fB\&.subtract(\fR\fIother\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Remove the packages of the other selection from the packages of the selection object\&. Does an in\-place modification\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_raw(Id\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR +\fI$sel\fR\fB\->add_raw(\fR\fI$how\fR\fB,\fR \fI$what\fR\fB)\fR; +\fIsel\fR\fB\&.add_raw(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR +\fIsel\fR\fB\&.add_raw(\fR\fIhow\fR\fB,\fR \fIwhat\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a raw element to the selection\&. Check the Job class for information about the how and what parameters\&. Note that the selection flags are no longer meaningful after the add_raw operation\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBJob *jobs(int\fR \fIaction\fR\fB)\fR +my \fI@jobs\fR \fB=\fR \fI$sel\fR\fB\->jobs(\fR\fI$action\fR\fB)\fR; +\fIjobs\fR \fB=\fR \fIsel\fR\fB\&.jobs(\fR\fIaction\fR\fB)\fR +\fIjobs\fR \fB=\fR \fIsel\fR\fB\&.jobs(\fR\fIaction\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convert a selection into an array of Job objects\&. The action parameter is or\-ed to the \(lqhow\(rq part of the job, it describes the type of job (e\&.g\&. install, erase)\&. See the Job class for the action and action modifier constants\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvables()\fR +my \fI@solvables\fR \fB=\fR \fI$sel\fR\fB\->solvables()\fR; +\fIsolvables\fR \fB=\fR \fIsel\fR\fB\&.solvables()\fR +\fIsolvables\fR \fB=\fR \fIsel\fR\fB\&.solvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convert a selection into an array of Solvable objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid select(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR\fB)\fR +\fI$sel\fR\fB\->select(\fR\fI$name\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIsel\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR +\fIsel\fR\fB\&.select(\fR\fIname\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Do a select operation and combine the result with the current selection\&. You can choose the desired combination method by using either the SELECTION_ADD, SELECTION_SUBTRACT, or SELECTION_FILTER flag\&. If none of the flags are used, SELECTION_FILTER|SELECTION_WITH_ALL is assumed\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid matchdeps(const char *\fR\fIname\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +\fI$sel\fR\fB\->matchdeps(\fR\fI$name\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR\fB\&.matchdeps(\fR\fIname\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR\fB\&.matchdeps(\fR\fIname\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Do a matchdeps operation and combine the result with the current selection\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid matchdepid(DepId\fR \fIdep\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +\fI$sel\fR\fB\->matchdepid(\fR\fI$dep\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR\fB\&.matchdepid(\fR\fIdep\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR\fB\&.matchdepid(\fR\fIdep\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Do a matchdepid operation and combine the result with the current selection\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid matchsolvable(Solvable\fR \fIsolvable\fR\fB, int\fR \fIflags\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fImarker\fR \fB= \-1)\fR +\fI$sel\fR\fB\->matchsolvable(\fR\fI$solvable\fR\fB,\fR \fI$flags\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIsel\fR\fB\&.matchsolvable(\fR\fIsolvable\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIsel\fR\fB\&.matchsolvable(\fR\fIsolvable\fR\fB,\fR \fIflags\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Do a matchsolvable operation and combine the result with the current selection\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$sel\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIsel\fR\fB)\fR +\fIstr\fR \fB=\fR \fIsel\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the selection\&. +.SH "THE JOB CLASS" +.sp +Jobs are the way to specify to the dependency solver what to do\&. Most of the times jobs will get created by calling the jobs() method on a Selection object, but there is also a Job() constructor in the Pool class\&. +.SS "CONSTANTS" +.sp +Selection constants: +.PP +\fBSOLVER_SOLVABLE\fR +.RS 4 +The \(lqwhat\(rq part is the id of a solvable\&. +.RE +.PP +\fBSOLVER_SOLVABLE_NAME\fR +.RS 4 +The \(lqwhat\(rq part is the id of a package name\&. +.RE +.PP +\fBSOLVER_SOLVABLE_PROVIDES\fR +.RS 4 +The \(lqwhat\(rq part is the id of a package provides\&. +.RE +.PP +\fBSOLVER_SOLVABLE_ONE_OF\fR +.RS 4 +The \(lqwhat\(rq part is an offset into the \(lqwhatprovides\(rq data, created by calling the towhatprovides() pool method\&. +.RE +.PP +\fBSOLVER_SOLVABLE_REPO\fR +.RS 4 +The \(lqwhat\(rq part is the id of a repository\&. +.RE +.PP +\fBSOLVER_SOLVABLE_ALL\fR +.RS 4 +The \(lqwhat\(rq part is ignored, all packages are selected\&. +.RE +.PP +\fBSOLVER_SOLVABLE_SELECTMASK\fR +.RS 4 +A mask containing all the above selection bits\&. +.RE +.sp +Action constants: +.PP +\fBSOLVER_NOOP\fR +.RS 4 +Do nothing\&. +.RE +.PP +\fBSOLVER_INSTALL\fR +.RS 4 +Install a package of the specified set of packages\&. It tries to install the best matching package (i\&.e\&. the highest version of the packages from the repositories with the highest priority)\&. +.RE +.PP +\fBSOLVER_ERASE\fR +.RS 4 +Erase all of the packages from the specified set\&. If a package is not installed, erasing it will keep it from getting installed\&. +.RE +.PP +\fBSOLVER_UPDATE\fR +.RS 4 +Update the matching installed packages to their best version\&. If none of the specified packages are installed, try to update the installed packages to the specified versions\&. See the section about targeted updates about more information\&. +.RE +.PP +\fBSOLVER_WEAKENDEPS\fR +.RS 4 +Allow one to break the dependencies of the matching packages\&. Handle with care\&. +.RE +.PP +\fBSOLVER_MULTIVERSION\fR +.RS 4 +Mark the matched packages for multiversion install\&. If they get to be installed because of some other job, the installation will keep the old version of the package installed (for rpm this is done by using \(lq\-i\(rq instead of \(lq\-U\(rq)\&. +.RE +.PP +\fBSOLVER_LOCK\fR +.RS 4 +Do not change the state of the matched packages, i\&.e\&. when they are installed they stay installed, if not they are not selected for installation\&. +.RE +.PP +\fBSOLVER_DISTUPGRADE\fR +.RS 4 +Update the matching installed packages to the best version included in one of the repositories\&. After this operation, all come from one of the available repositories except orphaned packages\&. Orphaned packages are packages that have no relation to the packages in the repositories, i\&.e\&. no package in the repositories have the same name or obsolete the orphaned package\&. This action brings the installed packages in sync with the ones in the repository\&. By default it also turns of arch/vendor/version locking for the affected packages to simulate a fresh installation\&. This means that distupgrade can actually downgrade packages if only lower versions of a package are available in the repositories\&. You can tweak this behavior with the SOLVER_FLAG_DUP_ solver flags\&. +.RE +.PP +\fBSOLVER_DROP_ORPHANED\fR +.RS 4 +Erase all the matching installed packages if they are orphaned\&. This only makes sense if there is a \(lqdistupgrade all packages\(rq job\&. The default is to erase orphaned packages only if they block the installation of other packages\&. +.RE +.PP +\fBSOLVER_VERIFY\fR +.RS 4 +Fix dependency problems of matching installed packages\&. The default is to ignore dependency problems for installed packages\&. +.RE +.PP +\fBSOLVER_USERINSTALLED\fR +.RS 4 +The matching installed packages are considered to be installed by a user, thus not installed to fulfill some dependency\&. This is needed input for the calculation of unneeded packages for jobs that have the SOLVER_CLEANDEPS flag set\&. +.RE +.PP +\fBSOLVER_ALLOWUNINSTALL\fR +.RS 4 +Allow the solver to deinstall the matching installed packages if they get into the way of resolving a dependency\&. This is like the SOLVER_FLAG_ALLOW_UNINSTALL flag, but limited to a specific set of packages\&. +.RE +.PP +\fBSOLVER_FAVOR\fR +.RS 4 +Prefer the specified packages if the solver encounters an alternative\&. If a job contains multiple matching favor/disfavor elements, the last one takes precedence\&. +.RE +.PP +\fBSOLVER_DISFAVOR\fR +.RS 4 +Avoid the specified packages if the solver encounters an alternative\&. This can also be used to block recommended or supplemented packages from being installed\&. +.RE +.PP +\fBSOLVER_EXCLUDEFROMWEAK\fR +.RS 4 +Avoid the specified packages to satisfy recommended or supplemented dependencies\&. Unlike SOLVER_DISFAVOR, it does not interfere with other rules\&. +.RE +.PP +\fBSOLVER_JOBMASK\fR +.RS 4 +A mask containing all the above action bits\&. +.RE +.sp +Action modifier constants: +.PP +\fBSOLVER_WEAK\fR +.RS 4 +Makes the job a weak job\&. The solver tries to fulfill weak jobs, but does not report a problem if it is not possible to do so\&. +.RE +.PP +\fBSOLVER_ESSENTIAL\fR +.RS 4 +Makes the job an essential job\&. If there is a problem with the job, the solver will not propose to remove the job as one solution (unless all other solutions are also to remove essential jobs)\&. +.RE +.PP +\fBSOLVER_CLEANDEPS\fR +.RS 4 +The solver will try to also erase all packages dragged in through dependencies when erasing the package\&. This needs SOLVER_USERINSTALLED jobs to maximize user satisfaction\&. +.RE +.PP +\fBSOLVER_FORCEBEST\fR +.RS 4 +Insist on the best package for install, update, and distupgrade jobs\&. If this flag is not used, the solver will use the second\-best package if the best package cannot be installed for some reason\&. When this flag is used, the solver will generate a problem instead\&. +.RE +.PP +\fBSOLVER_TARGETED\fR +.RS 4 +Forces targeted operation update and distupgrade jobs\&. See the section about targeted updates about more information\&. +.RE +.sp +Set constants\&. +.PP +\fBSOLVER_SETEV\fR +.RS 4 +The job specified the exact epoch and version of the package set\&. +.RE +.PP +\fBSOLVER_SETEVR\fR +.RS 4 +The job specified the exact epoch, version, and release of the package set\&. +.RE +.PP +\fBSOLVER_SETARCH\fR +.RS 4 +The job specified the exact architecture of the packages from the set\&. +.RE +.PP +\fBSOLVER_SETVENDOR\fR +.RS 4 +The job specified the exact vendor of the packages from the set\&. +.RE +.PP +\fBSOLVER_SETREPO\fR +.RS 4 +The job specified the exact repository of the packages from the set\&. +.RE +.PP +\fBSOLVER_SETNAME\fR +.RS 4 +The job specified the exact name of the packages from the set\&. +.RE +.PP +\fBSOLVER_NOAUTOSET\fR +.RS 4 +Turn of automatic set flag generation for SOLVER_SOLVABLE jobs\&. +.RE +.PP +\fBSOLVER_SETMASK\fR +.RS 4 +A mask containing all the above set bits\&. +.RE +.sp +See the section about set bits for more information\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$job\fR\fB\->{pool}\fR +\fId\fR\fB\&.pool\fR +\fId\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId how;\fR /* read/write */ +\fI$job\fR\fB\->{how}\fR +\fId\fR\fB\&.how\fR +\fId\fR\fB\&.how\fR +.fi +.if n \{\ +.RE +.\} +.sp +Union of the selection, action, action modifier, and set flags\&. The selection part describes the semantics of the \(lqwhat\(rq Id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId what;\fR /* read/write */ +\fI$job\fR\fB\->{what}\fR +\fId\fR\fB\&.what\fR +\fId\fR\fB\&.what\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id describing the set of packages, the meaning depends on the selection part of the \(lqhow\(rq attribute\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvables()\fR +my \fI@solvables\fR \fB=\fR \fI$job\fR\fB\->solvables()\fR; +\fIsolvables\fR \fB=\fR \fIjob\fR\fB\&.solvables()\fR +\fIsolvables\fR \fB=\fR \fIjob\fR\fB\&.solvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the set of solvables of the job as an array of Solvable objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isemptyupdate()\fR +\fI$job\fR\fB\->isemptyupdate()\fR +\fIjob\fR\fB\&.isemptyupdate()\fR +\fIjob\fR\fB\&.isemptyupdate?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convenience function to find out if the job describes an update job with no matching packages, i\&.e\&. a job that does nothing\&. Some package managers like \(lqzypper\(rq like to turn those jobs into install jobs, i\&.e\&. an update of a not\-installed package will result into the installation of the package\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$job\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIjob\fR\fB)\fR +\fIstr\fR \fB=\fR \fIjob\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the job\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$job1\fR \fB==\fR \fI$job2\fR\fB)\fR +\fBif\fR \fIjob1\fR \fB==\fR \fIjob2\fR\fB:\fR +\fBif\fR \fIjob1\fR \fB==\fR \fIjob2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two jobs are equal if they belong to the same pool and both the \(lqhow\(rq and the \(lqwhat\(rq attributes are the same\&. +.SS "TARGETED UPDATES" +.sp +Libsolv has two modes for upgrades and distupgrade: targeted and untargeted\&. Untargeted mode means that the installed packages from the specified set will be updated to the best version\&. Targeted means that packages that can be updated to a package in the specified set will be updated to the best package of the set\&. +.sp +Here\(cqs an example to explain the subtle difference\&. Suppose that you have package A installed in version "1\&.1", "A\-1\&.2" is available in one of the repositories and there is also package "B" that obsoletes package A\&. +.sp +An untargeted update of "A" will update the installed "A\-1\&.1" to package "B", because that is the newest version (B obsoletes A and is thus newer)\&. +.sp +A targeted update of "A" will update "A\-1\&.1" to "A\-1\&.2", as the set of packages contains both "A\-1\&.1" and "A\-1\&.2", and "A\-1\&.2" is the newer one\&. +.sp +An untargeted update of "B" will do nothing, as "B" is not installed\&. +.sp +An targeted update of "B" will update "A\-1\&.1" to "B"\&. +.sp +Note that the default is to do "auto\-targeting", thus if the specified set of packages does not include an installed package, the solver will assume targeted operation even if SOLVER_TARGETED is not used\&. +.sp +This mostly matches the intent of the user, with one exception: In the example above, an update of "A\-1\&.2" will update "A\-1\&.1" to "A\-1\&.2" (targeted mode), but a second update of "A\-1\&.2" will suddenly update to "B", as untargeted mode is chosen because "A\-1\&.2" is now installed\&. +.sp +If you want to have full control over when targeting mode is chosen, turn off auto\-targeting with the SOLVER_FLAG_NO_AUTOTARGET solver option\&. In that case, all updates are considered to be untargeted unless they include the SOLVER_TARGETED flag\&. +.SS "SET BITS" +.sp +Set bits specify which parts of the specified packages where specified by the user\&. It is used by the solver when checking if an operation is allowed or not\&. For example, the solver will normally not allow the downgrade of an installed package\&. But it will not report a problem if the SOLVER_SETEVR flag is used, as it then assumes that the user specified the exact version and thus knows what he is doing\&. +.sp +So if a package "screen\-1\-1" is installed for the x86_64 architecture and version "2\-1" is only available for the i586 architecture, installing package "screen\-2\&.1" will ask the user for confirmation because of the different architecture\&. When using the Selection class to create jobs the set bits are automatically added, e\&.g\&. selecting \(lqscreen\&.i586\(rq will automatically add SOLVER_SETARCH, and thus no problem will be reported\&. +.SH "THE SOLVER CLASS" +.sp +Dependency solving is what this library is about\&. A solver object is needed for solving to store the result of the solver run\&. The solver object can be used multiple times for different jobs, reusing it allows the solver to re\-use the dependency rules it already computed\&. +.SS "CONSTANTS" +.sp +Flags to modify some of the solver\(cqs behavior: +.PP +\fBSOLVER_FLAG_ALLOW_DOWNGRADE\fR +.RS 4 +Allow the solver to downgrade packages without asking for confirmation (i\&.e\&. reporting a problem)\&. +.RE +.PP +\fBSOLVER_FLAG_ALLOW_ARCHCHANGE\fR +.RS 4 +Allow the solver to change the architecture of an installed package without asking for confirmation\&. Note that changes to/from noarch are always considered to be allowed\&. +.RE +.PP +\fBSOLVER_FLAG_ALLOW_VENDORCHANGE\fR +.RS 4 +Allow the solver to change the vendor of an installed package without asking for confirmation\&. Each vendor is part of one or more vendor equivalence classes, normally installed packages may only change their vendor if the new vendor shares at least one equivalence class\&. +.RE +.PP +\fBSOLVER_FLAG_ALLOW_NAMECHANGE\fR +.RS 4 +Allow the solver to change the name of an installed package, i\&.e\&. install a package with a different name that obsoletes the installed package\&. This option is on by default\&. +.RE +.PP +\fBSOLVER_FLAG_ALLOW_UNINSTALL\fR +.RS 4 +Allow the solver to erase installed packages to fulfill the jobs\&. This flag also includes the above flags\&. You may want to set this flag if you only have SOLVER_ERASE jobs, as in that case it\(cqs better for the user to check the transaction overview instead of approving every single package that needs to be erased\&. +.RE +.PP +\fBSOLVER_FLAG_DUP_ALLOW_DOWNGRADE\fR +.RS 4 +Like SOLVER_FLAG_ALLOW_DOWNGRADE, but used in distupgrade mode\&. +.RE +.PP +\fBSOLVER_FLAG_DUP_ALLOW_ARCHCHANGE\fR +.RS 4 +Like SOLVER_FLAG_ALLOW_ARCHCHANGE, but used in distupgrade mode\&. +.RE +.PP +\fBSOLVER_FLAG_DUP_ALLOW_VENDORCHANGE\fR +.RS 4 +Like SOLVER_FLAG_ALLOW_VENDORCHANGE, but used in distupgrade mode\&. +.RE +.PP +\fBSOLVER_FLAG_DUP_ALLOW_NAMECHANGE\fR +.RS 4 +Like SOLVER_FLAG_ALLOW_NAMECHANGE, but used in distupgrade mode\&. +.RE +.PP +\fBSOLVER_FLAG_NO_UPDATEPROVIDE\fR +.RS 4 +If multiple packages obsolete an installed package, the solver checks the provides of every such package and ignores all packages that do not provide the installed package name\&. Thus, you can have an official update candidate that provides the old name, and other packages that also obsolete the package but are not considered for updating\&. If you cannot use this feature, you can turn it off by setting this flag\&. +.RE +.PP +\fBSOLVER_FLAG_NEED_UPDATEPROVIDE\fR +.RS 4 +This is somewhat the opposite of SOLVER_FLAG_NO_UPDATEPROVIDE: Only packages that provide the installed package names are considered for updating\&. +.RE +.PP +\fBSOLVER_FLAG_SPLITPROVIDES\fR +.RS 4 +Make the solver aware of special provides of the form \(lq:\(rq used in SUSE systems to support package splits\&. +.RE +.PP +\fBSOLVER_FLAG_IGNORE_RECOMMENDED\fR +.RS 4 +Do not process optional (aka weak) dependencies\&. +.RE +.PP +\fBSOLVER_FLAG_ADD_ALREADY_RECOMMENDED\fR +.RS 4 +Install recommended or supplemented packages even if they have no connection to the current transaction\&. You can use this feature to implement a simple way for the user to install new recommended packages that were not available in the past\&. +.RE +.PP +\fBSOLVER_FLAG_NO_INFARCHCHECK\fR +.RS 4 +Turn off the inferior architecture checking that is normally done by the solver\&. Normally, the solver allows only the installation of packages from the "best" architecture if a package is available for multiple architectures\&. +.RE +.PP +\fBSOLVER_FLAG_BEST_OBEY_POLICY\fR +.RS 4 +Make the SOLVER_FORCEBEST job option consider only packages that meet the policies for installed packages, i\&.e\&. no downgrades, no architecture change, no vendor change (see the first flags of this section)\&. If the flag is not specified, the solver will enforce the installation of the best package ignoring the installed packages, which may conflict with the set policy\&. +.RE +.PP +\fBSOLVER_FLAG_NO_AUTOTARGET\fR +.RS 4 +Do not enable auto\-targeting up update and distupgrade jobs\&. See the section on targeted updates for more information\&. +.RE +.PP +\fBSOLVER_FLAG_KEEP_ORPHANS\fR +.RS 4 +Do not allow orphaned packages to be deinstalled if they get in the way of resolving other packages\&. +.RE +.PP +\fBSOLVER_FLAG_BREAK_ORPHANS\fR +.RS 4 +Ignore dependencies of orphaned packages that get in the way of resolving non\-orphaned ones\&. Setting the flag might result in no longer working packages in case they are orphaned\&. +.RE +.PP +\fBSOLVER_FLAG_FOCUS_INSTALLED\fR +.RS 4 +Resolve installed packages before resolving the given jobs\&. Setting this flag means that the solver will prefer picking a package version that fits the other installed packages over updating installed packages\&. +.RE +.PP +\fBSOLVER_FLAG_FOCUS_BEST\fR +.RS 4 +First resolve the given jobs, then the dependencies of the resulting packages, then resolve all already installed packages\&. This will result in more packages being updated as when the flag is not used\&. +.RE +.PP +\fBSOLVER_FLAG_FOCUS_NEW\fR +.RS 4 +First resolve the given jobs, then the dependencies of the resulting packages ignoreing the ones provided by currently installed packages\&. After that resolve all already installed packages\&. This is similar to SOLVER_FLAG_FOCUS_BEST but less aggressive in updating packages\&. +.RE +.PP +\fBSOLVER_FLAG_INSTALL_ALSO_UPDATES\fR +.RS 4 +Update the package if a job is already fulfilled by an installed package\&. +.RE +.PP +\fBSOLVER_FLAG_YUM_OBSOLETES\fR +.RS 4 +Turn on yum\-like package split handling\&. See the yum documentation for more details\&. +.RE +.PP +\fBSOLVER_FLAG_URPM_REORDER\fR +.RS 4 +Turn on urpm like package reordering for kernel packages\&. See the urpm documentation for more details\&. +.RE +.sp +Basic rule types: +.PP +\fBSOLVER_RULE_UNKNOWN\fR +.RS 4 +A rule of an unknown class\&. You should never encounter those\&. +.RE +.PP +\fBSOLVER_RULE_PKG\fR +.RS 4 +A rule generated because of a package dependency\&. +.RE +.PP +\fBSOLVER_RULE_UPDATE\fR +.RS 4 +A rule to implement the update policy of installed packages\&. Every installed package has an update rule that consists of the packages that may replace the installed package\&. +.RE +.PP +\fBSOLVER_RULE_FEATURE\fR +.RS 4 +Feature rules are fallback rules used when an update rule is disabled\&. They include all packages that may replace the installed package ignoring the update policy, i\&.e\&. they contain downgrades, arch changes and so on\&. Without them, the solver would simply erase installed packages if their update rule gets disabled\&. +.RE +.PP +\fBSOLVER_RULE_JOB\fR +.RS 4 +Job rules implement the job given to the solver\&. +.RE +.PP +\fBSOLVER_RULE_DISTUPGRADE\fR +.RS 4 +These are simple negative assertions that make sure that only packages are kept that are also available in one of the repositories\&. +.RE +.PP +\fBSOLVER_RULE_INFARCH\fR +.RS 4 +Infarch rules are also negative assertions, they disallow the installation of packages when there are packages of the same name but with a better architecture\&. +.RE +.PP +\fBSOLVER_RULE_CHOICE\fR +.RS 4 +Choice rules are used to make sure that the solver prefers updating to installing different packages when some dependency is provided by multiple packages with different names\&. The solver may always break choice rules, so you will not see them when a problem is found\&. +.RE +.PP +\fBSOLVER_RULE_LEARNT\fR +.RS 4 +These rules are generated by the solver to keep it from running into the same problem multiple times when it has to backtrack\&. They are the main reason why a sat solver is faster than other dependency solver implementations\&. +.RE +.sp +Special dependency rule types: +.PP +\fBSOLVER_RULE_PKG_NOT_INSTALLABLE\fR +.RS 4 +This rule was added to prevent the installation of a package of an architecture that does not work on the system\&. +.RE +.PP +\fBSOLVER_RULE_PKG_NOTHING_PROVIDES_DEP\fR +.RS 4 +The package contains a required dependency which was not provided by any package\&. +.RE +.PP +\fBSOLVER_RULE_PKG_REQUIRES\fR +.RS 4 +The package contains a required dependency which was provided by at least one package\&. +.RE +.PP +\fBSOLVER_RULE_PKG_SELF_CONFLICT\fR +.RS 4 +The package conflicts with itself\&. This is not allowed by older rpm versions\&. +.RE +.PP +\fBSOLVER_RULE_PKG_CONFLICTS\fR +.RS 4 +The package conflices with some other package\&. +.RE +.PP +\fBSOLVER_RULE_PKG_SAME_NAME\fR +.RS 4 +This rules make sure that only one version of a package is installed in the system\&. +.RE +.PP +\fBSOLVER_RULE_PKG_OBSOLETES\fR +.RS 4 +To fulfill the dependencies two packages need to be installed, but one of the packages obsoletes the other one\&. +.RE +.PP +\fBSOLVER_RULE_PKG_IMPLICIT_OBSOLETES\fR +.RS 4 +To fulfill the dependencies two packages need to be installed, but one of the packages has provides a dependency that is obsoleted by the other one\&. See the POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES flag\&. +.RE +.PP +\fBSOLVER_RULE_PKG_INSTALLED_OBSOLETES\fR +.RS 4 +To fulfill the dependencies a package needs to be installed that is obsoleted by an installed package\&. See the POOL_FLAG_NOINSTALLEDOBSOLETES flag\&. +.RE +.PP +\fBSOLVER_RULE_PKG_RECOMMENDS\fR +.RS 4 +The package contains a recommended dependency\&. +.RE +.PP +\fBSOLVER_RULE_PKG_SUPPLEMENTS\fR +.RS 4 +The package contains a dependency to specify it supplements another package\&. +.RE +.PP +\fBSOLVER_RULE_PKG_CONSTRAINS\fR +.RS 4 +The package contains a constraint against some other package (disttype conda)\&. +.RE +.PP +\fBSOLVER_RULE_JOB_NOTHING_PROVIDES_DEP\fR +.RS 4 +The user asked for installation of a package providing a specific dependency, but no available package provides it\&. +.RE +.PP +\fBSOLVER_RULE_JOB_UNKNOWN_PACKAGE\fR +.RS 4 +The user asked for installation of a package with a specific name, but no available package has that name\&. +.RE +.PP +\fBSOLVER_RULE_JOB_PROVIDED_BY_SYSTEM\fR +.RS 4 +The user asked for the erasure of a dependency that is provided by the system (i\&.e\&. for special hardware or language dependencies), this cannot be done with a job\&. +.RE +.PP +\fBSOLVER_RULE_JOB_UNSUPPORTED\fR +.RS 4 +The user asked for something that is not yet implemented, e\&.g\&. the installation of all packages at once\&. +.RE +.sp +Policy error constants +.PP +\fBPOLICY_ILLEGAL_DOWNGRADE\fR +.RS 4 +The solver ask for permission before downgrading packages\&. +.RE +.PP +\fBPOLICY_ILLEGAL_ARCHCHANGE\fR +.RS 4 +The solver ask for permission before changing the architecture of installed packages\&. +.RE +.PP +\fBPOLICY_ILLEGAL_VENDORCHANGE\fR +.RS 4 +The solver ask for permission before changing the vendor of installed packages\&. +.RE +.PP +\fBPOLICY_ILLEGAL_NAMECHANGE\fR +.RS 4 +The solver ask for permission before replacing an installed packages with a package that has a different name\&. +.RE +.sp +Solution element type constants +.PP +\fBSOLVER_SOLUTION_JOB\fR +.RS 4 +The problem can be solved by removing the specified job\&. +.RE +.PP +\fBSOLVER_SOLUTION_POOLJOB\fR +.RS 4 +The problem can be solved by removing the specified job that is defined in the pool\&. +.RE +.PP +\fBSOLVER_SOLUTION_INFARCH\fR +.RS 4 +The problem can be solved by allowing the installation of the specified package with an inferior architecture\&. +.RE +.PP +\fBSOLVER_SOLUTION_DISTUPGRADE\fR +.RS 4 +The problem can be solved by allowing to keep the specified package installed\&. +.RE +.PP +\fBSOLVER_SOLUTION_BEST\fR +.RS 4 +The problem can be solved by allowing to install the specified package that is not the best available package\&. +.RE +.PP +\fBSOLVER_SOLUTION_ERASE\fR +.RS 4 +The problem can be solved by allowing to erase the specified package\&. +.RE +.PP +\fBSOLVER_SOLUTION_REPLACE\fR +.RS 4 +The problem can be solved by allowing to replace the package with some other package\&. +.RE +.PP +\fBSOLVER_SOLUTION_REPLACE_DOWNGRADE\fR +.RS 4 +The problem can be solved by allowing to replace the package with some other package that has a lower version\&. +.RE +.PP +\fBSOLVER_SOLUTION_REPLACE_ARCHCHANGE\fR +.RS 4 +The problem can be solved by allowing to replace the package with some other package that has a different architecture\&. +.RE +.PP +\fBSOLVER_SOLUTION_REPLACE_VENDORCHANGE\fR +.RS 4 +The problem can be solved by allowing to replace the package with some other package that has a different vendor\&. +.RE +.PP +\fBSOLVER_SOLUTION_REPLACE_NAMECHANGE\fR +.RS 4 +The problem can be solved by allowing to replace the package with some other package that has a different name\&. +.RE +.sp +Reason constants +.PP +\fBSOLVER_REASON_UNRELATED\fR +.RS 4 +The package status did not change as it was not related to any job\&. +.RE +.PP +\fBSOLVER_REASON_UNIT_RULE\fR +.RS 4 +The package was installed/erased/kept because of a unit rule, i\&.e\&. a rule where all literals but one were false\&. +.RE +.PP +\fBSOLVER_REASON_KEEP_INSTALLED\fR +.RS 4 +The package was chosen when trying to keep as many packages installed as possible\&. +.RE +.PP +\fBSOLVER_REASON_RESOLVE_JOB\fR +.RS 4 +The decision happened to fulfill a job rule\&. +.RE +.PP +\fBSOLVER_REASON_UPDATE_INSTALLED\fR +.RS 4 +The decision happened to fulfill a package update request\&. +.RE +.PP +\fBSOLVER_REASON_CLEANDEPS_ERASE\fR +.RS 4 +The package was erased when cleaning up dependencies from other erased packages\&. +.RE +.PP +\fBSOLVER_REASON_RESOLVE\fR +.RS 4 +The package was installed to fulfill package dependencies\&. +.RE +.PP +\fBSOLVER_REASON_WEAKDEP\fR +.RS 4 +The package was installed because of a weak dependency (Recommends or Supplements)\&. +.RE +.PP +\fBSOLVER_REASON_RESOLVE_ORPHAN\fR +.RS 4 +The decision about the package was made when deciding the fate of orphaned packages\&. +.RE +.PP +\fBSOLVER_REASON_RECOMMENDED\fR +.RS 4 +This is a special case of SOLVER_REASON_WEAKDEP\&. +.RE +.PP +\fBSOLVER_REASON_SUPPLEMENTED\fR +.RS 4 +This is a special case of SOLVER_REASON_WEAKDEP\&. +.RE +.PP +\fBSOLVER_REASON_UNSOLVABLE\fR +.RS 4 +This is a special case where a rule cannot be fulfilled\&. +.RE +.PP +\fBSOLVER_REASON_PREMISE\fR +.RS 4 +This is a special case for the premises of learnt rules\&. +.RE +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$job\fR\fB\->{pool}\fR +\fId\fR\fB\&.pool\fR +\fId\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to pool\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint set_flag(int\fR \fIflag\fR\fB, int\fR \fIvalue\fR\fB)\fR +my \fI$oldvalue\fR \fB=\fR \fI$solver\fR\fB\->set_flag(\fR\fI$flag\fR\fB,\fR \fI$value\fR\fB)\fR; +\fIoldvalue\fR \fB=\fR \fIsolver\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR +\fIoldvalue\fR \fB=\fR \fIsolver\fR\fB\&.set_flag(\fR\fIflag\fR\fB,\fR \fIvalue\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint get_flag(int\fR \fIflag\fR\fB)\fR +my \fI$value\fR \fB=\fR \fI$solver\fR\fB\->get_flag(\fR\fI$flag\fR\fB)\fR; +\fIvalue\fR \fB=\fR \fIsolver\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR +\fIvalue\fR \fB=\fR \fIsolver\fR\fB\&.get_flag(\fR\fIflag\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set/get a solver specific flag\&. The flags define the policies the solver has to obey\&. The flags are explained in the CONSTANTS section of this class\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBProblem *solve(Job *\fR\fIjobs\fR\fB)\fR +my \fI@problems\fR \fB=\fR \fI$solver\fR\fB\->solve(\e\fR\fI@jobs\fR\fB)\fR; +\fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR +\fIproblems\fR \fB=\fR \fIsolver\fR\fB\&.solve(\fR\fIjobs\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Solve a problem specified in the job list (plus the jobs defined in the pool)\&. Returns an array of problems that need user interaction, or an empty array if no problems were encountered\&. See the Problem class on how to deal with problems\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBTransaction transaction()\fR +my \fI$trans\fR \fB=\fR \fI$solver\fR\fB\->transaction()\fR; +\fItrans\fR \fB=\fR \fIsolver\fR\fB\&.transaction()\fR +\fItrans\fR \fB=\fR \fIsolver\fR\fB\&.transaction()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the transaction to implement the calculated package changes\&. A transaction is available even if problems were found, this is useful for interactive user interfaces that show both the job result and the problems\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *get_recommended(bool\fR \fInoselected\fR\fB=0)\fR +my \fI@solvables\fR \fB=\fR \fI$solver\fR\fB\->get_recommended()\fR; +\fIsolvables\fR \fB=\fR \fIsolver\fR\fB\&.get_recommended()\fR +\fIsolvables\fR \fB=\fR \fIsolver\fR\fB\&.get_recommended()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that are recommended by the solver run result\&. This includes solvables included in the result; set noselected if you want to filter those\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *get_suggested(bool\fR \fInoselected\fR\fB=0)\fR +my \fI@solvables\fR \fB=\fR \fI$solver\fR\fB\->get_suggested()\fR; +\fIsolvables\fR \fB=\fR \fIsolver\fR\fB\&.get_suggested()\fR +\fIsolvables\fR \fB=\fR \fIsolver\fR\fB\&.get_suggested()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that are suggested by the solver run result\&. This includes solvables included in the result; set noselected if you want to filter those\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIDecision\fR \fB= get_decision(Solvable *\fR\fIs\fR\fB)\fR +my \fI$decision\fR \fB=\fR \fI$solver\fR\fB\->get_decision(\fR\fI$solvable\fR\fB)\fR; +\fIdecision\fR \fB=\fR \fIsolver\fR\fB\&.get_decision(\fR\fIsolvable\fR\fB)\fR; +\fIdecision\fR \fB=\fR \fIsolver\fR\fB\&.get_decision(\fR\fIsolvable\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return a decision object that describes why a specific solvable was installed or erased\&. See the Decision class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecision *get_decisionlist(Solvable *\fR\fIs\fR\fB)\fR +my \fI@decisions\fR \fB=\fR \fI$solver\fR\fB\->get_decisionlist(\fR\fI$solvable\fR\fB)\fR; +\fIdecisions\fR \fB=\fR \fIsolver\fR\fB\&.get_decisionlist(\fR\fIsolvable\fR\fB)\fR +\fIdecisions\fR \fB=\fR \fIsolver\fR\fB\&.get_decisionlist(\fR\fIsolvable\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of decisions that caused the specific solvable to be installed or erased\&. This is usually more useful than the get_decision() method, as it returns every involved decision instead of just a single one\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBAlternative *alternatives()\fR +my \fI@alternatives\fR \fB=\fR \fI$solver\fR\fB\->alternatives()\fR; +\fIalternatives\fR \fB=\fR \fIsolver\fR\fB\&.alternatives()\fR +\fIalternatives\fR \fB=\fR \fIsolver\fR\fB\&.alternatives()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all alternatives recorded in the solver run\&. See the Alternative class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint alternatives_count()\fR +my \fI$cnt\fR \fB=\fR \fI$solver\fR\fB\->alternatives_count()\fR; +\fIcnt\fR \fB=\fR \fIsolver\fR\fB\&.alternatives_count()\fR +\fIcnt\fR \fB=\fR \fIsolver\fR\fB\&.alternatives_count()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the number of alternatives without creating alternative objects\&. +.SH "THE PROBLEM CLASS" +.sp +Problems are the way of the solver to interact with the user\&. You can simply list all problems and terminate your program, but a better way is to present solutions to the user and let him pick the ones he likes\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$problem\fR\fB\->{solv}\fR +\fIproblem\fR\fB\&.solv\fR +\fIproblem\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$problem\fR\fB\->{id}\fR +\fIproblem\fR\fB\&.id\fR +\fIproblem\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the problem\&. The first problem has Id 1, they are numbered consecutively\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule findproblemrule()\fR +my \fI$probrule\fR \fB=\fR \fI$problem\fR\fB\->findproblemrule()\fR; +\fIprobrule\fR \fB=\fR \fIproblem\fR\fB\&.findproblemrule()\fR +\fIprobrule\fR \fB=\fR \fIproblem\fR\fB\&.findproblemrule()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the rule that caused the problem\&. Of course in most situations there is no single responsible rule, but many rules that interconnect with each created the problem\&. Nevertheless, the solver uses some heuristic approach to find a rule that somewhat describes the problem best to the user\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule *findallproblemrules(bool\fR \fIunfiltered\fR \fB= 0)\fR +my \fI@probrules\fR \fB=\fR \fI$problem\fR\fB\->findallproblemrules()\fR; +\fIprobrules\fR \fB=\fR \fIproblem\fR\fB\&.findallproblemrules()\fR +\fIprobrules\fR \fB=\fR \fIproblem\fR\fB\&.findallproblemrules()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all rules responsible for the problem\&. The returned set of rules contains all the needed information why there was a problem, but it\(cqs hard to present them to the user in a sensible way\&. The default is to filter out all update and job rules (unless the returned rules only consist of those types)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecision *get_decisionlist()\fR +my \fI@decisions\fR \fB=\fR \fI$problem\fR\fB\->get_decisionlist()\fR; +\fIdecisions\fR \fB=\fR \fIproblem\fR\fB\&.get_decisionlist()\fR +\fIdecisions\fR \fB=\fR \fIproblem\fR\fB\&.get_decisionlist()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of decisions proving the problem\&. This is somewhat similar to the findallproblemrules(), but the output is in an order that makes it easier to understand why the solver could not find a solution\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecisionset *get_decisionsetlist()\fR +my \fI@decisionsets\fR \fB=\fR \fI$problem\fR\fB\->get_decisionsetlist()\fR; +\fIdecisionsets\fR \fB=\fR \fIproblem\fR\fB\&.get_decisionsetlist()\fR +\fIdecisionsets\fR \fB=\fR \fIproblem\fR\fB\&.get_decisionsetlist()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Like the get_decisionlist() method, but the decisions are merged into individual sets\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule *get_learnt()\fR +my \fI@learnt\fR \fB=\fR \fI$problem\fR\fB\->get_learnt()\fR; +\fIlearnt\fR \fB=\fR \fIproblem\fR\fB\&.get_learnt()\fR +\fIlearnt\fR \fB=\fR \fIproblem\fR\fB\&.get_lerant()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of learnt rules that are part of the problem proof\&. This is useful for presenting a complete proof to the user\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolution *solutions()\fR +my \fI@solutions\fR \fB=\fR \fI$problem\fR\fB\->solutions()\fR; +\fIsolutions\fR \fB=\fR \fIproblem\fR\fB\&.solutions()\fR +\fIsolutions\fR \fB=\fR \fIproblem\fR\fB\&.solutions()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return an array containing multiple possible solutions to fix the problem\&. See the solution class for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint solution_count()\fR +my \fI$cnt\fR \fB=\fR \fI$problem\fR\fB\->solution_count()\fR; +\fIcnt\fR \fB=\fR \fIproblem\fR\fB\&.solution_count()\fR +\fIcnt\fR \fB=\fR \fIproblem\fR\fB\&.solution_count()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the number of solutions without creating solution objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$problem\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIproblem\fR\fB)\fR +\fIstr\fR \fB=\fR \fIproblem\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the problem\&. This is a convenience function, it is a shorthand for calling findproblemrule(), then ruleinfo() on the problem rule and problemstr() on the ruleinfo object\&. +.SH "THE RULE CLASS" +.sp +Rules are the basic block of sat solving\&. Each package dependency gets translated into one or multiple rules\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$rule\fR\fB\->{solv}\fR +\fIrule\fR\fB\&.solv\fR +\fIrule\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$rule\fR\fB\->{id}\fR +\fIrule\fR\fB\&.id\fR +\fIrule\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the rule\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint type;\fR /* read only */ +\fI$rule\fR\fB\->{type}\fR +\fIrule\fR\fB\&.type\fR +\fIrule\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +The basic type of the rule\&. See the constant section of the solver class for the type list\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRuleinfo info()\fR +my \fI$ruleinfo\fR \fB=\fR \fI$rule\fR\fB\->info()\fR; +\fIruleinfo\fR \fB=\fR \fIrule\fR\fB\&.info()\fR +\fIruleinfo\fR \fB=\fR \fIrule\fR\fB\&.info()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a Ruleinfo object that contains information about why the rule was created\&. But see the allinfos() method below\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRuleinfo *allinfos()\fR +my \fI@ruleinfos\fR \fB=\fR \fI$rule\fR\fB\->allinfos()\fR; +\fIruleinfos\fR \fB=\fR \fIrule\fR\fB\&.allinfos()\fR +\fIruleinfos\fR \fB=\fR \fIrule\fR\fB\&.allinfos()\fR +.fi +.if n \{\ +.RE +.\} +.sp +As the same dependency rule can get created because of multiple dependencies, one Ruleinfo is not enough to describe the reason\&. Thus the allinfos() method returns an array of all infos about a rule\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecision *get_decisionlist()\fR +my \fI@decisions\fR \fB=\fR \fI$rule\fR\fB\->get_decisionlist()\fR; +\fIdecisions\fR \fB=\fR \fIrule\fR\fB\&.get_decisionlist()\fR +\fIdecisions\fR \fB=\fR \fIrule\fR\fB\&.get_decisionlist()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of decisions proving a learnt rule\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecision *get_decisionsetlist()\fR +my \fI@decisionsets\fR \fB=\fR \fI$rule\fR\fB\->get_decisionsetlist()\fR; +\fIdecisionsets\fR \fB=\fR \fIrule\fR\fB\&.get_decisionsetlist()\fR +\fIdecisionsets\fR \fB=\fR \fIrule\fR\fB\&.get_decisionsetlist()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Like the get_decisionlist() method, but the decisions are merged into individual sets\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule *get_learnt()\fR +my \fI@learnt\fR \fB=\fR \fI$rule\fR\fB\->get_learnt()\fR; +\fIlearnt\fR \fB=\fR \fIrule\fR\fB\&.get_learnt()\fR +\fIlearnt\fR \fB=\fR \fIrule\fR\fB\&.get_lerant()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of learnt rules that are part of the learnt rule proof\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$rule1\fR \fB==\fR \fI$rule2\fR\fB)\fR +\fBif\fR \fIrule1\fR \fB==\fR \fIrule2\fR\fB:\fR +\fBif\fR \fIrule1\fR \fB==\fR \fIrule2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two rules are equal if they belong to the same solver and have the same id\&. +.SH "THE RULEINFO CLASS" +.sp +A Ruleinfo describes one reason why a rule was created\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{solv}\fR +\fIruleinfo\fR\fB\&.solv\fR +\fIruleinfo\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint type;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{type}\fR +\fIruleinfo\fR\fB\&.type\fR +\fIruleinfo\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +The type of the ruleinfo\&. See the constant section of the solver class for the rule type list and the special type list\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{dep}\fR +\fIruleinfo\fR\fB\&.dep\fR +\fIruleinfo\fR\fB\&.dep\fR +.fi +.if n \{\ +.RE +.\} +.sp +The dependency leading to the creation of the rule\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep_id;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{\fR\fIdep_id\fR\fB}\fR +\fIruleinfo\fR\fB\&.dep_id\fR +\fIruleinfo\fR\fB\&.dep_id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The Id of the dependency leading to the creation of the rule, or zero\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvable;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{solvable}\fR +\fIruleinfo\fR\fB\&.solvable\fR +\fIruleinfo\fR\fB\&.solvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The involved Solvable, e\&.g\&. the one containing the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *othersolvable;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{othersolvable}\fR +\fIruleinfo\fR\fB\&.othersolvable\fR +\fIruleinfo\fR\fB\&.othersolvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The other involved Solvable (if any), e\&.g\&. the one providing the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *problemstr()\fR; +my \fI$str\fR \fB=\fR \fI$ruleinfo\fR\fB\->problemstr()\fR; +\fIstr\fR \fB=\fR \fIruleinfo\fR\fB\&.problemstr()\fR +\fIstr\fR \fB=\fR \fIruleinfo\fR\fB\&.problemstr()\fR +.fi +.if n \{\ +.RE +.\} +.sp +A string describing the ruleinfo from a problem perspective\&. This probably only makes sense if the rule is part of a problem\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$ruleinfo\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIruleinfo\fR\fB)\fR +\fIstr\fR \fB=\fR \fIruleinfo\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +A string describing the ruleinfo, i\&.e\&. the reason why the corresponding rule has been created\&. +.SH "THE SOLUTION CLASS" +.sp +A solution solves one specific problem\&. It consists of multiple solution elements that all need to be executed\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$solution\fR\fB\->{solv}\fR +\fIsolution\fR\fB\&.solv\fR +\fIsolution\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId problemid;\fR /* read only */ +\fI$solution\fR\fB\->{problemid}\fR +\fIsolution\fR\fB\&.problemid\fR +\fIsolution\fR\fB\&.problemid\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the problem the solution solves\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$solution\fR\fB\->{id}\fR +\fIsolution\fR\fB\&.id\fR +\fIsolution\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the solution\&. The first solution has Id 1, they are numbered consecutively\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolutionelement *elements(bool\fR \fIexpandreplaces\fR \fB= 0)\fR +my \fI@solutionelements\fR \fB=\fR \fI$solution\fR\fB\->elements()\fR; +\fIsolutionelements\fR \fB=\fR \fIsolution\fR\fB\&.elements()\fR +\fIsolutionelements\fR \fB=\fR \fIsolution\fR\fB\&.elements()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return an array containing the elements describing what needs to be done to implement the specific solution\&. If expandreplaces is true, elements of type SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace elements describing the policy mismatches\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint element_count()\fR +my \fI$cnt\fR \fB=\fR \fI$solution\fR\fB\->solution_count()\fR; +\fIcnt\fR \fB=\fR \fIsolution\fR\fB\&.element_count()\fR +\fIcnt\fR \fB=\fR \fIsolution\fR\fB\&.element_count()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the number of solution elements without creating objects\&. Note that the count does not match the number of objects returned by the elements() method of expandreplaces is set to true\&. +.SH "THE SOLUTIONELEMENT CLASS" +.sp +A solution element describes a single action of a solution\&. The action is always either to remove one specific job or to add a new job that installs or erases a single specific package\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$solutionelement\fR\fB\->{solv}\fR +\fIsolutionelement\fR\fB\&.solv\fR +\fIsolutionelement\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId problemid;\fR /* read only */ +\fI$solutionelement\fR\fB\->{problemid}\fR +\fIsolutionelement\fR\fB\&.problemid\fR +\fIsolutionelement\fR\fB\&.problemid\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the problem the element (partly) solves\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId solutionid;\fR /* read only */ +\fI$solutionelement\fR\fB\->{solutionid}\fR +\fIsolutionelement\fR\fB\&.solutionid\fR +\fIsolutionelement\fR\fB\&.solutionid\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the solution the element is a part of\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$solutionelement\fR\fB\->{id}\fR +\fIsolutionelement\fR\fB\&.id\fR +\fIsolutionelement\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +Id of the solution element\&. The first element has Id 1, they are numbered consecutively\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId type;\fR /* read only */ +\fI$solutionelement\fR\fB\->{type}\fR +\fIsolutionelement\fR\fB\&.type\fR +\fIsolutionelement\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +Type of the solution element\&. See the constant section of the solver class for the existing types\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvable;\fR /* read only */ +\fI$solutionelement\fR\fB\->{solvable}\fR +\fIsolutionelement\fR\fB\&.solvable\fR +\fIsolutionelement\fR\fB\&.solvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The installed solvable that needs to be replaced for replacement elements\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *replacement;\fR /* read only */ +\fI$solutionelement\fR\fB\->{replacement}\fR +\fIsolutionelement\fR\fB\&.replacement\fR +\fIsolutionelement\fR\fB\&.replacement\fR +.fi +.if n \{\ +.RE +.\} +.sp +The solvable that needs to be installed to fix the problem\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint jobidx;\fR /* read only */ +\fI$solutionelement\fR\fB\->{jobidx}\fR +\fIsolutionelement\fR\fB\&.jobidx\fR +\fIsolutionelement\fR\fB\&.jobidx\fR +.fi +.if n \{\ +.RE +.\} +.sp +The index of the job that needs to be removed to fix the problem, or \-1 if the element is of another type\&. Note that it\(cqs better to change the job to SOLVER_NOOP type so that the numbering of other elements does not get disturbed\&. This method works both for types SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolutionelement *replaceelements()\fR +my \fI@solutionelements\fR \fB=\fR \fI$solutionelement\fR\fB\->replaceelements()\fR; +\fIsolutionelements\fR \fB=\fR \fIsolutionelement\fR\fB\&.replaceelements()\fR +\fIsolutionelements\fR \fB=\fR \fIsolutionelement\fR\fB\&.replaceelements()\fR +.fi +.if n \{\ +.RE +.\} +.sp +If the solution element is of type SOLVER_SOLUTION_REPLACE, return an array of elements describing the policy mismatches, otherwise return a copy of the element\&. See also the \(lqexpandreplaces\(rq option in the solution\(cqs elements() method\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint illegalreplace()\fR +my \fI$illegal\fR \fB=\fR \fI$solutionelement\fR\fB\->illegalreplace()\fR; +\fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.illegalreplace()\fR +\fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.illegalreplace()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return an integer that contains the policy mismatch bits or\-ed together, or zero if there was no policy mismatch\&. See the policy error constants in the solver class\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBJob Job()\fR +my \fI$job\fR \fB=\fR \fI$solutionelement\fR\fB\->Job()\fR; +\fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.Job()\fR +\fIillegal\fR \fB=\fR \fIsolutionelement\fR\fB\&.Job()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a job that implements the solution element\&. Add this job to the array of jobs for all elements of type different to SOLVER_SOLUTION_JOB and SOLVER_SOLUTION_POOLJOB\&. For the latter two, a SOLVER_NOOB Job is created, you should replace the old job with the new one\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$solutionelement\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIsolutionelement\fR\fB)\fR +\fIstr\fR \fB=\fR \fIsolutionelement\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +A string describing the change the solution element consists of\&. +.SH "THE TRANSACTION CLASS" +.sp +Transactions describe the output of a solver run\&. A transaction contains a number of transaction elements, each either the installation of a new package or the removal of an already installed package\&. The Transaction class supports a classify() method that puts the elements into different groups so that a transaction can be presented to the user in a meaningful way\&. +.SS "CONSTANTS" +.sp +Transaction element types, both active and passive +.PP +\fBSOLVER_TRANSACTION_IGNORE\fR +.RS 4 +This element does nothing\&. Used to map element types that do not match the view mode\&. +.RE +.PP +\fBSOLVER_TRANSACTION_INSTALL\fR +.RS 4 +This element installs a package\&. +.RE +.PP +\fBSOLVER_TRANSACTION_ERASE\fR +.RS 4 +This element erases a package\&. +.RE +.PP +\fBSOLVER_TRANSACTION_MULTIINSTALL\fR +.RS 4 +This element installs a package with a different version keeping the other versions installed\&. +.RE +.PP +\fBSOLVER_TRANSACTION_MULTIREINSTALL\fR +.RS 4 +This element reinstalls an installed package keeping the other versions installed\&. +.RE +.sp +Transaction element types, active view +.PP +\fBSOLVER_TRANSACTION_REINSTALL\fR +.RS 4 +This element re\-installs a package, i\&.e\&. installs the same package again\&. +.RE +.PP +\fBSOLVER_TRANSACTION_CHANGE\fR +.RS 4 +This element installs a package with same name, version, architecture but different content\&. +.RE +.PP +\fBSOLVER_TRANSACTION_UPGRADE\fR +.RS 4 +This element installs a newer version of an installed package\&. +.RE +.PP +\fBSOLVER_TRANSACTION_DOWNGRADE\fR +.RS 4 +This element installs an older version of an installed package\&. +.RE +.PP +\fBSOLVER_TRANSACTION_OBSOLETES\fR +.RS 4 +This element installs a package that obsoletes an installed package\&. +.RE +.sp +Transaction element types, passive view +.PP +\fBSOLVER_TRANSACTION_REINSTALLED\fR +.RS 4 +This element re\-installs a package, i\&.e\&. installs the same package again\&. +.RE +.PP +\fBSOLVER_TRANSACTION_CHANGED\fR +.RS 4 +This element replaces an installed package with one of the same name, version, architecture but different content\&. +.RE +.PP +\fBSOLVER_TRANSACTION_UPGRADED\fR +.RS 4 +This element replaces an installed package with a new version\&. +.RE +.PP +\fBSOLVER_TRANSACTION_DOWNGRADED\fR +.RS 4 +This element replaces an installed package with an old version\&. +.RE +.PP +\fBSOLVER_TRANSACTION_OBSOLETED\fR +.RS 4 +This element replaces an installed package with a package that obsoletes it\&. +.RE +.sp +Pseudo element types for showing extra information used by classify() +.PP +\fBSOLVER_TRANSACTION_ARCHCHANGE\fR +.RS 4 +This element replaces an installed package with a package of a different architecture\&. +.RE +.PP +\fBSOLVER_TRANSACTION_VENDORCHANGE\fR +.RS 4 +This element replaces an installed package with a package of a different vendor\&. +.RE +.sp +Transaction mode flags +.PP +\fBSOLVER_TRANSACTION_SHOW_ACTIVE\fR +.RS 4 +Filter for active view types\&. The default is to return passive view type, i\&.e\&. to show how the installed packages get changed\&. +.RE +.PP +\fBSOLVER_TRANSACTION_SHOW_OBSOLETES\fR +.RS 4 +Do not map the obsolete view type into INSTALL/ERASE elements\&. +.RE +.PP +\fBSOLVER_TRANSACTION_SHOW_ALL\fR +.RS 4 +If multiple packages replace an installed package, only the best of them is kept as OBSOLETE element, the other ones are mapped to INSTALL/ERASE elements\&. This is because most applications want to show just one package replacing the installed one\&. The SOLVER_TRANSACTION_SHOW_ALL makes the library keep all OBSOLETE elements\&. +.RE +.PP +\fBSOLVER_TRANSACTION_SHOW_MULTIINSTALL\fR +.RS 4 +The library maps MULTIINSTALL elements to simple INSTALL elements\&. This flag can be used to disable the mapping\&. +.RE +.PP +\fBSOLVER_TRANSACTION_CHANGE_IS_REINSTALL\fR +.RS 4 +Use this flag if you want to map CHANGE elements to the REINSTALL type\&. +.RE +.PP +\fBSOLVER_TRANSACTION_OBSOLETE_IS_UPGRADE\fR +.RS 4 +Use this flag if you want to map OBSOLETE elements to the UPGRADE type\&. +.RE +.PP +\fBSOLVER_TRANSACTION_MERGE_ARCHCHANGES\fR +.RS 4 +Do not add extra categories for every architecture change, instead cumulate them in one category\&. +.RE +.PP +\fBSOLVER_TRANSACTION_MERGE_VENDORCHANGES\fR +.RS 4 +Do not add extra categories for every vendor change, instead cumulate them in one category\&. +.RE +.PP +\fBSOLVER_TRANSACTION_RPM_ONLY\fR +.RS 4 +Special view mode that just returns IGNORE, ERASE, INSTALL, MULTIINSTALL elements\&. Useful if you want to find out what to feed to the underlying package manager\&. +.RE +.sp +Transaction order flags +.PP +\fBSOLVER_TRANSACTION_KEEP_ORDERDATA\fR +.RS 4 +Do not throw away the dependency graph used for ordering the transaction\&. This flag is needed if you want to do manual ordering\&. +.RE +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool;\fR /* read only */ +\fI$trans\fR\fB\->{pool}\fR +\fItrans\fR\fB\&.pool\fR +\fItrans\fR\fB\&.pool\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to pool\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool isempty()\fR +\fI$trans\fR\fB\->isempty()\fR +\fItrans\fR\fB\&.isempty()\fR +\fItrans\fR\fB\&.isempty?\fR +.fi +.if n \{\ +.RE +.\} +.sp +Returns true if the transaction does not do anything, i\&.e\&. has no elements\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *newsolvables()\fR +my \fI@newsolvables\fR \fB=\fR \fI$trans\fR\fB\->newsolvables()\fR; +\fInewsolvables\fR \fB=\fR \fItrans\fR\fB\&.newsolvables()\fR +\fInewsolvables\fR \fB=\fR \fItrans\fR\fB\&.newsolvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all packages that are to be installed by the transaction\&. These are the packages that need to be downloaded from the repositories\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *keptsolvables()\fR +my \fI@keptsolvables\fR \fB=\fR \fI$trans\fR\fB\->keptsolvables()\fR; +\fIkeptsolvables\fR \fB=\fR \fItrans\fR\fB\&.keptsolvables()\fR +\fIkeptsolvables\fR \fB=\fR \fItrans\fR\fB\&.keptsolvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all installed packages that the transaction will keep installed\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *steps()\fR +my \fI@steps\fR \fB=\fR \fI$trans\fR\fB\->steps()\fR; +\fIsteps\fR \fB=\fR \fItrans\fR\fB\&.steps()\fR +\fIsteps\fR \fB=\fR \fItrans\fR\fB\&.steps()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all solvables that need to be installed (if the returned solvable is not already installed) or erased (if the returned solvable is installed)\&. A step is also called a transaction element\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint steptype(Solvable *\fR\fIsolvable\fR\fB, int\fR \fImode\fR\fB)\fR +my \fI$type\fR \fB=\fR \fI$trans\fR\fB\->steptype(\fR\fI$solvable\fR\fB,\fR \fI$mode\fR\fB)\fR; +\fItype\fR \fB=\fR \fItrans\fR\fB\&.steptype(\fR\fIsolvable\fR\fB,\fR \fImode\fR\fB)\fR +\fItype\fR \fB=\fR \fItrans\fR\fB\&.steptype(\fR\fIsolvable\fR\fB,\fR \fImode\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the transaction type of the specified solvable\&. See the CONSTANTS sections for the mode argument flags and the list of returned types\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBTransactionClass *classify(int\fR \fImode\fR \fB= 0)\fR +my \fI@classes\fR \fB=\fR \fI$trans\fR\fB\->classify()\fR; +\fIclasses\fR \fB=\fR \fItrans\fR\fB\&.classify()\fR +\fIclasses\fR \fB=\fR \fItrans\fR\fB\&.classify()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Group the transaction elements into classes so that they can be displayed in a structured way\&. You can use various mapping mode flags to tweak the result to match your preferences, see the mode argument flag in the CONSTANTS section\&. See the TransactionClass class for how to deal with the returned objects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable othersolvable(Solvable *\fR\fIsolvable\fR\fB)\fR +my \fI$other\fR \fB=\fR \fI$trans\fR\fB\->othersolvable(\fR\fI$solvable\fR\fB)\fR; +\fIother\fR \fB=\fR \fItrans\fR\fB\&.othersolvable(\fR\fIsolvable\fR\fB)\fR +\fIother\fR \fB=\fR \fItrans\fR\fB\&.othersolvable(\fR\fIsolvable\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the \(lqother\(rq solvable for a given solvable\&. For installed packages the other solvable is the best package with the same name that replaces the installed package, or the best package of the obsoleting packages if the package does not get replaced by one with the same name\&. +.sp +For to be installed packages, the \(lqother\(rq solvable is the best installed package with the same name that will be replaced, or the best packages of all the packages that are obsoleted if the new package does not replace a package with the same name\&. +.sp +Thus, the \(lqother\(rq solvable is normally the package that is also shown for a given package\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *allothersolvables(Solvable *\fR\fIsolvable\fR\fB)\fR +my \fI@others\fR \fB=\fR \fI$trans\fR\fB\->allothersolvables(\fR\fI$solvable\fR\fB)\fR; +\fIothers\fR \fB=\fR \fItrans\fR\fB\&.allothersolvables(\fR\fIsolvable\fR\fB)\fR +\fIothers\fR \fB=\fR \fItrans\fR\fB\&.allothersolvables(\fR\fIsolvable\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +For installed packages, returns all of the packages that replace us\&. For to be installed packages, returns all of the packages that the new package replaces\&. The special \(lqother\(rq solvable is always the first entry of the returned array\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBlong long calc_installsizechange()\fR +my \fI$change\fR \fB=\fR \fI$trans\fR\fB\->calc_installsizechange()\fR; +\fIchange\fR \fB=\fR \fItrans\fR\fB\&.calc_installsizechange()\fR +\fIchange\fR \fB=\fR \fItrans\fR\fB\&.calc_installsizechange()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the size change of the installed system in kilobytes (kibibytes)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid order(int\fR \fIflags\fR \fB= 0)\fR +\fI$trans\fR\fB\->order()\fR; +\fItrans\fR\fB\&.order()\fR +\fItrans\fR\fB\&.order()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Order the steps in the transactions so that dependent packages are updated before packages that depend on them\&. For rpm, you can also use rpmlib\(cqs ordering functionality, debian\(cqs dpkg does not provide a way to order a transaction\&. +.SS "ACTIVE/PASSIVE VIEW" +.sp +Active view lists what new packages get installed, while passive view shows what happens to the installed packages\&. Most often there\(cqs not much difference between the two modes, but things get interesting if multiple packages get replaced by one new package\&. Say you have installed packages A\-1\-1 and B\-1\-1, and now install A\-2\-1 which has a new dependency that obsoletes B\&. The transaction elements will be +.sp +.if n \{\ +.RS 4 +.\} +.nf +updated A\-1\-1 (other: A\-2\-1) +obsoleted B\-1\-1 (other: A\-2\-1) +.fi +.if n \{\ +.RE +.\} +.sp +in passive mode, but +.sp +.if n \{\ +.RS 4 +.\} +.nf +update A\-2\-1 (other: A\-1\-1) +erase B +.fi +.if n \{\ +.RE +.\} +.sp +in active mode\&. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the passive mode list will be unchanged but the active mode list will just contain A\-2\-1\&. +.SH "THE TRANSACTIONCLASS CLASS" +.sp +Objects of this type are returned by the classify() Transaction method\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBTransaction *transaction;\fR /* read only */ +\fI$class\fR\fB\->{transaction}\fR +\fIclass\fR\fB\&.transaction\fR +\fIclass\fR\fB\&.transaction\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to transaction object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint type;\fR /* read only */ +\fI$class\fR\fB\->{type}\fR +\fIclass\fR\fB\&.type\fR +\fIclass\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +The type of the transaction elements in the class\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint count;\fR /* read only */ +\fI$class\fR\fB\->{count}\fR +\fIclass\fR\fB\&.count\fR +\fIclass\fR\fB\&.count\fR +.fi +.if n \{\ +.RE +.\} +.sp +The number of elements in the class\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *\fR\fIfromstr\fR; +\fI$class\fR\fB\->{fromstr}\fR +\fIclass\fR\fB\&.fromstr\fR +\fIclass\fR\fB\&.fromstr\fR +.fi +.if n \{\ +.RE +.\} +.sp +The old vendor or architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *\fR\fItostr\fR; +\fI$class\fR\fB\->{tostr}\fR +\fIclass\fR\fB\&.tostr\fR +\fIclass\fR\fB\&.tostr\fR +.fi +.if n \{\ +.RE +.\} +.sp +The new vendor or architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fIfromid\fR; +\fI$class\fR\fB\->{fromid}\fR +\fIclass\fR\fB\&.fromid\fR +\fIclass\fR\fB\&.fromid\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the old vendor or architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId\fR \fItoid\fR; +\fI$class\fR\fB\->{toid}\fR +\fIclass\fR\fB\&.toid\fR +\fIclass\fR\fB\&.toid\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the new vendor or architecture\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid solvables()\fR; +my \fI@solvables\fR \fB=\fR \fI$class\fR\fB\->solvables()\fR; +\fIsolvables\fR \fB=\fR \fIclass\fR\fB\&.solvables()\fR +\fIsolvables\fR \fB=\fR \fIclass\fR\fB\&.solvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the solvables for all transaction elements in the class\&. +.SH "CHECKSUMS" +.sp +Checksums (also called hashes) are used to make sure that downloaded data is not corrupt and also as a fingerprint mechanism to check if data has changed\&. +.SS "CLASS METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum Chksum(Id\fR \fItype\fR\fB)\fR +my \fI$chksum\fR \fB= solv::Chksum\->new(\fR\fI$type\fR\fB)\fR; +\fIchksum\fR \fB= solv\&.Chksum(\fR\fItype\fR\fB)\fR +\fIchksum\fR \fB= Solv::Chksum\&.new(\fR\fItype\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a checksum object\&. Currently the following types are supported: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBREPOKEY_TYPE_MD5\fR +\fBREPOKEY_TYPE_SHA1\fR +\fBREPOKEY_TYPE_SHA224\fR +\fBREPOKEY_TYPE_SHA256\fR +\fBREPOKEY_TYPE_SHA384\fR +\fBREPOKEY_TYPE_SHA512\fR +.fi +.if n \{\ +.RE +.\} +.sp +These keys are constants in the \fBsolv\fR class\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum Chksum(Id\fR \fItype\fR\fB, const char *\fR\fIhex\fR\fB)\fR +my \fI$chksum\fR \fB= solv::Chksum\->new(\fR\fI$type\fR\fB,\fR \fI$hex\fR\fB)\fR; +\fIchksum\fR \fB= solv\&.Chksum(\fR\fItype\fR\fB,\fR \fIhex\fR\fB)\fR +\fIchksum\fR \fB= Solv::Chksum\&.new(\fR\fItype\fR\fB,\fR \fIhex\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create an already finalized checksum object from a hex string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum Chksum_from_bin(Id\fR \fItype\fR\fB, char *\fR\fIbin\fR\fB)\fR +my \fI$chksum\fR \fB= solv::Chksum\->from_bin(\fR\fI$type\fR\fB,\fR \fI$bin\fR\fB)\fR; +\fIchksum\fR \fB= solv\&.Chksum\&.from_bin(\fR\fItype\fR\fB,\fR \fIbin\fR\fB)\fR +\fIchksum\fR \fB= Solv::Chksum\&.from_bin(\fR\fItype\fR\fB,\fR \fIbin\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create an already finalized checksum object from a binary checksum\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId type;\fR /* read only */ +\fI$chksum\fR\fB\->{type}\fR +\fIchksum\fR\fB\&.type\fR +\fIchksum\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the type of the checksum object\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add(const char *\fR\fIstr\fR\fB)\fR +\fI$chksum\fR\fB\->add(\fR\fI$str\fR\fB)\fR; +\fIchksum\fR\fB\&.add(\fR\fIstr\fR\fB)\fR +\fIchksum\fR\fB\&.add(\fR\fIstr\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a (binary) string to the checksum\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_fp(FILE *\fR\fIfp\fR\fB)\fR +\fI$chksum\fR\fB\->add_fp(\fR\fI$file\fR\fB)\fR; +\fIchksum\fR\fB\&.add_fp(\fR\fIfile\fR\fB)\fR +\fIchksum\fR\fB\&.add_fp(\fR\fIfile\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of a file to the checksum\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_stat(const char *\fR\fIfilename\fR\fB)\fR +\fI$chksum\fR\fB\->add_stat(\fR\fI$filename\fR\fB)\fR; +\fIchksum\fR\fB\&.add_stat(\fR\fIfilename\fR\fB)\fR +\fIchksum\fR\fB\&.add_stat(\fR\fIfilename\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Stat the file and add the dev/ino/size/mtime member to the checksum\&. If the stat fails, the members are zeroed\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_fstat(int\fR \fIfd\fR\fB)\fR +\fI$chksum\fR\fB\->add_fstat(\fR\fI$fd\fR\fB)\fR; +\fIchksum\fR\fB\&.add_fstat(\fR\fIfd\fR\fB)\fR +\fIchksum\fR\fB\&.add_fstat(\fR\fIfd\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Same as add_stat, but instead of the filename a file descriptor is used\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned char *raw()\fR +my \fI$raw\fR \fB=\fR \fI$chksum\fR\fB\->raw()\fR; +\fIraw\fR \fB=\fR \fIchksum\fR\fB\&.raw()\fR +\fIraw\fR \fB=\fR \fIchksum\fR\fB\&.raw()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Finalize the checksum and return the result as raw bytes\&. This means that the result can contain NUL bytes or unprintable characters\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *hex()\fR +my \fI$raw\fR \fB=\fR \fI$chksum\fR\fB\->hex()\fR; +\fIraw\fR \fB=\fR \fIchksum\fR\fB\&.hex()\fR +\fIraw\fR \fB=\fR \fIchksum\fR\fB\&.hex()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Finalize the checksum and return the result as hex string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *typestr()\fR +my \fI$typestr\fR \fB=\fR \fI$chksum\fR\fB\->typestr()\fR; +\fItypestr\fR \fB=\fR \fIchksum\fR\fB\&.typestr\fR +\fItypestr\fR \fB=\fR \fIchksum\fR\fB\&.typestr\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the type of the checksum as a string, e\&.g\&. "sha256"\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$chksum1\fR \fB==\fR \fI$chksum2\fR\fB)\fR +\fBif\fR \fIchksum1\fR \fB==\fR \fIchksum2\fR\fB:\fR +\fBif\fR \fIchksum1\fR \fB==\fR \fIchksum2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Checksums are equal if they are of the same type and the finalized results are the same\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$chksum\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIchksum\fR\fB)\fR +\fIstr\fR \fB=\fR \fIchksum\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +If the checksum is finished, the checksum is returned as ":" string\&. Otherwise ":unfinished" is returned\&. +.SH "FILE MANAGEMENT" +.sp +This functions were added because libsolv uses standard \fBFILE\fR pointers to read/write files, but languages like perl have their own implementation of files\&. The libsolv functions also support decompression and compression, the algorithm is selected by looking at the file name extension\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBFILE *xfopen(char *\fR\fIfn\fR\fB, char *\fR\fImode\fR \fB= "r")\fR +my \fI$file\fR \fB= solv::xfopen(\fR\fI$path\fR\fB)\fR; +\fIfile\fR \fB= solv\&.xfopen(\fR\fIpath\fR\fB)\fR +\fIfile\fR \fB= Solv::xfopen(\fR\fIpath\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Open a file at the specified path\&. The mode argument is passed on to the stdio library\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBFILE *xfopen_fd(char *\fR\fIfn\fR\fB, int\fR \fIfileno\fR\fB)\fR +my \fI$file\fR \fB= solv::xfopen_fd(\fR\fI$path\fR\fB,\fR \fI$fileno\fR\fB)\fR; +\fIfile\fR \fB= solv\&.xfopen_fd(\fR\fIpath\fR\fB,\fR \fIfileno\fR\fB)\fR +\fIfile\fR \fB= Solv::xfopen_fd(\fR\fIpath\fR\fB,\fR \fIfileno\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a file handle from the specified file descriptor\&. The path argument is only used to select the correct (de\-)compression algorithm, use an empty path if you want to make sure to read/write raw data\&. The file descriptor is dup()ed before the file handle is created\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint fileno()\fR +my \fI$fileno\fR \fB=\fR \fI$file\fR\fB\->fileno()\fR; +\fIfileno\fR \fB=\fR \fIfile\fR\fB\&.fileno()\fR +\fIfileno\fR \fB=\fR \fIfile\fR\fB\&.fileno()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return file file descriptor of the file\&. If the file is not open, \-1 is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid cloexec(bool\fR \fIstate\fR\fB)\fR +\fI$file\fR\fB\->cloexec(\fR\fI$state\fR\fB)\fR; +\fIfile\fR\fB\&.cloexec(\fR\fIstate\fR\fB)\fR +\fIfile\fR\fB\&.cloexec(\fR\fIstate\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Set the close\-on\-exec flag of the file descriptor\&. The xfopen function returns files with close\-on\-exec turned on, so if you want to pass a file to some other process you need to call cloexec(0) before calling exec\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint dup()\fR +my \fI$fileno\fR \fB=\fR \fI$file\fR\fB\->dup()\fR; +\fIfileno\fR \fB=\fR \fIfile\fR\fB\&.dup()\fR +\fIfileno\fR \fB=\fR \fIfile\fR\fB\&.dup()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a copy of the descriptor of the file\&. If the file is not open, \-1 is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool flush()\fR +\fI$file\fR\fB\->flush()\fR; +\fIfile\fR\fB\&.flush()\fR +\fIfile\fR\fB\&.flush()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Flush the file\&. Returns false if there was an error\&. Flushing a closed file always returns true\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool close()\fR +\fI$file\fR\fB\->close()\fR; +\fIfile\fR\fB\&.close()\fR +\fIfile\fR\fB\&.close()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Close the file\&. This is needed for languages like Ruby that do not destruct objects right after they are no longer referenced\&. In that case, it is good style to close open files so that the file descriptors are freed right away\&. Returns false if there was an error\&. +.SH "THE REPODATA CLASS" +.sp +The Repodata stores attributes for packages and the repository itself, each repository can have multiple repodata areas\&. You normally only need to directly access them if you implement lazy downloading of repository data\&. Repodata areas are created by calling the repository\(cqs add_repodata() method or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING flag\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo *repo;\fR /* read only */ +\fI$data\fR\fB\->{repo}\fR +\fIdata\fR\fB\&.repo\fR +\fIdata\fR\fB\&.repo\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to repository object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId id;\fR /* read only */ +\fI$data\fR\fB\->{id}\fR +\fIdata\fR\fB\&.id\fR +\fIdata\fR\fB\&.id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The id of the repodata area\&. Repodata ids of different repositories overlap\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBinternalize()\fR +\fI$data\fR\fB\->internalize()\fR; +\fIdata\fR\fB\&.internalize()\fR +\fIdata\fR\fB\&.internalize()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Internalize newly added data\&. The lookup functions will only see the new data after it has been internalized\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool write(FILE *\fR\fIfp\fR\fB)\fR +\fI$data\fR\fB\->write(\fR\fI$fp\fR\fB)\fR; +\fIdata\fR\fB\&.write(\fR\fIfp\fR\fB)\fR +\fIdata\fR\fB\&.write(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Write the contents of the repodata area as solv file\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId str2dir(const char *\fR\fIdir\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR +my \fI$did\fR \fB=\fR \fIdata\fR\fB\->str2dir(\fR\fI$dir\fR\fB)\fR; +\fIdid\fR \fB=\fR \fIdata\fR\fB\&.str2dir(\fR\fIdir\fR\fB)\fR +\fIdid\fR \fB=\fR \fIdata\fR\fB\&.str2dir(\fR\fIdir\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *dir2str(Id\fR \fIdid\fR\fB, const char *\fR\fIsuffix\fR \fB= 0)\fR +\fI$dir\fR \fB=\fR \fIpool\fR\fB\->dir2str(\fR\fI$did\fR\fB)\fR; +\fIdir\fR \fB=\fR \fIpool\fR\fB\&.dir2str(\fR\fIdid\fR\fB)\fR +\fIdir\fR \fB=\fR \fIpool\fR\fB\&.dir2str(\fR\fIdid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Convert a string (directory) into an Id and back\&. If the string is currently not in the pool and \fIcreate\fR is false, zero is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_dirstr(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fIdir\fR\fB, const char *\fR\fIstr\fR\fB)\fR +\fI$data\fR\fB\->add_dirstr(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$dir\fR\fB,\fR \fI$string\fR\fB)\fR; +\fIdata\fR\fB\&.add_dirstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIdir\fR\fB,\fR \fIstring\fR\fB)\fR +\fIdata\fR\fB\&.add_dirstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIdir\fR\fB,\fR \fIstring\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Add a file path consisting of a dirname Id and a basename string\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool add_solv(FILE *\fR\fIfp\fR\fB, int\fR \fIflags\fR \fB= 0)\fR +\fI$data\fR\fB\->add_solv(\fR\fI$fp\fR\fB)\fR; +\fIdata\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR +\fIdata\fR\fB\&.add_solv(\fR\fIfp\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Replace a stub repodata object with the data from a solv file\&. This method automatically adds the REPO_USE_LOADING flag\&. It should only be used from a load callback\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid create_stubs()\fR +\fI$data\fR\fB\->create_stubs()\fR; +\fIdata\fR\fB\&.create_stubs()\fR +\fIdata\fR\fB\&.create_stubs()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create stub repodatas from the information stored in the repodata meta area\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid extend_to_repo()\fR +\fI$data\fR\fB\->extend_to_repo()\fR; +\fIdata\fR\fB\&.extend_to_repo()\fR +\fIdata\fR\fB\&.extend_to_repo()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Extend the repodata so that it has the same size as the repo it belongs to\&. This method is needed when setting up a new extension repodata so that it matches the repository size\&. It is also needed when switching to a just written repodata extension to make the repodata match the written extension (which is always of the size of the repo)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +\fBif (\fR\fI$data1\fR \fB==\fR \fI$data2\fR\fB)\fR +\fBif\fR \fIdata1\fR \fB==\fR \fIdata2\fR\fB:\fR +\fBif\fR \fIdata1\fR \fB==\fR \fIdata2\fR +.fi +.if n \{\ +.RE +.\} +.sp +Two repodata objects are equal if they belong to the same repository and have the same id\&. +.SS "DATA RETRIEVAL METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$string\fR \fB=\fR \fI$data\fR\fB\->lookup_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$string\fR \fB=\fR \fI$data\fR\fB\->lookup_id(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIstring\fR \fB=\fR \fIdata\fR\fB\&.lookup_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long lookup_num(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR +my \fI$num\fR \fB=\fR \fI$data\fR\fB\->lookup_num(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fInum\fR \fB=\fR \fIdata\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fInum\fR \fB=\fR \fIdata\fR\fB\&.lookup_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool lookup_void(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$bool\fR \fB=\fR \fI$data\fR\fB\->lookup_void(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIbool\fR \fB=\fR \fIdata\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIbool\fR \fB=\fR \fIdata\fR\fB\&.lookup_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *lookup_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI@ids\fR \fB=\fR \fI$data\fR\fB\->lookup_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIids\fR \fB=\fR \fIdata\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIids\fR \fB=\fR \fIdata\fR\fB\&.lookup_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum lookup_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$chksum\fR \fB=\fR \fI$data\fR\fB\->lookup_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIchksum\fR \fB=\fR \fIdata\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIchksum\fR \fB=\fR \fIdata\fR\fB\&.lookup_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Lookup functions\&. Return the data element stored in the specified solvable\&. The methods probably only make sense to retrieve data from the special SOLVID_META solvid that stores repodata meta information\&. +.SS "DATA STORAGE METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_str(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fIstr\fR\fB)\fR +\fI$data\fR\fB\->set_str(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$str\fR\fB)\fR; +\fIdata\fR\fB\&.set_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR +\fIdata\fR\fB\&.set_str(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, DepId\fR \fIid\fR\fB)\fR +\fI$data\fR\fB\->set_id(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$id\fR\fB)\fR; +\fIdata\fR\fB\&.set_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR +\fIdata\fR\fB\&.set_id(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_num(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInum\fR\fB)\fR +\fI$data\fR\fB\->set_num(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$num\fR\fB)\fR; +\fIdata\fR\fB\&.set_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fInum\fR\fB)\fR +\fIdata\fR\fB\&.set_num(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fInum\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_void(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +\fI$data\fR\fB\->set_void(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIdata\fR\fB\&.set_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIdata\fR\fB\&.set_void(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_poolstr(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fIstr\fR\fB)\fR +\fI$data\fR\fB\->set_poolstr(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$str\fR\fB)\fR; +\fIdata\fR\fB\&.set_poolstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR +\fIdata\fR\fB\&.set_poolstr(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIstr\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_checksum(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Chksum *\fR\fIchksum\fR\fB)\fR +\fI$data\fR\fB\->set_checksum(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$chksum\fR\fB)\fR; +\fIdata\fR\fB\&.set_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIchksum\fR\fB)\fR +\fIdata\fR\fB\&.set_checksum(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIchksum\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_sourcepkg(Id\fR \fIsolvid\fR\fB, const char *\fR\fIsourcepkg\fR\fB)\fR +\fI$data\fR\fB\&.set_sourcepkg(\fR\fI$solvid\fR\fB,\fR \fI$sourcepkg\fR\fB)\fR; +\fIdata\fR\fB\&.set_sourcepkg(\fR\fIsolvid\fR\fB,\fR \fIsourcepkg\fR\fB)\fR +\fIdata\fR\fB\&.set_sourcepkg(\fR\fIsolvid\fR\fB,\fR \fIsourcepkg\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid set_location(Id\fR \fIsolvid\fR\fB, unsigned int\fR \fImediano\fR\fB, const char *\fR\fIlocation\fR\fB)\fR +\fI$data\fR\fB\&.set_location(\fR\fI$solvid\fR\fB,\fR \fI$mediano\fR\fB,\fR \fI$location\fR\fB)\fR; +\fIdata\fR\fB\&.set_location(\fR\fIsolvid\fR\fB,\fR \fImediano\fR\fB,\fR \fIlocation\fR\fB)\fR +\fIdata\fR\fB\&.set_location(\fR\fIsolvid\fR\fB,\fR \fImediano\fR\fB,\fR \fIlocation\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_idarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, DepId\fR \fIid\fR\fB)\fR +\fI$data\fR\fB\->add_idarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$id\fR\fB)\fR; +\fIdata\fR\fB\&.add_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR +\fIdata\fR\fB\&.add_idarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIid\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId new_handle()\fR +my \fI$handle\fR \fB=\fR \fI$data\fR\fB\->new_handle()\fR; +\fIhandle\fR \fB=\fR \fIdata\fR\fB\&.new_handle()\fR +\fIhandle\fR \fB=\fR \fIdata\fR\fB\&.new_handle()\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid add_flexarray(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Id\fR \fIhandle\fR\fB)\fR +\fI$data\fR\fB\->add_flexarray(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB,\fR \fI$handle\fR\fB)\fR; +\fIdata\fR\fB\&.add_flexarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIhandle\fR\fB)\fR +\fIdata\fR\fB\&.add_flexarray(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB,\fR \fIhandle\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid unset(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +\fI$data\fR\fB\->unset(\fR\fI$solvid\fR\fB,\fR \fI$keyname\fR\fB)\fR; +\fIdata\fR\fB\&.unset(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +\fIdata\fR\fB\&.unset(\fR\fIsolvid\fR\fB,\fR \fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Data storage methods\&. Probably only useful to store data in the special SOLVID_META solvid that stores repodata meta information\&. Note that repodata areas can have their own Id pool (see the REPO_LOCALPOOL flag), so be careful if you need to store ids\&. Arrays are created by calling the add function for every element\&. A flexarray is an array of sub\-structures, call new_handle to create a new structure, use the handle as solvid to fill the structure with data and call add_flexarray to put the structure in an array\&. +.SH "THE DATAPOS CLASS" +.sp +Datapos objects describe a specific position in the repository data area\&. Thus they are only valid until the repository is modified in some way\&. Datapos objects can be created by the pos() and parentpos() methods of a Datamatch object or by accessing the \(lqmeta\(rq attribute of a repository\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRepo *repo;\fR /* read only */ +\fI$data\fR\fB\->{repo}\fR +\fIdata\fR\fB\&.repo\fR +\fIdata\fR\fB\&.repo\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to repository object\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator(Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB)\fR +my \fI$di\fR \fB=\fR \fI$datapos\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Create a Dataiterator at the position of the datapos object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_deltalocation(unsigned int *\fR\fIOUTPUT\fR\fB)\fR +my \fB(\fR\fI$location\fR\fB,\fR \fI$mediano\fR\fB) =\fR \fI$datapos\fR\fB\->lookup_deltalocation()\fR; +\fIlocation\fR\fB,\fR \fImediano\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltalocation()\fR +\fIlocation\fR\fB,\fR \fImediano\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltalocation()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a tuple containing the on\-media location and an optional media number for a delta rpm\&. This obviously only works if the data position points to structure describing a delta rpm\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_deltaseq()\fR +my \fI$seq\fR \fB=\fR \fI$datapos\fR\fB\->lookup_deltaseq()\fR; +\fIseq\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltaseq()\fR; +\fIseq\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_deltaseq()\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the delta rpm sequence from the structure describing a delta rpm\&. +.SS "DATA RETRIEVAL METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *lookup_str(Id\fR \fIkeyname\fR\fB)\fR +my \fI$string\fR \fB=\fR \fI$datapos\fR\fB\->lookup_str(\fR\fI$keyname\fR\fB)\fR; +\fIstring\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR +\fIstring\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_str(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId lookup_id(Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR +my \fI$id\fR \fB=\fR \fI$datapos\fR\fB\->lookup_id(\fR\fI$keyname\fR\fB)\fR; +\fIid\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR +\fIid\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_id(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long lookup_num(Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR \fB= 0)\fR +my \fI$num\fR \fB=\fR \fI$datapos\fR\fB\->lookup_num(\fR\fI$keyname\fR\fB)\fR; +\fInum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR +\fInum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_num(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBbool lookup_void(Id\fR \fIkeyname\fR\fB)\fR +my \fI$bool\fR \fB=\fR \fI$datapos\fR\fB\->lookup_void(\fR\fI$keyname\fR\fB)\fR; +\fIbool\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR +\fIbool\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_void(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *lookup_idarray(Id\fR \fIkeyname\fR\fB)\fR +my \fI@ids\fR \fB=\fR \fI$datapos\fR\fB\->lookup_idarray(\fR\fI$keyname\fR\fB)\fR; +\fIids\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR +\fIids\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_idarray(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBChksum lookup_checksum(Id\fR \fIkeyname\fR\fB)\fR +my \fI$chksum\fR \fB=\fR \fI$datapos\fR\fB\->lookup_checksum(\fR\fI$keyname\fR\fB)\fR; +\fIchksum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR +\fIchksum\fR \fB=\fR \fIdatapos\fR\fB\&.lookup_checksum(\fR\fIkeyname\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +Lookup functions\&. Note that the returned Ids are always translated into the Ids of the global pool even if the repodata area contains its own pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDataiterator Dataiterator(Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR \fB= 0, int\fR \fIflags\fR \fB= 0)\fR +my \fI$di\fR \fB=\fR \fI$datapos\fR\fB\->Dataiterator(\fR\fI$keyname\fR\fB,\fR \fI$match\fR\fB,\fR \fI$flags\fR\fB)\fR; +\fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +\fIdi\fR \fB=\fR \fIdatapos\fR\fB\&.Dataiterator(\fR\fIkeyname\fR\fB,\fR \fImatch\fR\fB,\fR \fIflags\fR\fB)\fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBfor my\fR \fI$d\fR \fB(\fR\fI@$di\fR\fB)\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR\fB:\fR +\fBfor\fR \fId\fR \fBin\fR \fIdi\fR +.fi +.if n \{\ +.RE +.\} +.sp +Iterate over the matching data elements\&. See the Dataiterator class for more information\&. +.SH "THE ALTERNATIVE CLASS" +.sp +An Alternative object describes a branch point in the solving process\&. The solver found more than one good way to fulfill a dependency and chose one\&. It recorded the other possibilities in the alternative object so that they can be presented to the user in the case a different solution is preferable\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$alternative\fR\fB\->{solv}\fR +\fIalternative\fR\fB\&.solv\fR +\fIalternative\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId type;\fR /* read only */ +\fI$alternative\fR\fB\->{type}\fR +\fIalternative\fR\fB\&.type\fR +\fIalternative\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +The type of the alternative\&. Alternatives can be created because of rule fulfillment, because of recommended packages, and because of suggested packages (currently unused)\&. See below for a list of valid types\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule rule;\fR /* read only */ +\fI$alternative\fR\fB\->{rule}\fR +\fIalternative\fR\fB\&.rule\fR +\fIalternative\fR\fB\&.rule\fR +.fi +.if n \{\ +.RE +.\} +.sp +The rule that caused the creation of the alternative (SOLVER_ALTERNATIVE_TYPE_RULE)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{dep}\fR +\fIruleinfo\fR\fB\&.dep\fR +\fIruleinfo\fR\fB\&.dep\fR +.fi +.if n \{\ +.RE +.\} +.sp +The dependency that caused the creation of the alternative (SOLVER_ALTERNATIVE_TYPE_RECOMMENDS)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *depsolvable;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{depsolvable}\fR +\fIruleinfo\fR\fB\&.depsolvable\fR +\fIruleinfo\fR\fB\&.depsolvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The package containing the dependency (SOLVER_ALTERNATIVE_TYPE_RECOMMENDS)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable chosen;\fR /* read only */ +\fI$alternative\fR\fB\->{chosen}\fR +\fIalternative\fR\fB\&.chosen\fR +\fIalternative\fR\fB\&.chosen\fR +.fi +.if n \{\ +.RE +.\} +.sp +The solvable that the solver chose from the alternative\(cqs package set\&. +.SS "CONSTANTS" +.PP +\fBSOLVER_ALTERNATIVE_TYPE_RULE\fR +.RS 4 +The alternative was created when fulfilling a rule\&. +.RE +.PP +\fBSOLVER_ALTERNATIVE_TYPE_RECOMMENDS\fR +.RS 4 +The alternative was created when fulfilling a recommends dependency\&. +.RE +.PP +\fBSOLVER_ALTERNATIVE_TYPE_SUGGESTS\fR +.RS 4 +The alternative was created when fulfilling a suggests dependency\&. +.RE +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *choices()\fR +my \fI@choices\fR \fB=\fR \fI$alternative\fR\fB\->choices()\fR; +\fIchoices\fR \fB=\fR \fIalternative\fR\fB\&.choices\fR +\fIchoices\fR \fB=\fR \fIalternative\fR\fB\&.choices\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return the set of solvables that the solver could choose from when creating the alternative\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$alternative\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIalternative\fR\fB)\fR +\fIstr\fR \fB=\fR \fIalternative\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the alternative\&. +.SH "THE DECISION CLASS" +.sp +A decision is created when the solver fulfills dependencies\&. It can be either to install a package to satisfy a dependency or to conflict a dependency because it conflicts with another package or its dependencies cannot be met\&. Most decisions are caused by rule processing, but there are some other types like orphaned package handling or weak dependency handling\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$decision\fR\fB\->{solv}\fR +\fIdecision\fR\fB\&.solv\fR +\fIdecision\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId p;\fR /* read only */ +\fI$decision\fR\fB\->{p}\fR +\fIdecision\fR\fB\&.p\fR +\fIdecision\fR\fB\&.p\fR +.fi +.if n \{\ +.RE +.\} +.sp +The decision package id, positive for installs and negative for conflicts\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint reason;\fR /* read only */ +\fI$decision\fR\fB\->{reason}\fR +\fIdecision\fR\fB\&.reason\fR +\fIdecision\fR\fB\&.reason\fR +.fi +.if n \{\ +.RE +.\} +.sp +The reason for the decision\&. See the SOLVER_REASON_ constants\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint infoid;\fR /* read only */ +\fI$decision\fR\fB\->{infoid}\fR +\fIdecision\fR\fB\&.infoid\fR +\fIdecision\fR\fB\&.infoid\fR +.fi +.if n \{\ +.RE +.\} +.sp +Extra info for the decision\&. This is the rule id for decisions caused by rule fulfillment\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable solvable;\fR /* read only */ +\fI$decision\fR\fB\->{solvable}\fR +\fIdecision\fR\fB\&.solvable\fR +\fIdecision\fR\fB\&.solvable\fR +.fi +.if n \{\ +.RE +.\} +.sp +The decision package object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRule rule()\fR /* read only */ +\fI$decision\fR\fB\->{rule}\fR +\fIdecision\fR\fB\&.rule\fR +\fIdecision\fR\fB\&.rule\fR +.fi +.if n \{\ +.RE +.\} +.sp +The rule object for decisions that where caused by rule fulfilment\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRuleinfo info()\fR +my \fI$info\fR \fB=\fR \fI$decision\fR\fB\->info()\fR; +\fIinfo\fR \fB=\fR \fIdecision\fR\fB\&.info()\fR +\fIinfo\fR \fB=\fR \fIdecision\fR\fB\&.info()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a Ruleinfo object describing the decision\&. Some reasons like SOLVER_REASON_WEAKDEP are not caused by rules, but can be expressed by a Ruleinfo object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBRuleinfo *allinfos()\fR +my \fI@infos\fR \fB=\fR \fI$decision\fR\fB\->allinfos()\fR; +\fIinfos\fR \fB=\fR \fIdecision\fR\fB\&.allinfos()\fR +\fIinfos\fR \fB=\fR \fIdecision\fR\fB\&.allinfos()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Same as info(), but all Ruleinfo objects describing the decision are returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *reasonstr()\fR +my \fIstr\fR \fB=\fR \fI$decision\fR\fB\->reasonstr()\fR +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.reasonstr()\fR +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.reasonstr()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing why a decision was done (but without the decision itself)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$decison\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIdecision\fR\fB)\fR +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the decision (but without the reason)\&. +.SH "THE DECISIONSET CLASS" +.sp +A decisionset consists of multiple decisions of the same reason and type that can be presented to the user as a single action\&. +.SS "ATTRIBUTES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolver *solv;\fR /* read only */ +\fI$decision\fR\fB\->{solv}\fR +\fIdecision\fR\fB\&.solv\fR +\fIdecision\fR\fB\&.solv\fR +.fi +.if n \{\ +.RE +.\} +.sp +Back pointer to solver object\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId p;\fR /* read only */ +\fI$decision\fR\fB\->{p}\fR +\fIdecision\fR\fB\&.p\fR +\fIdecision\fR\fB\&.p\fR +.fi +.if n \{\ +.RE +.\} +.sp +The package id of the first decision, positive for installs and negative for conflicts\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint reason;\fR /* read only */ +\fI$decision\fR\fB\->{reason}\fR +\fIdecision\fR\fB\&.reason\fR +\fIdecision\fR\fB\&.reason\fR +.fi +.if n \{\ +.RE +.\} +.sp +The reason for the decisions in the set\&. See the SOLVER_REASON_ constants\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint type;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{type}\fR +\fIruleinfo\fR\fB\&.type\fR +\fIruleinfo\fR\fB\&.type\fR +.fi +.if n \{\ +.RE +.\} +.sp +The type of the decision info\&. See the constant section of the solver class for the rule type list and the special type list\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{dep}\fR +\fIruleinfo\fR\fB\&.dep\fR +\fIruleinfo\fR\fB\&.dep\fR +.fi +.if n \{\ +.RE +.\} +.sp +The dependency that caused the decision +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDep *dep_id;\fR /* read only */ +\fI$ruleinfo\fR\fB\->{\fR\fIdep_id\fR\fB}\fR +\fIruleinfo\fR\fB\&.dep_id\fR +\fIruleinfo\fR\fB\&.dep_id\fR +.fi +.if n \{\ +.RE +.\} +.sp +The Id of the dependency that caused the decision\&. +.SS "METHODS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBDecision *decisions()\fR +my \fI@decisions\fR \fB=\fR \fI$decisionset\fR\fB\->decisions()\fR; +\fIdecisions\fR \fB=\fR \fIdecisionset\fR\fB\&.decisions()\fR +\fIdecisions\fR \fB=\fR \fIdecisionset\fR\fB\&.decisions()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all the decisions of the set\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *solvables()\fR +my \fI@pkgs\fR \fB=\fR \fI$decisionset\fR\fB\->solvables()\fR; +\fIpkgs\fR \fB=\fR \fIdecisionset\fR\fB\&.solvables()\fR +\fIpkgs\fR \fB=\fR \fIdecisionset\fR\fB\&.solvables()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return all the packages that were decided in the set\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *reasonstr()\fR +my \fIstr\fR \fB=\fR \fI$decision\fR\fB\->reasonstr()\fR; +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.reasonstr()\fR +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.reasonstr()\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing why the decisions were done (but without the decisions themself)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB\fR +my \fI$str\fR \fB=\fR \fI$decison\fR\fB\->str\fR; +\fIstr\fR \fB= str(\fR\fIdecision\fR\fB)\fR +\fIstr\fR \fB=\fR \fIdecision\fR\fB\&.to_s\fR +.fi +.if n \{\ +.RE +.\} +.sp +Return a string describing the decisions (but without the reason)\&. +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/miniconda3/share/man/man3/libsolv-constantids.3 b/miniconda3/share/man/man3/libsolv-constantids.3 new file mode 100644 index 0000000000000000000000000000000000000000..8dd0ed658936ae25b310778947d95f011eee9fa2 --- /dev/null +++ b/miniconda3/share/man/man3/libsolv-constantids.3 @@ -0,0 +1,906 @@ +'\" t +.\" Title: Libsolv-Constantids +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/02/2022 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "LIBSOLV\-CONSTANTIDS" "3" "03/02/2022" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +libsolv-constantids \- fixed Ids for often used strings +.SH "DESCRIPTION" +.sp +Constant Ids are Ids of strings that are often needed\&. They are defined to ease programming and reduce the number of pool_str2id calls\&. The constant Ids are part of the binary ABI of libsolv, a minor version update will only add new constants and not change existing Ids to maintain compatibility\&. The on\-disk solv format does not use the fixed Ids, but instead references the strings, so solv files can still be read when the ABI is broken\&. +.SH "SPECIAL STRINGS" +.PP +\fBID_EMPTY ""\fR +.RS 4 +The empty string\&. It will always have Id 1\&. +.RE +.PP +\fBSYSTEM_SYSTEM "system:system"\fR +.RS 4 +The name of the always installed "system" solvable\&. +.RE +.SH "SOLVABLE ATTRIBUTES" +.sp +These are Ids for keynames of attributes\&. They can be used in the lookup and storage functions to select the correct attribute in the solvable\&. The descriptions below describe the intended semantics of the values stored in the attribute with the keyname\&. +.PP +\fBSOLVABLE_NAME "solvable:name"\fR +.RS 4 +The name of the package\&. +.RE +.PP +\fBSOLVABLE_ARCH "solvable:arch"\fR +.RS 4 +The architecture of the package\&. See the Solvable Architecture section for predefined architecture Id values\&. +.RE +.PP +\fBSOLVABLE_EVR "solvable:evr"\fR +.RS 4 +The version of the package\&. It usually consists of some combination of the Epoch, the Version, and the Release of the solvable\&. +.RE +.PP +\fBSOLVABLE_VENDOR "solvable:vendor"\fR +.RS 4 +A vendor string\&. Usually the company or group that created the binary package\&. +.RE +.PP +\fBSOLVABLE_PROVIDES "solvable:provides"\fR +.RS 4 +Stores an array of dependency Ids that describe the capabilities that the package provides\&. +.RE +.PP +\fBSOLVABLE_OBSOLETES "solvable:obsoletes"\fR +.RS 4 +Stores an array of dependency Ids that describe the packages that this package replaces\&. +.RE +.PP +\fBSOLVABLE_CONFLICTS "solvable:conflicts"\fR +.RS 4 +Stores an array of dependency Ids that describe the capabilities that this package conflicts with, i\&.e\&. that can\(cqt be installed together with this package\&. +.RE +.PP +\fBSOLVABLE_REQUIRES "solvable:requires"\fR +.RS 4 +Stores an array of dependency Ids that describe the capabilities that also must be installed when this package is installed\&. +.RE +.PP +\fBSOLVABLE_RECOMMENDS "solvable:recommends"\fR +.RS 4 +Stores an array of dependency Ids that describe the capabilities that also should be installed when this package is installed\&. It\(cqs not an error if not all capabilities can be met\&. +.RE +.PP +\fBSOLVABLE_SUGGESTS "solvable:suggests"\fR +.RS 4 +Stores an array of dependency Ids that describe the capabilities that also useful to have installed when this package is installed\&. This is intended to provide a hint to the user about other packages\&. +.RE +.PP +\fBSOLVABLE_SUPPLEMENTS "solvable:supplements"\fR +.RS 4 +Stores an array of dependency Ids that define that this package should be installed if one of the capabilities is met\&. This is like the recommends attribute, but works in the reverse way\&. +.RE +.PP +\fBSOLVABLE_ENHANCES "solvable:enhances"\fR +.RS 4 +Stores an array of dependency Ids that define that this package is useful to have installed if one of the capabilities is met\&. This is like the suggests attribute, but works in the reverse way\&. +.RE +.PP +\fBSOLVABLE_SUMMARY "solvable:summary"\fR +.RS 4 +The summary should be a short string without any newlines that describes what a package does\&. +.RE +.PP +\fBSOLVABLE_DESCRIPTION "solvable:description"\fR +.RS 4 +The description should be a more verbose description about what a package does\&. It may consist of multiple lines\&. +.RE +.PP +\fBSOLVABLE_DISTRIBUTION "solvable:distribution"\fR +.RS 4 +The distribution is a short string that describes the OS and OS version this package is built for\&. +.RE +.PP +\fBSOLVABLE_AUTHORS "solvable:authors"\fR +.RS 4 +A list of authors of this package\&. This attribute was used in SUSE packages\&. +.RE +.PP +\fBSOLVABLE_PACKAGER "solvable:packager"\fR +.RS 4 +The person who created the binary package, see also the vendor attribute\&. +.RE +.PP +\fBSOLVABLE_GROUP "solvable:group"\fR +.RS 4 +The package group that this package belongs to\&. See also the keywords attribute\&. +.RE +.PP +\fBSOLVABLE_URL "solvable:url"\fR +.RS 4 +An URL that points to more information about the package\&. +.RE +.PP +\fBSOLVABLE_KEYWORDS "solvable:keywords"\fR +.RS 4 +list of keyword string IDs used for tagging this package\&. +.RE +.PP +\fBSOLVABLE_LICENSE "solvable:license"\fR +.RS 4 +The license(s) of this package\&. +.RE +.PP +\fBSOLVABLE_BUILDTIME "solvable:buildtime"\fR +.RS 4 +The seconds since the unix epoch when the binary package was created\&. +.RE +.PP +\fBSOLVABLE_BUILDHOST "solvable:buildhost"\fR +.RS 4 +The name of the host on which the binary package was created\&. +.RE +.PP +\fBSOLVABLE_EULA "solvable:eula"\fR +.RS 4 +If this attribute is present the user should be asked to accept the end user license agreement before the package gets installed\&. +.RE +.PP +\fBSOLVABLE_CPEID "solvable:cpeid"\fR +.RS 4 +A Common Platform Enumeration string describes the platform this package is intended for\&. See also the distribution attribute\&. +.RE +.PP +\fBSOLVABLE_MESSAGEINS "solvable:messageins"\fR +.RS 4 +A message that should be displayed to the user when the package gets installed\&. +.RE +.PP +\fBSOLVABLE_MESSAGEDEL "solvable:messagedel"\fR +.RS 4 +A message that should be displayed to the user when the package gets erased\&. +.RE +.PP +\fBSOLVABLE_INSTALLSIZE "solvable:installsize"\fR +.RS 4 +The disk space in bytes needed when installing the package\&. +.RE +.PP +\fBSOLVABLE_DISKUSAGE "solvable:diskusage"\fR +.RS 4 +A SUSE extension that stores for each directory the needed amount of disk space in kilobytes and inodes\&. +.RE +.PP +\fBSOLVABLE_FILELIST "solvable:filelist"\fR +.RS 4 +A list of files that the package contains\&. +.RE +.PP +\fBSOLVABLE_INSTALLTIME "solvable:installtime"\fR +.RS 4 +The seconds since the unix epoch when the binary package was installed on the system\&. +.RE +.PP +\fBSOLVABLE_MEDIADIR "solvable:mediadir"\fR +.RS 4 +The directory on the repository that contains the package\&. If this attribute is set to void, the package architecture is used as directory\&. +.RE +.PP +\fBSOLVABLE_MEDIAFILE "solvable:mediafile"\fR +.RS 4 +The filename on the repository that contains the package\&. If this attribute is set to void, the canonical file name of the package is used (i\&.e\&. a combination of the name, version, architecture)\&. +.RE +.PP +\fBSOLVABLE_MEDIANR "solvable:medianr"\fR +.RS 4 +The media number\&. This is an integer describing on which of a multi\-part media set this package is on\&. +.RE +.PP +\fBSOLVABLE_MEDIABASE "solvable:mediabase"\fR +.RS 4 +This attribute can be used to overwrite the repositories base url\&. +.RE +.PP +\fBSOLVABLE_DOWNLOADSIZE "solvable:downloadsize"\fR +.RS 4 +The size of the binary package in bytes\&. +.RE +.PP +\fBSOLVABLE_SOURCEARCH "solvable:sourcearch"\fR +.RS 4 +The architecture of the source package that this package belongs to\&. +.RE +.PP +\fBSOLVABLE_SOURCENAME "solvable:sourcename"\fR +.RS 4 +The name of the source package that this package belongs to\&. If set to void, the package name attribute is used instead\&. +.RE +.PP +\fBSOLVABLE_SOURCEEVR "solvable:sourceevr"\fR +.RS 4 +The version of the source package that this package belongs to\&. If set to void, the package version attribute is used instead\&. +.RE +.PP +\fBSOLVABLE_TRIGGERS "solvable:triggers"\fR +.RS 4 +A list of package triggers for this package\&. Used in the transaction ordering code\&. +.RE +.PP +\fBSOLVABLE_CHECKSUM "solvable:checksum"\fR +.RS 4 +The checksum of the binary package\&. See the Data Types section for a list of supported algorithms\&. +.RE +.PP +\fBSOLVABLE_PKGID "solvable:pkgid"\fR +.RS 4 +A string identifying a package\&. For rpm packages, this is the md5sum over the package header and the payload\&. +.RE +.PP +\fBSOLVABLE_HDRID "solvable:hdrid"\fR +.RS 4 +A string identifying a package\&. For rpm packages, this is the sha1sum over just the package header\&. +.RE +.PP +\fBSOLVABLE_LEADSIGID "solvable:leadsigid"\fR +.RS 4 +A string identifying the signature part of a package\&. For rpm packages, this is the md5sum from the start of the file up to the package header (i\&.e\&. it includes the lead, the signature header, and the padding)\&. +.RE +.PP +\fBSOLVABLE_HEADEREND "solvable:headerend"\fR +.RS 4 +The offset of the payload in rpm binary packages\&. You can use this information to download just the header if you want to display information not included in the repository metadata\&. +.RE +.PP +\fBSOLVABLE_CHANGELOG "solvable:changelog"\fR +.RS 4 +The array containing all the changelog structures\&. +.RE +.PP +\fBSOLVABLE_CHANGELOG_AUTHOR "solvable:changelog:author"\fR +.RS 4 +The author of a changelog entry\&. +.RE +.PP +\fBSOLVABLE_CHANGELOG_TIME "solvable:changelog:time"\fR +.RS 4 +The seconds since the unix epoch when the changelog entry was written\&. +.RE +.PP +\fBSOLVABLE_CHANGELOG_TEXT "solvable:changelog:text"\fR +.RS 4 +The text of a changelog entry\&. +.RE +.SH "SPECIAL SOLVABLE ATTRIBUTES" +.PP +\fBRPM_RPMDBID "rpm:dbid"\fR +.RS 4 +The rpm database id of this (installed) package\&. Usually a small integer number\&. +.RE +.PP +\fBSOLVABLE_PATCHCATEGORY "solvable:patchcategory"\fR +.RS 4 +The category field for patch solvables\&. Should be named \(lqupdate:category\(rq instead\&. +.RE +.PP +\fBUPDATE_REBOOT "update:reboot"\fR +.RS 4 +If this attribute is present the system should be rebooted after the update is installed\&. +.RE +.PP +\fBUPDATE_RESTART "update:restart"\fR +.RS 4 +If this attribute is present the software manager should be run again after the update is installed\&. +.RE +.PP +\fBUPDATE_RELOGIN "update:relogin"\fR +.RS 4 +If this attribute is present the user should log off and on again after the update is installed\&. +.RE +.PP +\fBUPDATE_MESSAGE "update:message"\fR +.RS 4 +A message that should be shown to the user to warn him about anything non\-standard\&. +.RE +.PP +\fBUPDATE_SEVERITY "update:severity"\fR +.RS 4 +The severity of the update\&. +.RE +.PP +\fBUPDATE_RIGHTS "update:rights"\fR +.RS 4 +Any legal or other rights of the update\&. +.RE +.PP +\fBUPDATE_COLLECTION "update:collection"\fR +.RS 4 +The array containing the package list of the update\&. +.RE +.PP +\fBUPDATE_COLLECTION_NAME "update:collection:name"\fR +.RS 4 +The name of the updated package\&. +.RE +.PP +\fBUPDATE_COLLECTION_EVR "update:collection:evr"\fR +.RS 4 +The version of the updated package\&. +.RE +.PP +\fBUPDATE_COLLECTION_ARCH "update:collection:arch"\fR +.RS 4 +The architecture of the updated package\&. +.RE +.PP +\fBUPDATE_COLLECTION_FILENAME "update:collection:filename"\fR +.RS 4 +The file name of the updated package\&. +.RE +.PP +\fBUPDATE_REFERENCE "update:reference"\fR +.RS 4 +The array containing the reference list of the update\&. +.RE +.PP +\fBUPDATE_REFERENCE_TYPE "update:reference:type"\fR +.RS 4 +The type of the reference, e\&.g\&. bugzilla\&. +.RE +.PP +\fBUPDATE_REFERENCE_HREF "update:reference:href"\fR +.RS 4 +The URL of the reference\&. +.RE +.PP +\fBUPDATE_REFERENCE_ID "update:reference:id"\fR +.RS 4 +The identification string of the reference, e\&.g\&. the bug number\&. +.RE +.PP +\fBUPDATE_REFERENCE_TITLE "update:reference:title"\fR +.RS 4 +The title of the reference, e\&.g\&. the bug summary\&. +.RE +.PP +\fBPRODUCT_REFERENCEFILE "product:referencefile"\fR +.RS 4 +The basename of the product file in the package\&. +.RE +.PP +\fBPRODUCT_SHORTLABEL "product:shortlabel"\fR +.RS 4 +An identification string of the product\&. +.RE +.PP +\fBPRODUCT_DISTPRODUCT "product:distproduct"\fR +.RS 4 +Obsolete, do not use\&. Was a SUSE Code\-10 product name\&. +.RE +.PP +\fBPRODUCT_DISTVERSION "product:distversion"\fR +.RS 4 +Obsolete, do not use\&. Was a SUSE Code\-10 product version\&. +.RE +.PP +\fBPRODUCT_TYPE "product:type"\fR +.RS 4 +The type of the product, e\&.g\&. \(lqbase\(rq\&. +.RE +.PP +\fBPRODUCT_URL "product:url"\fR +.RS 4 +An array of product URLs\&. +.RE +.PP +\fBPRODUCT_URL_TYPE "product:url:type"\fR +.RS 4 +An array of product URL types\&. +.RE +.PP +\fBPRODUCT_FLAGS "product:flags"\fR +.RS 4 +An array of product flags\&. +.RE +.PP +\fBPRODUCT_PRODUCTLINE "product:productline"\fR +.RS 4 +A product line string used for product registering\&. +.RE +.PP +\fBPRODUCT_REGISTER_TARGET "product:regtarget"\fR +.RS 4 +A target for product registering\&. +.RE +.PP +\fBPRODUCT_REGISTER_RELEASE "product:regrelease"\fR +.RS 4 +A release string for product registering\&. +.RE +.PP +\fBPUBKEY_KEYID "pubkey:keyid"\fR +.RS 4 +The keyid of a pubkey, consisting of 8 bytes in hex\&. +.RE +.PP +\fBPUBKEY_FINGERPRINT "pubkey:fingerprint"\fR +.RS 4 +The fingerprint of a pubkey, usually a sha1sum in hex\&. Old V3 RSA keys use a md5sum instead\&. +.RE +.PP +\fBPUBKEY_EXPIRES "pubkey:expires"\fR +.RS 4 +The seconds since the unix epoch when the pubkey expires\&. +.RE +.PP +\fBPUBKEY_SUBKEYOF "pubkey:subkeyof"\fR +.RS 4 +The keyid of the master pubkey for subkeys\&. +.RE +.PP +\fBPUBKEY_DATA "pubkey:data"\fR +.RS 4 +The MPI data of the pubkey\&. +.RE +.PP +\fBSOLVABLE_ISVISIBLE "solvable:isvisible"\fR +.RS 4 +An attribute describing if the package should be listed to the user or not\&. Used for SUSE patterns\&. +.RE +.PP +\fBSOLVABLE_CATEGORY "solvable:category"\fR +.RS 4 +The category of a pattern\&. +.RE +.PP +\fBSOLVABLE_INCLUDES "solvable:includes"\fR +.RS 4 +A list of other patterns that this pattern includes\&. +.RE +.PP +\fBSOLVABLE_EXTENDS "solvable:extends"\fR +.RS 4 +A list of other patterns that this pattern extends\&. +.RE +.PP +\fBSOLVABLE_ICON "solvable:icon"\fR +.RS 4 +The icon name of a pattern\&. +.RE +.PP +\fBSOLVABLE_ORDER "solvable:order"\fR +.RS 4 +An ordering clue of a pattern\&. +.RE +.PP +\fBSUSETAGS_SHARE_NAME "susetags:share:name"\fR +.RS 4 +Internal attribute to implement susetags shared records\&. Holds the name of the solvable used for sharing attributes\&. +.RE +.PP +\fBSUSETAGS_SHARE_EVR "susetags:share:evr"\fR +.RS 4 +Internal attribute to implement susetags shared records\&. Holds the version of the solvable used for sharing attributes\&. +.RE +.PP +\fBSUSETAGS_SHARE_ARCH "susetags:share:arch"\fR +.RS 4 +Internal attribute to implement susetags shared records\&. Holds the architecture of the solvable used for sharing attributes\&. +.RE +.SH "SOLVABLE ARCHITECTURES" +.sp +Predefined architecture values for commonly used architectures\&. +.PP +\fBARCH_SRC "src"\fR +.RS 4 +Used for binary packages that contain the package sources\&. +.RE +.PP +\fBARCH_NOSRC "nosrc"\fR +.RS 4 +Used for binary packages that contain some of the package sources, but not all files (because of restrictions)\&. +.RE +.PP +\fBARCH_NOARCH "noarch"\fR +.RS 4 +This package can be installed on any architecture\&. Used for rpm\&. +.RE +.PP +\fBARCH_ALL "all"\fR +.RS 4 +This package can be installed on any architecture\&. Used for Debian\&. +.RE +.PP +\fBARCH_ANY "any"\fR +.RS 4 +This package can be installed on any architecture\&. Used for Archlinux and Haiku\&. +.RE +.SH "DEPENDENCY IDS" +.sp +Namespaces are special modifiers that change the meaning of a dependency\&. Namespace dependencies are created with the REL_NAMESPACE flag\&. To make custom namespaces work you have to implement a namespace callback function\&. +.sp +The dependency markers partition the dependency array in two parts with different semantics\&. +.PP +\fBNAMESPACE_MODALIAS "namespace:modalias"\fR +.RS 4 +The dependency is a special modalias dependency that matches installed hardware\&. +.RE +.PP +\fBNAMESPACE_SPLITPROVIDES "namespace:splitprovides"\fR +.RS 4 +The dependency is a special splitprovides dependency used to implement updates that include a package split\&. A splitprovides dependency contains a filename and a package name, it is matched if a package with the provided package name is installed that contains the filename\&. This namespace is implemented in libsolv, so you do not need a callback\&. +.RE +.PP +\fBNAMESPACE_LANGUAGE "namespace:language"\fR +.RS 4 +The dependency describes a language\&. The callback should return true if the language was selected by the user\&. +.RE +.PP +\fBNAMESPACE_FILESYSTEM "namespace:filesystem"\fR +.RS 4 +The dependency describes a filesystem\&. The callback should return true if the filesystem is needed\&. +.RE +.PP +\fBNAMESPACE_OTHERPROVIDERS "namespace:otherproviders"\fR +.RS 4 +This is a hack to allow self\-conflicting packages\&. It is not needed with current rpm version, so do not use this namespace\&. +.RE +.PP +\fBSOLVABLE_PREREQMARKER "solvable:prereqmarker"\fR +.RS 4 +This marker partitions the normal require dependencies from the prerequires\&. It is not needed for dependency solving, but it is used by the transaction ordering algorithm when a dependency cycle needs to be broken (non\-prereq deps get broken first)\&. +.RE +.PP +\fBSOLVABLE_FILEMARKER "solvable:filemarker"\fR +.RS 4 +This marker partitions the package provides dependencies from the synthetic file provides dependencies added by pool_addfileprovides()\&. +.RE +.SH "DATA TYPES" +.sp +Each attribute data is stored with a type, so that the lookup functions know how to interpret the data\&. The following types are available: +.PP +\fBREPOKEY_TYPE_VOID "repokey:type:void"\fR +.RS 4 +No data is stored with this attribute\&. Thus you can only test if the attribute exists or not\&. Useful to store boolean values\&. +.RE +.PP +\fBREPOKEY_TYPE_CONSTANT "repokey:type:constant"\fR +.RS 4 +The data is a constant 32bit number\&. The number is stored in the key area, so using it does not cost extra storage space (but you need the extra key space)\&. +.RE +.PP +\fBREPOKEY_TYPE_CONSTANTID "repokey:type:constantid"\fR +.RS 4 +The data is a constant Id\&. The Id is stored in the key area, so using it does not cost extra storage space (but you need the extra key space)\&. +.RE +.PP +\fBREPOKEY_TYPE_ID "repokey:type:id"\fR +.RS 4 +The data is an Id\&. +.RE +.PP +\fBREPOKEY_TYPE_NUM "repokey:type:num"\fR +.RS 4 +The data is an unsigned 64bit number\&. +.RE +.PP +\fBREPOKEY_TYPE_U32 "repokey:type:num32"\fR +.RS 4 +The data is an unsigned 32bit number\&. Obsolete, do not use\&. +.RE +.PP +\fBREPOKEY_TYPE_DIR "repokey:type:dir"\fR +.RS 4 +The data is an Id of a directory\&. +.RE +.PP +\fBREPOKEY_TYPE_STR "repokey:type:str"\fR +.RS 4 +The data is a regular string\&. +.RE +.PP +\fBREPOKEY_TYPE_BINARY "repokey:type:binary"\fR +.RS 4 +The data is a binary blob\&. +.RE +.PP +\fBREPOKEY_TYPE_IDARRAY "repokey:type:idarray"\fR +.RS 4 +The data is an array of non\-zero Ids\&. +.RE +.PP +\fBREPOKEY_TYPE_REL_IDARRAY "repokey:type:relidarray"\fR +.RS 4 +The data is an array of non\-zero Ids ordered so that it needs less space\&. +.RE +.PP +\fBREPOKEY_TYPE_DIRSTRARRAY "repokey:type:dirstrarray"\fR +.RS 4 +The data is a tuple consisting of a directory Id and a basename\&. Used to store file names\&. +.RE +.PP +\fBREPOKEY_TYPE_DIRNUMNUMARRAY "repokey:type:dirnumnumarray"\fR +.RS 4 +The data is a triple consisting of a directory Id and two 32bit unsigned integers\&. Used to store disk usage information\&. +.RE +.PP +\fBREPOKEY_TYPE_MD5 "repokey:type:md5"\fR +.RS 4 +The data is a binary md5sum\&. +.RE +.PP +\fBREPOKEY_TYPE_SHA1 "repokey:type:sha1"\fR +.RS 4 +The data is a binary sha1sum\&. +.RE +.PP +\fBREPOKEY_TYPE_SHA256 "repokey:type:sha256"\fR +.RS 4 +The data is a binary sha256sum\&. +.RE +.PP +\fBREPOKEY_TYPE_FIXARRAY "repokey:type:fixarray"\fR +.RS 4 +The data is an array of structures that have all the same layout (i\&.e\&. the same keynames and keytypes in the same order)\&. +.RE +.PP +\fBREPOKEY_TYPE_FLEXARRAY "repokey:type:flexarray"\fR +.RS 4 +The data is an array of structures that have a different layout\&. +.RE +.PP +\fBREPOKEY_TYPE_DELETED "repokey:type:deleted"\fR +.RS 4 +The data does not exist\&. Used to mark an attribute that was deleted\&. +.RE +.SH "REPOSITORY METADATA" +.sp +This attributes contain meta information about the repository\&. +.PP +\fBREPOSITORY_SOLVABLES "repository:solvables"\fR +.RS 4 +This attribute holds the array including all of the solvables\&. It is only used in the on\-disk solv files, internally the solvables are stored in the pool\(cqs solvable array for fast access\&. +.RE +.PP +\fBREPOSITORY_DELTAINFO "repository:deltainfo"\fR +.RS 4 +This attribute holds the array including all of the delta packages\&. +.RE +.PP +\fBREPOSITORY_EXTERNAL "repository:external"\fR +.RS 4 +This attribute holds the array including all of the data to construct stub repodata areas to support on\-demand loading of metadata\&. +.RE +.PP +\fBREPOSITORY_KEYS "repository:keys"\fR +.RS 4 +This should really be named "repository:external:keys", it contains an array if Ids that consists of (keyname, keytype) pairs that describe the keys of the stub\&. +.RE +.PP +\fBREPOSITORY_LOCATION "repository:location"\fR +.RS 4 +This is used to provide a file name in the stub\&. +.RE +.PP +\fBREPOSITORY_ADDEDFILEPROVIDES "repository:addedfileprovides"\fR +.RS 4 +This attribute holds an array of filename Ids, that tell the library, that all of the Ids were already added to the solvable provides\&. +.RE +.PP +\fBREPOSITORY_RPMDBCOOKIE "repository:rpmdbcookie"\fR +.RS 4 +An attribute that stores a sha256sum over the file stats of the Packages database\&. It\(cqs used to detect rebuilds of the database, as in that case the database Ids of every package are newly distributed\&. +.RE +.PP +\fBREPOSITORY_TIMESTAMP "repository:timestamp"\fR +.RS 4 +The seconds since the unix epoch when the repository was created\&. +.RE +.PP +\fBREPOSITORY_EXPIRE "repository:expire"\fR +.RS 4 +The seconds after the timestamp when the repository will expire\&. +.RE +.PP +\fBREPOSITORY_UPDATES "repository:updates"\fR +.RS 4 +An array of structures describing what this repository updates\&. +.RE +.PP +\fBREPOSITORY_DISTROS "repository:distros"\fR +.RS 4 +Also an array of structures describing what this repository updates\&. Seems to be the newer name of REPOSITORY_UPDATES\&. +.RE +.PP +\fBREPOSITORY_PRODUCT_LABEL "repository:product:label"\fR +.RS 4 +Should really be called "repository:updates:label"\&. What distribution is updated with this repository\&. +.RE +.PP +\fBREPOSITORY_PRODUCT_CPEID "repository:product:cpeid"\fR +.RS 4 +The cpeid of the platform updated by this repository\&. Is both used in REPOSITORY_UPDATES and REPOSITORY_DISTROS to maximize confusion\&. +.RE +.PP +\fBREPOSITORY_REPOID "repository:repoid"\fR +.RS 4 +An array of Id strings describing keywords/tags about the repository itself\&. +.RE +.PP +\fBREPOSITORY_KEYWORDS "repository:keywords"\fR +.RS 4 +An array of Id strings describing keywords/tags about the content of the repository\&. +.RE +.PP +\fBREPOSITORY_REVISION "repository:revision"\fR +.RS 4 +An arbitrary string describing the revision of the repository\&. +.RE +.PP +\fBREPOSITORY_TOOLVERSION "repository:toolversion"\fR +.RS 4 +Some string describing somewhat the version of libsolv used to create the solv file\&. +.RE +.SH "REPOSITORY METADATA FOR SUSETAGS REPOS" +.sp +Attributes describing repository files in a susetags repository\&. \fBSUSETAGS_DATADIR "susetags:datadir"\fR:: The directory that contains the packages\&. +.PP +\fBSUSETAGS_DESCRDIR "susetags:descrdir"\fR +.RS 4 +The directory that contains the repository file resources\&. +.RE +.PP +\fBSUSETAGS_DEFAULTVENDOR "susetags:defaultvendor"\fR +.RS 4 +The default vendor used when a package does not specify a vendor\&. +.RE +.PP +\fBSUSETAGS_FILE "susetags:file"\fR +.RS 4 +An array of file resources of the repository\&. +.RE +.PP +\fBSUSETAGS_FILE_NAME "susetags:file:name"\fR +.RS 4 +The filename of the resource\&. +.RE +.PP +\fBSUSETAGS_FILE_TYPE "susetags:file:type"\fR +.RS 4 +The type of the resource, e\&.g\&. \(lqMETA\(rq\&. +.RE +.PP +\fBSUSETAGS_FILE_CHECKSUM "susetags:file:checksum"\fR +.RS 4 +The file checksum of the resource\&. +.RE +.SH "REPOSITORY METADATA FOR RPMMD REPOS" +.PP +\fBREPOSITORY_REPOMD "repository:repomd"\fR +.RS 4 +An array of file resources of the repository\&. +.RE +.PP +\fBREPOSITORY_REPOMD_TYPE "repository:repomd:type"\fR +.RS 4 +The type of the resource, e\&.g\&. \(lqprimary\(rq\&. +.RE +.PP +\fBREPOSITORY_REPOMD_LOCATION "repository:repomd:location"\fR +.RS 4 +The location (aka filename) of the resource +.RE +.PP +\fBREPOSITORY_REPOMD_TIMESTAMP "repository:repomd:timestamp"\fR +.RS 4 +The seconds since the unix epoch when the resource was created\&. +.RE +.PP +\fBREPOSITORY_REPOMD_CHECKSUM "repository:repomd:checksum"\fR +.RS 4 +The file checksum of the resource\&. +.RE +.PP +\fBREPOSITORY_REPOMD_OPENCHECKSUM "repository:repomd:openchecksum"\fR +.RS 4 +The checksum over the uncompressed contents of the resource\&. +.RE +.PP +\fBREPOSITORY_REPOMD_SIZE "repository:repomd:size"\fR +.RS 4 +The size of the resource file\&. +.RE +.SH "DELTA PACKAGE ATTRIBUTES" +.PP +\fBDELTA_PACKAGE_NAME "delta:pkgname"\fR +.RS 4 +The target package name for the delta package\&. Applying the delta will recreate the target package\&. +.RE +.PP +\fBDELTA_PACKAGE_EVR "delta:pkgevr"\fR +.RS 4 +The version of the target package\&. +.RE +.PP +\fBDELTA_PACKAGE_ARCH "delta:pkgarch"\fR +.RS 4 +The architecture of the target package\&. +.RE +.PP +\fBDELTA_LOCATION_DIR "delta:locdir"\fR +.RS 4 +The directory in the repository that contains the delta package\&. +.RE +.PP +\fBDELTA_LOCATION_NAME "delta:locname"\fR +.RS 4 +The first part of the file name of the delta package\&. +.RE +.PP +\fBDELTA_LOCATION_EVR "delta:locevr"\fR +.RS 4 +The version part of the file name of the delta package\&. +.RE +.PP +\fBDELTA_LOCATION_SUFFIX "delta:locsuffix"\fR +.RS 4 +The suffix part of the file name of the delta package\&. +.RE +.PP +\fBDELTA_LOCATION_BASE "delta:locbase"\fR +.RS 4 +This attribute can be used to overwrite the repositories base url for the delta\&. +.RE +.PP +\fBDELTA_DOWNLOADSIZE "delta:downloadsize"\fR +.RS 4 +The size of the delta rpm file\&. +.RE +.PP +\fBDELTA_CHECKSUM "delta:checksum"\fR +.RS 4 +The checksum of the delta rpm file\&. +.RE +.PP +\fBDELTA_BASE_EVR "delta:baseevr"\fR +.RS 4 +The version of the package the delta was built against\&. +.RE +.PP +\fBDELTA_SEQ_NAME "delta:seqname"\fR +.RS 4 +The first part of the delta sequence, the base package name\&. +.RE +.PP +\fBDELTA_SEQ_EVR "delta:seqevr"\fR +.RS 4 +The evr part of the delta sequence, the base package evr\&. Identical to the DELTA_BASE_EVR attribute\&. +.RE +.PP +\fBDELTA_SEQ_NUM "delta:seqnum"\fR +.RS 4 +The last part of the delta sequence, the content selection string\&. +.RE +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/miniconda3/share/man/man3/libsolv-history.3 b/miniconda3/share/man/man3/libsolv-history.3 new file mode 100644 index 0000000000000000000000000000000000000000..9ccec7ec63ff55c58da761092d27695534ede521 --- /dev/null +++ b/miniconda3/share/man/man3/libsolv-history.3 @@ -0,0 +1,119 @@ +'\" t +.\" Title: Libsolv-History +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/02/2022 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "LIBSOLV\-HISTORY" "3" "03/02/2022" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +libsolv-history \- how the libsolv library came into existence +.SH "HISTORY" +.sp +This project was started in May 2007 when the zypp folks decided to switch to a database to speed up installation\&. As I am not a big fan of databases, I (mls) wondered if there would be really some merit of using one for solving, as package dependencies of all packages have to be read in anyway\&. +.sp +Back in 2002, I researched that using a dictionary approach for storing dependencies can reduce the packages file to 1/3 of its size\&. Extending this idea a bit more, I decided to store all strings and relations as unique 32\-bit numbers\&. This has three big advantages: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +because of the unification, testing whether two strings are equal is the same as testing the equality of two numbers, thus very fast +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +much space is saved, as numbers do not take up as much space as strings the internal memory representation does not take more space on a 64\-bit system where a pointer is twice the size of a 32\-bit number +.RE +.sp +Thus, the solv format was created, which stores a repository as a string dictionary, a relation dictionary and then all packages dependencies\&. Tests showed that reading and merging multiple solv repositories takes just some milliseconds\&. +.SS "Early solver experiments" +.sp +Having a new repository format was one big step, but the other area where libzypp needed improvement was the solver\&. Libzypp\(cqs solver was a port from the Red Carpet solver, which was written to update packages in an already installed system\&. Using it for the complete installation progress brought it to its limits\&. Also, the added extensions like support for weak dependencies and patches made it fragile and unpredictable\&. +.sp +As I was not very pleased with the way the solver worked, I looked at other solver algorithms\&. I checked smart, yum and apt, but could not find a convincing algorithm\&. My own experiments also were not very convincing, they worked fine for some problems but failed miserably for other corner cases\&. +.SS "Using SAT for solving" +.sp +SUSE\(cqs hack week at the end of June 2007 turned out to be a turning point for the solver\&. Googling for solver algorithms, I stumbled over some note saying that some people are trying to use SAT algorithms to improve solving on Debian\&. Looking at the SAT entry in Wikipedia, it was easy to see that this indeed was the missing piece: SAT algorithms are well researched and there are quite some open source implementations\&. I decided to look at the minisat code, as it is one of the fastest solvers while consisting of not too many lines of code\&. +.sp +Of course, directly using minisat would not work, as a package solver does not need to find just one correct solution, but it also has to optimize some metrics, i\&.e\&. keep as many packages installed as possible\&. Thus, I needed to write my own solver, incorporating the ideas and algorithms used in minisat\&. This wasn\(cqt very hard, and at the end of the hack week the solver calculated the first right solutions\&. +.SS "Selling it to libzypp" +.sp +With those encouraging results, I went to Klaus Kaempf, the system management architect at SUSE\&. We spoke about how to convince the team to make libzypp switch to the new solver\&. Fortunately, libzypp comes with a plethora of solver test cases, so we decided to make the solver pass most of the test cases first\&. Klaus wrote a "deptestomatic" implementation to check the test cases\&. Together with Stephan Kulow, who is responsible for the openSUSE distribution, we tweaked and extended the solver until most of the test cases looked good\&. +.sp +Duncan Mac\-Vicar Prett, the team lead of the YaST team, also joined development by creating Ruby bindings for the solver\&. Later, Klaus improved the bindings and ported them to some other languages\&. +.SS "The attribute store" +.sp +The progress with the repository format and the solver attracted another hacker to the project: Michael Matz from the compiler team\&. He started with improving the repository parsers so that patches and content files also generate solvables\&. After that, he concentrated on storing all of the other metadata of the repositories that are not used for solving, like the package summaries and descriptions\&. At the end of October, a first version of this "attribute store" was checked in\&. Its design goals were: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +space efficient storage of attributes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +paging/on demand loading of data +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +page compression +.RE +.sp +The first version of the attribute store used a different format for storing information, we later merged this format with the solv file format\&. +.SS "libzypp integration" +.sp +Integration of the sat\-solver into libzypp also started in October 2007 by Stefan Schubert and Michael Andres from the YaST team\&. The first versions supported both the old solver and the new one by using the old repository read functions and converting the old package data in\-memory into a sat solver pool\&. Solvers could be switched with the environment variable ZYPP_SAT_SOLVER\&. The final decision to move to the new solver was made in January of 2008, first just by making the new solver the default one, later by completely throwing out the old solver code\&. This had the advantage that the internal solvable storage could also be done by using the solver pool, something Michael Matz already played with in a proof of concept implementation showing some drastic speed gains\&. The last traces of the old database code were removed in February\&. +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/miniconda3/share/man/man3/libsolv-pool.3 b/miniconda3/share/man/man3/libsolv-pool.3 new file mode 100644 index 0000000000000000000000000000000000000000..52ae62686f213b2c7e3619c27faf183afa5792ca --- /dev/null +++ b/miniconda3/share/man/man3/libsolv-pool.3 @@ -0,0 +1,1337 @@ +'\" t +.\" Title: Libsolv-Pool +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/25/2024 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "LIBSOLV\-POOL" "3" "03/25/2024" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +libsolv-pool \- Libsolv\*(Aqs pool object +.SH "PUBLIC ATTRIBUTES" +.PP +\fBvoid *appdata\fR +.RS 4 +A no\-purpose pointer free to use for the library user\&. Freeing the pool simply discards the pointer\&. +.RE +.PP +\fBStringpool ss\fR +.RS 4 +The pool of unified strings\&. +.RE +.PP +\fBReldep *rels\fR +.RS 4 +The pool of unified relation dependencies\&. +.RE +.PP +\fBint nrels\fR +.RS 4 +Number of allocated relation dependencies\&. +.RE +.PP +\fBRepo **repos\fR +.RS 4 +The array of repository pointers, indexed by repository Id\&. +.RE +.PP +\fBint nrepos\fR +.RS 4 +Number of allocated repository array elements, i\&.e\&. the size of the repos array\&. +.RE +.PP +\fBint urepos\fR +.RS 4 +Number of used (i\&.e\&. non\-zero) repository array elements\&. +.RE +.PP +\fBRepo *installed\fR +.RS 4 +Pointer to the repo holding the installed packages\&. You are free to read this attribute, but you should use pool_set_installed() if you want to change it\&. +.RE +.PP +\fBSolvable *solvables\fR +.RS 4 +The array of Solvable objects\&. +.RE +.PP +\fBint nsolvables\fR +.RS 4 +Number of Solvable objects, i\&.e\&. the size of the solvables array\&. Note that the array may contain freed solvables, in that case the repo pointer of the solvable will be zero\&. +.RE +.PP +\fBint disttype\fR +.RS 4 +The distribution type of your system, e\&.g\&. DISTTYPE_DEB\&. You are free to read this attribute, but you should use pool_setdisttype() if you want to change it\&. +.RE +.PP +\fBId *whatprovidesdata\fR +.RS 4 +Multi\-purpose Id storage holding zero terminated arrays of Ids\&. pool_whatprovides() returns an offset into this data\&. +.RE +.PP +\fBMap *considered\fR +.RS 4 +Optional bitmap that can make the library ignore solvables\&. If a bitmap is set, only solvables that have a set bit in the bitmap at their Id are considered usable\&. +.RE +.PP +\fBint debugmask\fR +.RS 4 +A mask that defines which debug events should be reported\&. pool_setdebuglevel() sets this mask\&. +.RE +.PP +\fBDatapos pos\fR +.RS 4 +An object storing some position in the repository data\&. Functions like dataiterator_set_pos() set this object, accessing data with a pseudo solvable Id of SOLVID_POS uses it\&. +.RE +.PP +\fBQueue pooljobs\fR +.RS 4 +A queue where fixed solver jobs can be stored\&. This jobs are automatically added when solver_solve() is called, they are useful to store configuration data like which packages should be multiversion installed\&. +.RE +.SH "CREATION AND DESTRUCTION" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBPool *pool_create()\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Create a new instance of a pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_free(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Free a pool and all of the data it contains, e\&.g\&. the solvables, repositories, strings\&. +.SH "DEBUGGING AND ERROR REPORTING" +.SS "Constants" +.PP +\fBSOLV_FATAL\fR +.RS 4 +Report the error and call \(lqexit(1)\(rq afterwards\&. You cannot mask this level\&. Reports to stderr instead of stdout\&. +.RE +.PP +\fBSOLV_ERROR\fR +.RS 4 +Used to report errors\&. Reports to stderr instead of stdout\&. +.RE +.PP +\fBSOLV_WARN\fR +.RS 4 +Used to report warnings\&. +.RE +.PP +\fBSOLV_DEBUG_STATS\fR +.RS 4 +Used to report statistical data\&. +.RE +.PP +\fBSOLV_DEBUG_RULE_CREATION\fR +.RS 4 +Used to report information about the solver\(cqs creation of rules\&. +.RE +.PP +\fBSOLV_DEBUG_PROPAGATE\fR +.RS 4 +Used to report information about the solver\(cqs unit rule propagation process\&. +.RE +.PP +\fBSOLV_DEBUG_ANALYZE\fR +.RS 4 +Used to report information about the solver\(cqs learnt rule generation mechanism\&. +.RE +.PP +\fBSOLV_DEBUG_UNSOLVABLE\fR +.RS 4 +Used to report information about the solver dealing with conflicting rules\&. +.RE +.PP +\fBSOLV_DEBUG_SOLUTIONS\fR +.RS 4 +Used to report information about the solver creating solutions to solve problems\&. +.RE +.PP +\fBSOLV_DEBUG_POLICY\fR +.RS 4 +Used to report information about the solver searching for an optimal solution\&. +.RE +.PP +\fBSOLV_DEBUG_RESULT\fR +.RS 4 +Used by the debug functions to output results\&. +.RE +.PP +\fBSOLV_DEBUG_JOB\fR +.RS 4 +Used to report information about the job rule generation process\&. +.RE +.PP +\fBSOLV_DEBUG_SOLVER\fR +.RS 4 +Used to report information about what the solver is currently doing\&. +.RE +.PP +\fBSOLV_DEBUG_TRANSACTION\fR +.RS 4 +Used to report information about the transaction generation and ordering process\&. +.RE +.PP +\fBSOLV_DEBUG_TO_STDERR\fR +.RS 4 +Write debug messages to stderr instead of stdout\&. +.RE +.SS "Functions" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_debug(Pool *\fR\fIpool\fR\fB, int\fR \fItype\fR\fB, const char *\fR\fIformat\fR\fB, \&.\&.\&.)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Report a message of the type \fItype\fR\&. You can filter debug messages by setting a debug mask\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setdebuglevel(Pool *\fR\fIpool\fR\fB, int\fR \fIlevel\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set a predefined debug mask\&. A higher level generally means more bits in the mask are set, thus more messages are printed\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setdebugmask(Pool *\fR\fIpool\fR\fB, int\fR \fImask\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the debug mask to filter debug messages\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_error(Pool *\fR\fIpool\fR\fB, int\fR \fIret\fR\fB, const char *\fR\fIformat\fR\fB, \&.\&.\&.)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the pool\(cqs error string\&. The \fIret\fR value is simply used as a return value of the function so that you can write code like return pool_error(\&...);\&. If the debug mask contains the \fBSOLV_ERROR\fR bit, pool_debug() is also called with the message and type \fBSOLV_ERROR\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBextern char *pool_errstr(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the current error string stored in the pool\&. Like with the libc\(cqs errno value, the string is only meaningful after a function returned an error\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setdebugcallback(Pool *\fR\fIpool\fR\fB, void (*\fR\fIdebugcallback\fR\fB)(Pool *, void *\fR\fIdata\fR\fB, int\fR \fItype\fR\fB, const char *\fR\fIstr\fR\fB), void *\fR\fIdebugcallbackdata\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set a custom debug callback function\&. Instead of writing to stdout or stderr, the callback function will be called\&. +.SH "POOL CONFIGURATION" +.SS "Constants" +.PP +\fBDISTTYPE_RPM\fR +.RS 4 +Used for systems which use rpm as low level package manager\&. +.RE +.PP +\fBDISTTYPE_DEB\fR +.RS 4 +Used for systems which use dpkg as low level package manager\&. +.RE +.PP +\fBDISTTYPE_ARCH\fR +.RS 4 +Used for systems which use the arch linux package manager\&. +.RE +.PP +\fBDISTTYPE_HAIKU\fR +.RS 4 +Used for systems which use haiku packages\&. +.RE +.PP +\fBPOOL_FLAG_PROMOTEEPOCH\fR +.RS 4 +Promote the epoch of the providing dependency to the requesting dependency if it does not contain an epoch\&. Used at some time in old rpm versions, modern systems should never need this\&. +.RE +.PP +\fBPOOL_FLAG_FORBIDSELFCONFLICTS\fR +.RS 4 +Disallow the installation of packages that conflict with themselves\&. Debian always allows self\-conflicting packages, rpm used to forbid them but switched to also allowing them recently\&. +.RE +.PP +\fBPOOL_FLAG_OBSOLETEUSESPROVIDES\fR +.RS 4 +Make obsolete type dependency match against provides instead of just the name and version of packages\&. Very old versions of rpm used the name/version, then it got switched to provides and later switched back again to just name/version\&. +.RE +.PP +\fBPOOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES\fR +.RS 4 +An implicit obsoletes is the internal mechanism to remove the old package on an update\&. The default is to remove all packages with the same name, rpm\-5 switched to also removing packages providing the same name\&. +.RE +.PP +\fBPOOL_FLAG_OBSOLETEUSESCOLORS\fR +.RS 4 +Rpm\(cqs multilib implementation (used in RedHat and Fedora) distinguishes between 32bit and 64bit packages (the terminology is that they have a different color)\&. If obsoleteusescolors is set, packages with different colors will not obsolete each other\&. +.RE +.PP +\fBPOOL_FLAG_IMPLICITOBSOLETEUSESCOLORS\fR +.RS 4 +Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if packages of the same name can be installed in parallel\&. For current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true (this is the default if FEDORA is defined when libsolv is compiled)\&. +.RE +.PP +\fBPOOL_FLAG_NOINSTALLEDOBSOLETES\fR +.RS 4 +New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you also erase the other package\&. +.RE +.PP +\fBPOOL_FLAG_HAVEDISTEPOCH\fR +.RS 4 +Mandriva added a new field called distepoch that gets checked in version comparison if the epoch/version/release of two packages are the same\&. +.RE +.PP +\fBPOOL_FLAG_NOOBSOLETESMULTIVERSION\fR +.RS 4 +If a package is installed in multiversionmode, rpm used to ignore both the implicit obsoletes and the obsolete dependency of a package\&. This was changed to ignoring just the implicit obsoletes, thus you may install multiple versions of the same name, but obsoleted packages still get removed\&. +.RE +.PP +\fBPOOL_FLAG_ADDFILEPROVIDESFILTERED\fR +.RS 4 +Make the addfileprovides method only add files from the standard locations (i\&.e\&. the \(lqbin\(rq and \(lqetc\(rq directories)\&. This is useful if you have only few packages that use non\-standard file dependencies, but you still want the fast speed that addfileprovides() generates\&. +.RE +.SS "Functions" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_setdisttype(Pool *\fR\fIpool\fR\fB, int\fR \fIdisttype\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the package type of your system\&. The disttype is used for example to define package comparison semantics\&. Libsolv\(cqs default disttype should match the package manager of your system, so you only need to use this function if you want to use the library to solve packaging problems for different systems\&. The Function returns the old disttype on success, and \-1 if the new disttype is not supported\&. Note that any pool_setarch and pool_setarchpolicy calls need to come after the pool_setdisttype call, as they make use of the noarch/any/all architecture id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_set_flag(Pool *\fR\fIpool\fR\fB, int\fR \fIflag\fR\fB, int\fR \fIvalue\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set a flag to a new value\&. Returns the old value of the flag\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_get_flag(Pool *\fR\fIpool\fR\fB, int\fR \fIflag\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Get the value of a pool flag\&. See the constants section about the meaning of the flags\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_set_rootdir(Pool *\fR\fIpool\fR\fB, const char *\fR\fIrootdir\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set a specific root directory\&. Some library functions support a flag that tells the function to prepend the rootdir to file and directory names\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_get_rootdir(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the current value of the root directory\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *pool_prepend_rootdir(Pool *\fR\fIpool\fR\fB, const char *\fR\fIdir\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Prepend the root directory to the \fIdir\fR argument string\&. The returned string has been newly allocated and needs to be freed after use\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *pool_prepend_rootdir_tmp(Pool *\fR\fIpool\fR\fB, const char *\fR\fIdir\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Same as pool_prepend_rootdir, but uses the pool\(cqs temporary space for allocation\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_set_installed(Pool *\fR\fIpool\fR\fB, Repo *\fR\fIrepo\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set which repository should be treated as the \(lqinstalled\(rq repository, i\&.e\&. the one that holds information about the installed packages\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_set_languages(Pool *\fR\fIpool\fR\fB, const char **\fR\fIlanguages\fR\fB, int\fR \fInlanguages\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the language of your system\&. The library provides lookup functions that return localized strings, for example for package descriptions\&. You can set an array of languages to provide a fallback mechanism if one language is not available\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setarch(Pool *\fR\fIpool\fR\fB, const char *\fR\fIarch\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the architecture of your system\&. The architecture is used to determine which packages are installable and which packages cannot be installed\&. The \fIarch\fR argument is normally the \(lqmachine\(rq value of the \(lquname\(rq system call\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setarchpolicy(Pool *, const char *)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set the architecture policy for your system\&. This is the general version of pool_setarch (in fact pool_setarch calls pool_setarchpolicy internally)\&. See the section about architecture policies for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_addvendorclass(Pool *\fR\fIpool\fR\fB, const char **\fR\fIvendorclass\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Add a new vendor equivalence class to the system\&. A vendor equivalence class defines if an installed package of one vendor can be replaced by a package coming from a different vendor\&. The \fIvendorclass\fR argument must be a NULL terminated array of strings\&. See the section about vendor policies for more information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setvendorclasses(Pool *\fR\fIpool\fR\fB, const char **\fR\fIvendorclasses\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Set all allowed vendor equivalences\&. The vendorclasses argument must be an NULL terminated array consisting of all allowed classes concatenated\&. Each class itself must be NULL terminated, thus the last class ends with two NULL elements, one to finish the class and one to finish the list of classes\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_set_custom_vendorcheck(Pool *\fR\fIpool\fR\fB, int (*\fR\fIvendorcheck\fR\fB)(Pool *, Solvable *, Solvable *))\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Define a custom vendor check mechanism\&. You can use this if libsolv\(cqs internal vendor equivalence class mechanism does not match your needs\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setloadcallback(Pool *\fR\fIpool\fR\fB, int (*\fR\fIcb\fR\fB)(Pool *, Repodata *, void *), void *\fR\fIloadcbdata\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Define a callback function that gets called when repository metadata needs to be loaded on demand\&. See the section about on demand loading in the libsolv\-repodata manual\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_setnamespacecallback(Pool *\fR\fIpool\fR\fB, Id (*\fR\fIcb\fR\fB)(Pool *, void *,\fR \fIId\fR\fB,\fR \fIId\fR\fB), void *\fR\fInscbdata\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Define a callback function to implement custom namespace support\&. See the section about namespace dependencies\&. +.SH "ID POOL MANAGEMENT" +.SS "Constants" +.PP +\fBID_EMPTY\fR +.RS 4 +The Id of the empty string, it is always Id 1\&. +.RE +.PP +\fBREL_LT\fR +.RS 4 +Represents a \(lq<\(rq relation\&. +.RE +.PP +\fBREL_EQ\fR +.RS 4 +Represents a \(lq=\(rq relation\&. +.RE +.PP +\fBREL_GT\fR +.RS 4 +Represents a \(lq>\(rq relation\&. You can use combinations of REL_GT, REL_EQ, and REL_LT or\-ed together to create any relation you like\&. +.RE +.PP +\fBREL_AND\fR +.RS 4 +A boolean AND operation, the \(lqname\(rq and \(lqevr\(rq parts of the relation can be two sub\-dependencies\&. Packages must match both parts of the dependency\&. +.RE +.PP +\fBREL_OR\fR +.RS 4 +A boolean OR operation, the \(lqname\(rq and \(lqevr\(rq parts of the relation can be two sub\-dependencies\&. Packages can match any part of the dependency\&. +.RE +.PP +\fBREL_WITH\fR +.RS 4 +Like REL_AND, but packages must match both dependencies simultaneously\&. See the section about boolean dependencies about more information\&. +.RE +.PP +\fBREL_NAMESPACE\fR +.RS 4 +A special namespace relation\&. See the section about namespace dependencies for more information\&. +.RE +.PP +\fBREL_ARCH\fR +.RS 4 +An architecture filter dependency\&. The \(lqname\(rq part of the relation is a sub\-dependency, the \(lqevr\(rq part is the Id of an architecture that the matching packages must have (note that this is an exact match ignoring architecture policies)\&. +.RE +.PP +\fBREL_FILECONFLICT\fR +.RS 4 +An internal file conflict dependency used to represent file conflicts\&. See the pool_add_fileconflicts_deps() function\&. +.RE +.PP +\fBREL_COND\fR +.RS 4 +A conditional dependency, the \(lqname\(rq sub\-dependency is only considered if the \(lqevr\(rq sub\-dependency is fulfilled\&. See the section about boolean dependencies about more information\&. +.RE +.PP +\fBREL_UNLESS\fR +.RS 4 +A conditional dependency, the \(lqname\(rq sub\-dependency is only considered if the \(lqevr\(rq sub\-dependency is not fulfilled\&. See the section about boolean dependencies about more information\&. +.RE +.PP +\fBREL_COMPAT\fR +.RS 4 +A compat dependency used in Haiku to represent version ranges\&. The \(lqname\(rq part is the actual version, the \(lqevr\(rq part is the backwards compatibility version\&. +.RE +.PP +\fBREL_KIND\fR +.RS 4 +A pseudo dependency that limits the solvables to a specific kind\&. The kind is expected to be a prefix of the solvable name, e\&.g\&. \(lqpatch:foo\(rq would be of kind \(lqpatch\(rq\&. \(lqREL_KIND\(rq is only supported in the selection functions\&. +.RE +.PP +\fBREL_MULTIARCH\fR +.RS 4 +A debian multiarch annotation\&. The most common value for the \(lqevr\(rq part is \(lqany\(rq\&. +.RE +.PP +\fBREL_ELSE\fR +.RS 4 +The else part of a \(lqREL_COND\(rq or \(lqREL_UNLESS\(rq dependency\&. See the section about boolean dependencies\&. +.RE +.PP +\fBREL_ERROR\fR +.RS 4 +An illegal dependency\&. This is useful to encode dependency parse errors\&. +.RE +.SS "Functions" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_str2id(Pool *\fR\fIpool\fR\fB, const char *\fR\fIstr\fR\fB, int\fR \fIcreate\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Add a string to the pool of unified strings, returning the Id of the string\&. If \fIcreate\fR is zero, new strings will not be added to the pool, instead Id 0 is returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_strn2id(Pool *\fR\fIpool\fR\fB, const char *\fR\fIstr\fR\fB, unsigned int\fR \fIlen\fR\fB, int\fR \fIcreate\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Same as pool_str2id, but only \fIlen\fR characters of the string are used\&. This can be used to add substrings to the pool\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_rel2id(Pool *\fR\fIpool\fR\fB, Id\fR \fIname\fR\fB, Id\fR \fIevr\fR\fB, int\fR \fIflags\fR\fB, int\fR \fIcreate\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Create a relational dependency from to other dependencies, \fIname\fR and \fIevr\fR, and a \fIflag\fR\&. See the \fBREL_\fR constants for the supported flags\&. As with pool_str2id, \fIcreate\fR defines if new dependencies will get added or Id zero will be returned instead\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_id2langid(Pool *\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB, const char *\fR\fIlang\fR\fB, int\fR \fIcreate\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Attach a language suffix to a string Id\&. This function can be used to create language keyname Ids from keynames, it is functional equivalent to converting the \fIid\fR argument to a string, adding a \(lq:\(rq character and the \fIlang\fR argument to the string and then converting the result back into an Id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_id2str(const Pool *\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert an Id back into a string\&. If the Id is a relational Id, the \(lqname\(rq part will be converted instead\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_id2rel(const Pool *\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the relation string of a relational Id\&. Returns an empty string if the passed Id is not a relation\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_id2evr(const Pool *\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the \(lqevr\(rq part of a relational Id as string\&. Returns an empty string if the passed Id is not a relation\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_dep2str(Pool *\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert an Id back into a string\&. If the passed Id belongs to a relation, a string representing the relation is returned\&. Note that in that case the string is allocated on the pool\(cqs temporary space\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_freeidhashes(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Free the hashes used to unify strings and relations\&. You can use this function to save memory if you know that you will no longer create new strings and relations\&. +.SH "SOLVABLE FUNCTIONS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBSolvable *pool_id2solvable(const Pool *\fR\fIpool\fR\fB, Id\fR \fIp\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert a solvable Id into a pointer to the solvable data\&. Note that the pointer may become invalid if new solvables are created or old solvables deleted, because the array storing all solvables may get reallocated\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_solvable2id(const Pool *\fR\fIpool\fR\fB, Solvable *\fR\fIs\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert a pointer to the solvable data into a solvable Id\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_solvid2str(Pool *\fR\fIpool\fR\fB, Id\fR \fIp\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return a string representing the solvable with the Id \fIp\fR\&. The string will be some canonical representation of the solvable, usually a combination of the name, the version, and the architecture\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_solvable2str(Pool *\fR\fIpool\fR\fB, Solvable *\fR\fIs\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Same as pool_solvid2str, but instead of the Id, a pointer to the solvable is passed\&. +.SH "DEPENDENCY MATCHING" +.SS "Constants" +.PP +\fBEVRCMP_COMPARE\fR +.RS 4 +Compare all parts of the version, treat missing parts as empty strings\&. +.RE +.PP +\fBEVRCMP_MATCH_RELEASE\fR +.RS 4 +A special mode for rpm version string matching\&. If a version misses a release part, it matches all releases\&. In that case the special values \(lq\-2\(rq and \(lq2\(rq are returned, depending on which of the two versions did not have a release part\&. +.RE +.PP +\fBEVRCMP_MATCH\fR +.RS 4 +A generic match, missing parts always match\&. +.RE +.PP +\fBEVRCMP_COMPARE_EVONLY\fR +.RS 4 +Only compare the epoch and the version parts, ignore the release part\&. +.RE +.SS "Functions" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_evrcmp(const Pool *\fR\fIpool\fR\fB, Id\fR \fIevr1id\fR\fB, Id\fR \fIevr2id\fR\fB, int\fR \fImode\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Compare two version Ids, return \-1 if the first version is less than the second version, 0 if they are identical, and 1 if the first version is bigger than the second one\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_evrcmp_str(const Pool *\fR\fIpool\fR\fB, const char *\fR\fIevr1\fR\fB, const char *\fR\fIevr2\fR\fB, int\fR \fImode\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Same as pool_evrcmp(), but uses strings instead of Ids\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_evrmatch(const Pool *\fR\fIpool\fR\fB, Id\fR \fIevrid\fR\fB, const char *\fR\fIepoch\fR\fB, const char *\fR\fIversion\fR\fB, const char *\fR\fIrelease\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Match a version Id against an epoch, a version and a release string\&. Passing NULL means that the part should match everything\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_match_dep(Pool *\fR\fIpool\fR\fB, Id\fR \fId1\fR\fB, Id\fR \fId2\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Returns \(lq1\(rq if the dependency \fId1\fR (the provider) is matched by the dependency \fId2\fR, otherwise \(lq0\(rq is returned\&. For two dependencies to match, both the \(lqname\(rq parts must match and the version range described by the \(lqevr\(rq parts must overlap\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_match_nevr(Pool *\fR\fIpool\fR\fB, Solvable *\fR\fIs\fR\fB, Id\fR \fId\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Like pool_match_dep, but the provider is the "self\-provides" dependency of the Solvable \fIs\fR, i\&.e\&. the dependency \(lqs→name = s→evr\(rq\&. +.SH "WHATPROVIDES INDEX" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_createwhatprovides(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Create an index that maps dependency Ids to sets of packages that provide the dependency\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_freewhatprovides(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Free the whatprovides index to save memory\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_whatprovides(Pool *\fR\fIpool\fR\fB, Id\fR \fId\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return an offset into the Pool\(cqs whatprovidesdata array\&. The solvables with the Ids stored starting at that offset provide the dependency \fId\fR\&. The solvable list is zero terminated\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId *pool_whatprovides_ptr(Pool *\fR\fIpool\fR\fB, Id\fR \fId\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Instead of returning the offset, return the pointer to the Ids stored at that offset\&. Note that this pointer has a very limit validity time, as any call that adds new values to the whatprovidesdata area may reallocate the array\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_queuetowhatprovides(Pool *\fR\fIpool\fR\fB, Queue *\fR\fIq\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Add the contents of the Queue \fIq\fR to the end of the whatprovidesdata array, returning the offset into the array\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_addfileprovides(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Some package managers like rpm allow dependencies on files contained in other packages\&. To allow libsolv to deal with those dependencies in an efficient way, you need to call the addfileprovides method after creating and reading all repositories\&. This method will scan all dependency for file names and then scan all packages for matching files\&. If a filename has been matched, it will be added to the provides list of the corresponding package\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_addfileprovides_queue(Pool *\fR\fIpool\fR\fB, Queue *\fR\fIidq\fR\fB, Queue *\fR\fIidqinst\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Same as pool_addfileprovides, but the added Ids are returned in two Queues, \fIidq\fR for all repositories except the one containing the \(lqinstalled\(rq packages, \fIidqinst\fR for the latter one\&. This information can be stored in the meta section of the repositories to speed up the next time the repository is loaded and addfileprovides is called +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_set_whatprovides(\fR\fIpool\fR\fB, Id\fR \fIid\fR\fB, Id\fR \fIoffset\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Manually set an entry in the whatprovides index\&. You\(cqll never do this for package dependencies, as those entries are created by calling the pool_createwhatprovides() function\&. But this function is useful for namespace provides if you do not want to use a namespace callback to lazily set the provides\&. The offset argument is a offset in the whatprovides array, thus you can use \(lq1\(rq as a false value and \(lq2\(rq as true value\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_flush_namespaceproviders(Pool *\fR\fIpool\fR\fB, Id\fR \fIns\fR\fB, Id\fR \fIevr\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Clear the cache of the providers for namespace dependencies matching namespace \fIns\fR\&. If the \fIevr\fR argument is non\-zero, the namespace dependency for exactly that dependency is cleared, otherwise all matching namespace dependencies are cleared\&. See the section about Namespace dependencies for further information\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_add_fileconflicts_deps(Pool *\fR\fIpool\fR\fB, Queue *\fR\fIconflicts\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Some package managers like rpm report conflicts when a package installation overwrites a file of another installed package with different content\&. As file content information is not stored in the repository metadata, those conflicts can only be detected after the packages are downloaded\&. Libsolv provides a function to check for such conflicts, pool_findfileconflicts()\&. If conflicts are found, they can be added as special \fBREL_FILECONFLICT\fR provides dependencies, so that the solver will know about the conflict when it is re\-run\&. +.SH "UTILITY FUNCTIONS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *pool_alloctmpspace(Pool *\fR\fIpool\fR\fB, int\fR \fIlen\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Allocate space on the pool\(cqs temporary space area\&. This space has a limited lifetime, it will be automatically freed after a fixed amount (currently 16) of other pool_alloctmpspace() calls are done\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_freetmpspace(Pool *\fR\fIpool\fR\fB, const char *\fR\fIspace\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Give the space allocated with pool_alloctmpspace back to the system\&. You do not have to use this function, as the space is automatically reclaimed, but it can be useful to extend the lifetime of other pointers to the pool\(cqs temporary space area\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_bin2hex(Pool *\fR\fIpool\fR\fB, const unsigned char *\fR\fIbuf\fR\fB, int\fR \fIlen\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert some binary data to hexadecimal, returning a string allocated in the pool\(cqs temporary space area\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *pool_tmpjoin(Pool *\fR\fIpool\fR\fB, const char *\fR\fIstr1\fR\fB, const char *\fR\fIstr2\fR\fB, const char *\fR\fIstr3\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Join three strings and return the result in the pool\(cqs temporary space area\&. You can use NULL arguments if you just want to join less strings\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBchar *pool_tmpappend(Pool *\fR\fIpool\fR\fB, const char *\fR\fIstr1\fR\fB, const char *\fR\fIstr2\fR\fB, const char *\fR\fIstr3\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Like pool_tmpjoin(), but if the first argument is the last allocated space in the pool\(cqs temporary space area, it will be replaced with the result of the join and no new temporary space slot will be used\&. Thus you can join more than three strings by a combination of one pool_tmpjoin() and multiple pool_tmpappend() calls\&. Note that the \fIstr1\fR pointer is no longer usable after the call\&. +.SH "DATA LOOKUP" +.SS "Constants" +.PP +\fBSOLVID_POS\fR +.RS 4 +Use the data position stored in the pool for the lookup instead of looking up the data of a solvable\&. +.RE +.PP +\fBSOLVID_META\fR +.RS 4 +Use the data stored in the meta section of a repository (or repodata area) instead of looking up the data of a solvable\&. This constant does not work for the pool\(cqs lookup functions, use it for the repo\(cqs or repodata\(cqs lookup functions instead\&. It\(cqs just listed for completeness\&. +.RE +.SS "Functions" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_lookup_str(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the string value stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBunsigned long long pool_lookup_num(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, unsigned long long\fR \fInotfound\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the 64bit unsigned number stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. If no such number is found, the value of the \fInotfound\fR argument is returned instead\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBId pool_lookup_id(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the Id stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_lookup_idarray(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Queue *\fR\fIq\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Fill the queue \fIq\fR with the content of the Id array stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. Returns \(lq1\(rq if an array was found, otherwise the queue will be empty and \(lq0\(rq will be returned\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_lookup_void(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Returns \(lq1\(rq if a void value is stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR, otherwise \(lq0\(rq\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_lookup_checksum(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Id *\fR\fItypep\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the checksum that is stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. The type of the checksum will be returned over the \fItypep\fR pointer\&. If no such checksum is found, NULL will be returned and the type will be set to zero\&. Note that the result is stored in the Pool\(cqs temporary space area\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst unsigned char *pool_lookup_bin_checksum(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, Id *\fR\fItypep\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return the checksum that is stored under the attribute \fIkeyname\fR in solvable \fIsolvid\fR\&. Returns the checksum as binary data, you can use the returned type to calculate the length of the checksum\&. No temporary space area is needed\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_lookup_deltalocation(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, unsigned int *\fR\fImedianrp\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +This is a utility lookup function to return the delta location for a delta rpm\&. As solvables cannot store deltas, you have to use SOLVID_POS as argument and set the Pool\(cqs datapos pointer to point to valid delta rpm data\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_search(Pool *\fR\fIpool\fR\fB, Id\fR \fIsolvid\fR\fB, Id\fR \fIkeyname\fR\fB, const char *\fR\fImatch\fR\fB, int\fR \fIflags\fR\fB, int (*\fR\fIcallback\fR\fB)(void *\fR\fIcbdata\fR\fB, Solvable *\fR\fIs\fR\fB, Repodata *\fR\fIdata\fR\fB, Repokey *\fR\fIkey\fR\fB, KeyValue *\fR\fIkv\fR\fB), void *\fR\fIcbdata\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Perform a search on all data stored in the pool\&. You can limit the search area by using the \fIsolvid\fR and \fIkeyname\fR arguments\&. The values can be optionally matched against the \fImatch\fR argument, use NULL if you do not want this matching\&. See the Dataiterator manpage about the possible matches modes and the \fIflags\fR argument\&. For all (matching) values, the callback function is called with the \fIcbdata\fR callback argument and the data describing the value\&. +.SH "JOB AND SELECTION FUNCTIONS" +.sp +A Job consists of two Ids, \fIhow\fR and \fIwhat\fR\&. The \fIhow\fR part describes the action, the job flags, and the selection method while the \fIwhat\fR part is in input for the selection\&. A Selection is a queue consisting of multiple jobs (thus the number of elements in the queue must be a multiple of two)\&. See the Solver manpage for more information about jobs\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_job2str(Pool *\fR\fIpool\fR\fB, Id\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB, Id\fR \fIflagmask\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert a job into a string\&. Useful for debugging purposes\&. The \fIflagmask\fR can be used to mask the flags of the job, use \(lq0\(rq if you do not want to see such flags, \(lq\-1\(rq to see all flags, or a combination of the flags you want to see\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_job2solvables(Pool *\fR\fIpool\fR\fB, Queue *\fR\fIpkgs\fR\fB, Id\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return a list of solvables that the specified job selects\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint pool_isemptyupdatejob(Pool *\fR\fIpool\fR\fB, Id\fR \fIhow\fR\fB, Id\fR \fIwhat\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Return \(lq1\(rq if the job is an update job that does not work with any installed package, i\&.e\&. the job is basically a no\-op\&. You can use this to turn no\-op update jobs into install jobs (as done by package managers like \(lqzypper\(rq)\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBconst char *pool_selection2str(Pool *\fR\fIpool\fR\fB, Queue *\fR\fIselection\fR\fB, Id\fR \fIflagmask\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Convert a selection into a string\&. Useful for debugging purposes\&. See the pool_job2str() function for the \fIflagmask\fR argument\&. +.SH "ODDS AND ENDS" +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_freeallrepos(Pool *\fR\fIpool\fR\fB, int\fR \fIreuseids\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Free all repos from the pool (including all solvables)\&. If \fIreuseids\fR is true, all Ids of the solvables are free to be reused the next time solvables are created\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fBvoid pool_clear_pos(Pool *\fR\fIpool\fR\fB)\fR; +.fi +.if n \{\ +.RE +.\} +.sp +Clear the data position stored in the pool\&. +.SH "ARCHITECTURE POLICIES" +.sp +An architecture policy defines a list of architectures that can be installed on the system, and also the relationship between them (i\&.e\&. the ordering)\&. Architectures can be delimited with three different characters: +.PP +\fB\*(Aq:\*(Aq\fR +.RS 4 +No relationship between the architectures\&. A package of one architecture can not be replaced with one of the other architecture\&. +.RE +.PP +\fB\*(Aq>\*(Aq\fR +.RS 4 +The first architecture is better than the second one\&. An installed package of the second architecture may be replaced with one from the first architecture and vice versa\&. The solver will select the better architecture if the versions are the same\&. +.RE +.PP +\fB\*(Aq=\*(Aq\fR +.RS 4 +The two architectures are freely exchangeable\&. Used to define aliases for architectures\&. +.RE +.sp +An example would be \*(Aqx86_64:i686=athlon>i586\*(Aq\&. This means that x86_64 packages can only be replaced by other x86_64 packages, i686 packages can be replaced by i686 and i586 packages (but i686 packages will be preferred) and athlon is another name for the i686 architecture\&. +.sp +You can turn off the architecture replacement checks with the Solver\(cqs SOLVER_FLAG_ALLOW_ARCHCHANGE flag\&. +.SH "VENDOR POLICIES" +.sp +Different vendors often compile packages with different features, so Libsolv only replace installed packages of one vendor with packages coming from the same vendor\&. Also, while the version of a package is normally defined by the upstream project, the release part of the version is set by the vendor\(cqs package maintainer, so it\(cqs not meaningful to do version comparisons for packages coming from different vendors\&. +.sp +Vendor in this case means the SOLVABLE_VENDOR string stored in each solvable\&. Sometimes a vendor changes names, or multiple vendors form a group that coordinate their package building, so libsolv offers a way to define that a group of vendors are compatible\&. You do that be defining vendor equivalence classes, packages from a vendor from one class may be replaced with packages from all the other vendors in the class\&. +.sp +There can be multiple equivalence classes, the set of allowed vendor changes for an installed package is calculated by building the union of all of the equivalence classes the vendor of the installed package is part of\&. +.sp +You can turn off the vendor replacement checks with the Solver\(cqs SOLVER_FLAG_ALLOW_VENDORCHANGE flag\&. +.SH "BOOLEAN DEPENDENCIES" +.sp +Boolean Dependencies allow building complex expressions from simple dependencies\&. Note that depending on the package manager only a subset of those may be useful\&. For example, debian currently only allows an "OR" expression\&. +.PP +\fBREL_OR\fR +.RS 4 +The expression is true if either the first dependency or the second one is true\&. This is useful for package dependencies like \(lqRequires\(rq, where you can specify that either one of the packages need to be installed\&. +.RE +.PP +\fBREL_AND\fR +.RS 4 +The expression is true if both dependencies are true\&. The packages fulfilling the dependencies may be different, i\&.e\&. \(lqSupplements: perl REL_AND python\(rq is true if both a package providing perl and a package providing python are installed\&. +.RE +.PP +\fBREL_WITH\fR +.RS 4 +The expression is true if both dependencies are true and are fulfilled by the same package\&. Thus \(lqSupplements: perl REL_WITH python\(rq would only be true if a package is installed that provides both dependencies (some kind of multi\-language interpreter)\&. +.RE +.PP +\fBREL_COND\fR +.RS 4 +The expression is true if the first dependency is true or the second dependency is false\&. \(lqA REL_COND B\(rq is equivalent to \(lqA REL_OR (NOT B)\(rq (except that libsolv does not expose \(lqNOT\(rq)\&. +.RE +.PP +\fBREL_UNLESS\fR +.RS 4 +The expression is true if the first dependency is true and the second dependency is false\&. \(lqA REL_UNLESS B\(rq is equivalent to \(lqA REL_AND (NOT B)\(rq (except that libsolv does not expose \(lqNOT\(rq)\&. +.RE +.PP +\fBREL_ELSE\fR +.RS 4 +The \(lqelse\(rq part of a \(lqREL_COND\(rq or \(lqREL_UNLESS\(rq dependency\&. It has to be directly in the evr part of the condition, e\&.g\&. \(lqfoo REL_COND (bar REL_ELSE baz)\(rq\&. For \(lqREL_COND\(rq this is equivalent to writing \(lq(foo REL_COND bar) REL_AND (bar REL_OR baz)\(rq\&. For \(lqREL_UNLESS\(rq this is equivalent to writing \(lq(foo REL_UNLESS bar) REL_OR (bar REL_AND baz)\(rq\&. +.RE +.sp +Each sub\-dependency of a boolean dependency can in turn be a boolean dependency, so you can chain them to create complex dependencies\&. +.SH "NAMESPACE DEPENDENCIES" +.sp +Namespace dependencies can be used to implement dependencies on attributes external to libsolv\&. An example would be a dependency on the language set by the user\&. This types of dependencies are usually only used for \(lqConflicts\(rq or \(lqSupplements\(rq dependencies, as the underlying package manager does not know how to deal with them\&. +.sp +If the library needs to evaluate a namespace dependency, it calls the namespace callback function set in the pool\&. The callback function can return a set of packages that \(lqprovide\(rq the dependency\&. If the dependency is provided by the system, the returned set should consist of just the system solvable (Solvable Id 1)\&. +.sp +The returned set of packages must be returned as offset into the whatprovidesdata array\&. You can use the pool_queuetowhatprovides function to convert a queue into such an offset\&. To ease programming the callback function, the return values \(lq0\(rq and \(lq1\(rq are not interpreted as an offset\&. \(lq0\(rq means that no package is in the return set, \(lq1\(rq means that just the system solvable is in the set\&. +.sp +The returned set is cached, so that for each namespace dependency the callback is just called once\&. If you need to flush the cache (maybe because the user has selected a different language), use the pool_flush_namespaceproviders() function\&. +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/miniconda3/share/man/man3/libsolv.3 b/miniconda3/share/man/man3/libsolv.3 new file mode 100644 index 0000000000000000000000000000000000000000..91d22903dd6d1f0e5d2abc9f969178b9dba73e6e --- /dev/null +++ b/miniconda3/share/man/man3/libsolv.3 @@ -0,0 +1,64 @@ +'\" t +.\" Title: Libsolv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 03/02/2022 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "LIBSOLV" "3" "03/02/2022" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +libsolv \- package dependency solver library using a satisfiability algorithm +.SH "DOCUMENTATION" +.sp +The libsolv documentation is split into multiple parts: +.PP +\fBlibsolv\-history\fR +.RS 4 +how the libsolv library came into existence +.RE +.PP +\fBlibsolv\-constantids\fR +.RS 4 +fixed Ids for often used strings +.RE +.PP +\fBlibsolv\-bindings\fR +.RS 4 +access libsolv from perl/python/ruby +.RE +.PP +\fBlibsolv\-pool\fR +.RS 4 +libsolv\(cqs pool object +.RE +.SH "POINTER VALIDITY" +.sp +Note that all pointers to objects that have an Id have only a limited validity period, with the exception of Repo pointers\&. They are only guaranteed to be valid until a new object of that type is added or an object of that type is removed\&. Thus pointers to Solvable objects are only valid until another solvable is created, because adding a Solvable may relocate the Pool\(cqs Solvable array\&. This is also true for Pool strings, you should use solv_strdup() to create a copy of the string if you want to use it at some later time\&. You should use the Ids in the code and not the pointers, except for short times where you know that the pointer is safe\&. +.sp +Note also that the data lookup functions or the dataiterator also return values with limited lifetime, this is especially true for data stored in the paged data segment of solv files\&. This is normally data that consists of big strings like package descriptions or is not often needed like package checksums\&. Thus looking up a description of a solvable and then looking up the description of a different solvable or even the checksum of the same solvable may invalidate the first result\&. (The dataiterator supports a dataiterator_strdup() function to create a safe copy\&.) +.sp +The language bindings already deal with pointer validity, so you do not have to worry about this issue when using the bindings\&. +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/miniconda3/share/man/man3/libssh2_agent_connect.3 b/miniconda3/share/man/man3/libssh2_agent_connect.3 new file mode 100644 index 0000000000000000000000000000000000000000..081ec39ef5abb96fa667a38782906c518d3c372e --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_connect.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_connect - connect to an ssh-agent +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_connect(LIBSSH2_AGENT *agent); +.fi +.SH DESCRIPTION +Connect to an ssh-agent running on the system. + +Call \fBlibssh2_agent_disconnect(3)\fP to close the connection after +you are doing using it. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_disconnect(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_disconnect.3 b/miniconda3/share/man/man3/libssh2_agent_disconnect.3 new file mode 100644 index 0000000000000000000000000000000000000000..136a6e19de2959cd1457f13cdc5b408b1a743d5d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_disconnect.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_disconnect 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_disconnect - close a connection to an ssh-agent +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_disconnect(LIBSSH2_AGENT *agent); +.fi +.SH DESCRIPTION +Close a connection to an ssh-agent. + +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_free(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_free.3 b/miniconda3/share/man/man3/libssh2_agent_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..1011f44454788f378b6fd988f970516806c51567 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_free.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_free 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_free - free an ssh-agent handle +.SH SYNOPSIS +.nf +#include + +void +libssh2_agent_free(LIBSSH2_AGENT *agent); +.fi +.SH DESCRIPTION +Free an ssh-agent handle. This function also frees the internal +collection of public keys. +.SH RETURN VALUE +None. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_disconnect(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_get_identity.3 b/miniconda3/share/man/man3/libssh2_agent_get_identity.3 new file mode 100644 index 0000000000000000000000000000000000000000..2372e9c006092a620d4f9c1817f489a0f1710979 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_get_identity.3 @@ -0,0 +1,36 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_get_identity 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_get_identity(LIBSSH2_AGENT *agent, + struct libssh2_agent_publickey **store, + struct libssh2_agent_publickey *prev); +.fi +.SH DESCRIPTION +\fIlibssh2_agent_get_identity(3)\fP allows an application to iterate +over all public keys in the collection managed by ssh-agent. + +\fIstore\fP should point to a pointer that gets filled in to point to the +public key data. + +\fIprev\fP is a pointer to a previous 'struct libssh2_agent_publickey' +as returned by a previous invoke of this function, or NULL to get the +first entry in the internal collection. +.SH RETURN VALUE +Returns 0 if everything is fine and information about a host was stored in +the \fIstore\fP struct. + +Returns 1 if it reached the end of public keys. + +Returns negative values for error +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_list_identities(3) +.BR libssh2_agent_userauth(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_get_identity_path.3 b/miniconda3/share/man/man3/libssh2_agent_get_identity_path.3 new file mode 100644 index 0000000000000000000000000000000000000000..703d04abef2cd95fb94abcff6b551e8cdd7ebb79 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_get_identity_path.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) Will Cosgrove +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_get_identity_path 3 "6 Mar 2019" "libssh2" "libssh2" +.SH NAME +libssh2_agent_get_identity_path - gets the custom ssh-agent socket path +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_agent_get_identity_path(LIBSSH2_AGENT *agent); +.fi +.SH DESCRIPTION +Returns the custom agent identity socket path if set using libssh2_agent_set_identity_path() + +.SH RETURN VALUE +Returns the socket path on disk. +.SH AVAILABILITY +Added in libssh2 1.9 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_set_identity_path(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_init.3 b/miniconda3/share/man/man3/libssh2_agent_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..c36536174ee7a57a12ce49eb1769c1208ad24881 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_init.3 @@ -0,0 +1,28 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_init - init an ssh-agent handle +.SH SYNOPSIS +.nf +#include + +LIBSSH2_AGENT * +libssh2_agent_init(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Init an ssh-agent handle. Returns the handle to an internal +representation of an ssh-agent connection. After the successful +initialization, an application can call \fBlibssh2_agent_connect(3)\fP +to connect to a running ssh-agent. + +Call \fBlibssh2_agent_free(3)\fP to free the handle again after you are +doing using it. +.SH RETURN VALUE +Returns a handle pointer or NULL if something went wrong. The returned handle +is used as input to all other ssh-agent related functions libssh2 provides. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_free(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_list_identities.3 b/miniconda3/share/man/man3/libssh2_agent_list_identities.3 new file mode 100644 index 0000000000000000000000000000000000000000..bac2c735a0971b531cc4f0c976208a8950759c98 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_list_identities.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_list_identities 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_list_identities - request an ssh-agent to list of public keys. +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_list_identities(LIBSSH2_AGENT *agent); +.fi +.SH DESCRIPTION +Request an ssh-agent to list of public keys, and stores them in the +internal collection of the handle. Call +\fIlibssh2_agent_get_identity(3)\fP to get a public key off the +collection. + +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_get_identity(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_set_identity_path.3 b/miniconda3/share/man/man3/libssh2_agent_set_identity_path.3 new file mode 100644 index 0000000000000000000000000000000000000000..5a1a237d9d2a3be46ac1f9027f6353b8e0bc8eb4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_set_identity_path.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) Will Cosgrove +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_set_identity_path 3 "6 Mar 2019" "libssh2" "libssh2" +.SH NAME +libssh2_agent_set_identity_path - set an ssh-agent socket path on disk +.SH SYNOPSIS +.nf +#include + +void +libssh2_agent_set_identity_path(LIBSSH2_AGENT *agent, const char *path); +.fi +.SH DESCRIPTION +Allows a custom agent identity socket path instead of the default SSH_AUTH_SOCK env value + +.SH RETURN VALUE +Returns void +.SH AVAILABILITY +Added in libssh2 1.9 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_get_identity_path(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_sign.3 b/miniconda3/share/man/man3/libssh2_agent_sign.3 new file mode 100644 index 0000000000000000000000000000000000000000..c4ba95b3e4679ca225dc155e7dd2b7662cbf3d11 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_sign.3 @@ -0,0 +1,54 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_sign 3 "1 Oct 2022" "libssh2" "libssh2" +.SH NAME +libssh2_agent_sign - sign data, with the help of ssh-agent +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_sign(LIBSSH2_AGENT *agent, + struct libssh2_agent_publickey *identity, + unsigned char **sig, + size_t *s_len, + const unsigned char *data, + size_t d_len, + const char *method, + unsigned int method_len); +.fi +.SH DESCRIPTION +\fIagent\fP - ssh-agent handle as returned by +.BR libssh2_agent_init(3) + +\fIidentity\fP - Public key to authenticate with, as returned by +.BR libssh2_agent_get_identity(3) + +\fIsig\fP - A pointer to a buffer in which to place the signature. The caller +is responsible for freeing the signature with LIBSSH2_FREE. + +\fIs_len\fP - A pointer to the length of the sig parameter. + +\fIdata\fP - The data to sign. + +\fId_len\fP - The length of the data parameter. + +\fImethod\fP - A buffer indicating the signing method. This should match the +string at the start of identity->blob. + +\fImethod_len\fP - The length of the method parameter. + +Sign data using an ssh-agent. This function can be used in a callback +registered with libssh2_session_callback_set2(3) using +LIBSSH2_CALLBACK_AUTHAGENT_SIGN to sign an authentication challenge from a +server. However, the client is responsible for implementing the code that calls +this callback in response to a SSH2_AGENTC_SIGN_REQUEST message. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.11.0 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_get_identity(3) +.BR libssh2_agent_userauth(3) +.BR libssh2_session_callback_set2(3) diff --git a/miniconda3/share/man/man3/libssh2_agent_userauth.3 b/miniconda3/share/man/man3/libssh2_agent_userauth.3 new file mode 100644 index 0000000000000000000000000000000000000000..82a344c0dbca8637ddd001918bd863e8eac7526f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_agent_userauth.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) Daiki Ueno +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_agent_userauth 3 "23 Dec 2009" "libssh2" "libssh2" +.SH NAME +libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent +.SH SYNOPSIS +.nf +#include + +int +libssh2_agent_userauth(LIBSSH2_AGENT *agent, + const char *username, + struct libssh2_agent_publickey *identity); +.fi +.SH DESCRIPTION +\fIagent\fP - ssh-agent handle as returned by +.BR libssh2_agent_init(3) + +\fIusername\fP - Remote user name to authenticate as. + +\fIidentity\fP - Public key to authenticate with, as returned by +.BR libssh2_agent_get_identity(3) + +Attempt public key authentication with the help of ssh-agent. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_get_identity(3) +.BR libssh2_agent_sign(3) diff --git a/miniconda3/share/man/man3/libssh2_banner_set.3 b/miniconda3/share/man/man3/libssh2_banner_set.3 new file mode 100644 index 0000000000000000000000000000000000000000..5f687e5a8074a024d0e133394f8c1eee09285b49 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_banner_set.3 @@ -0,0 +1,36 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_banner_set - set the SSH protocol banner for the local client +.SH SYNOPSIS +.nf +#include + +int +libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 1.4.0. Use the +\fIlibssh2_session_banner_set(3)\fP function instead! + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - A pointer to a user defined banner + +Set the banner that will be sent to the remote host when the SSH session is +started with +.BR libssh2_session_handshake(3) +This is optional; a banner corresponding to the protocol and libssh2 version +will be sent by default. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH AVAILABILITY +Marked as deprecated since 1.4.0 +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. +.SH SEE ALSO +.BR libssh2_session_handshake(3) diff --git a/miniconda3/share/man/man3/libssh2_base64_decode.3 b/miniconda3/share/man/man3/libssh2_base64_decode.3 new file mode 100644 index 0000000000000000000000000000000000000000..e46db823e4f3cc736e898dce7c86898ee68e3f96 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_base64_decode.3 @@ -0,0 +1,30 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2" +.SH NAME +libssh2_base64_decode - decode a base64 encoded string +.SH SYNOPSIS +.nf +#include + +int +libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, + unsigned int *dest_len, const char *src, + unsigned int src_len); +.fi +.SH DESCRIPTION +This function is deemed DEPRECATED and will be removed from libssh2 in a +future version. Do not use it! + +Decode a base64 chunk and store it into a newly allocated buffer. 'dest_len' +will be set to hold the length of the returned buffer that '*dest' will point +to. + +The returned buffer is allocated by this function, but it is not clear how to +free that memory! +.SH BUGS +The memory that *dest points to is allocated by the malloc function libssh2 +uses, but there is no way for an application to free this data in a safe and +reliable way! +.SH RETURN VALUE +0 if successful, \-1 if any error occurred. diff --git a/miniconda3/share/man/man3/libssh2_channel_close.3 b/miniconda3/share/man/man3/libssh2_channel_close.3 new file mode 100644 index 0000000000000000000000000000000000000000..fd9d0001b42818125119c7bd385fd899b5f6e6e4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_close.3 @@ -0,0 +1,29 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_close - close a channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_close(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +\fIchannel\fP - active channel stream to set closed status on. + +Close an active data channel. In practice this means sending an SSH_MSG_CLOSE +packet to the remote host which serves as instruction that no further data +will be sent to it. The remote host may still send data back until it sends +its own close message in response. To wait for the remote end to close its +connection as well, follow this command with +.BR libssh2_channel_wait_closed(3) +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_direct_streamlocal_ex.3 b/miniconda3/share/man/man3/libssh2_channel_direct_streamlocal_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..c2c3d5caf8dd1f2e1ad55763f6ff9becf9f96a1f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_direct_streamlocal_ex.3 @@ -0,0 +1,34 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_direct_streamlocal_ex 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2" +.SH NAME +libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_direct_streamlocal_ex(LIBSSH2_SESSION *session, + const char *socket_path, + const char *shost, int sport); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIsocket_path\fP - UNIX socket to connect to using the SSH host as a proxy. + +\fIshost\fP - Host to tell the SSH server the connection originated on. + +\fIsport\fP - Port to tell the SSH server the connection originated from. + +Tunnel a UNIX socket connection through the SSH transport via the remote host to +a third party. Communication from the client to the SSH server remains +encrypted, communication from the server to the 3rd party host travels +in cleartext. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_direct_tcpip.3 b/miniconda3/share/man/man3/libssh2_channel_direct_tcpip.3 new file mode 100644 index 0000000000000000000000000000000000000000..02033fc0a8054f8b016b0f7623235b5eefa2198d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_direct_tcpip.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, + const char *host, int port); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_direct_tcpip_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_direct_tcpip_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_direct_tcpip_ex.3 b/miniconda3/share/man/man3/libssh2_channel_direct_tcpip_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..02e8f84b3b949dc5505bd53b59b70599e8c81ea0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_direct_tcpip_ex.3 @@ -0,0 +1,40 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, + const char *host, int port, + const char *shost, int sport); + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, + const char *host, int port); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIhost\fP - Third party host to connect to using the SSH host as a proxy. + +\fIport\fP - Port on third party host to connect to. + +\fIshost\fP - Host to tell the SSH server the connection originated on. + +\fIsport\fP - Port to tell the SSH server the connection originated from. + +Tunnel a TCP/IP connection through the SSH transport via the remote host to +a third party. Communication from the client to the SSH server remains +encrypted, communication from the server to the 3rd party host travels +in cleartext. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_eof.3 b/miniconda3/share/man/man3/libssh2_channel_eof.3 new file mode 100644 index 0000000000000000000000000000000000000000..9d9fd7458c6ae2e33f9a1955acefb3a9299de748 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_eof.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_eof - check a channel's EOF status +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_eof(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +\fIchannel\fP - active channel stream to set closed status on. + +Check if the remote host has sent an EOF status for the selected stream. +.SH RETURN VALUE +Returns 1 if the remote host has sent EOF, otherwise 0. Negative on +failure. +.SH SEE ALSO +.BR libssh2_channel_close(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_exec.3 b/miniconda3/share/man/man3/libssh2_channel_exec.3 new file mode 100644 index 0000000000000000000000000000000000000000..08644d5e1d3cded857ccb579ff05a18b48970a91 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_exec.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_flush.3 b/miniconda3/share/man/man3/libssh2_channel_flush.3 new file mode 100644 index 0000000000000000000000000000000000000000..79a7750bee59fa0d2215855211d38085a6e4dfc5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_flush.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_flush(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_flush_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_flush_ex.3 b/miniconda3/share/man/man3/libssh2_channel_flush_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..4a445ba46e3fa6f34adb87d704e7cd4fcd2d3d71 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_flush_ex.3 @@ -0,0 +1,34 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_flush_ex - flush a channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); + +int +libssh2_channel_flush(LIBSSH2_CHANNEL *channel); + +int +libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +\fIchannel\fP - Active channel stream to flush. + +\fIstreamid\fP - Specific substream number to flush. Groups of substreams may +be flushed by passing on of the following Constants. +.br +\fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams +.br +\fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams + +Flush the read buffer for a given channel instance. Individual substreams may +be flushed by number or using one of the provided macros. +.SH RETURN VALUE +Return the number of bytes flushed or negative on failure. +It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. diff --git a/miniconda3/share/man/man3/libssh2_channel_flush_stderr.3 b/miniconda3/share/man/man3/libssh2_channel_flush_stderr.3 new file mode 100644 index 0000000000000000000000000000000000000000..6cd8ade6d28c3d1ccc8aa3c31ed2e0a90a92ce70 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_flush_stderr.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_flush_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_forward_accept.3 b/miniconda3/share/man/man3/libssh2_channel_forward_accept.3 new file mode 100644 index 0000000000000000000000000000000000000000..e6e57e21a29c2e928e51ccf936bf3a2c2ee1da8c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_forward_accept.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_forward_accept - accept a queued connection +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); +.fi +.SH DESCRIPTION +\fIlistener\fP is a forwarding listener instance as returned by +\fBlibssh2_channel_forward_listen_ex(3)\fP. +.SH RETURN VALUE +A newly allocated channel instance or NULL on failure. +.SH ERRORS +When this function returns NULL use \fIlibssh2_session_last_errno(3)\fP to +extract the error code. If that code is \fILIBSSH2_ERROR_EAGAIN\fP, the +session is set to do non-blocking I/O but the call would block. +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_forward_cancel.3 b/miniconda3/share/man/man3/libssh2_channel_forward_cancel.3 new file mode 100644 index 0000000000000000000000000000000000000000..0e11f518ccf07ed263f1819e2a2de7d9d3c31e16 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_forward_cancel.3 @@ -0,0 +1,28 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_forward_cancel - cancel a forwarded TCP port +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); +.fi +.SH DESCRIPTION +\fIlistener\fP - Forwarding listener instance as returned by +.BR libssh2_channel_forward_listen_ex(3) + +Instruct the remote host to stop listening for new connections on a previously +requested host/port. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_forward_listen.3 b/miniconda3/share/man/man3/libssh2_channel_forward_listen.3 new file mode 100644 index 0000000000000000000000000000000000000000..ab1739cfade157acfc6766089ba20aaf17f14c94 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_forward_listen.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_forward_listen_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_forward_listen_ex.3 b/miniconda3/share/man/man3/libssh2_channel_forward_listen_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..c33115e67f8b24ebdf74b0cc7623f9afd4a84371 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_forward_listen_ex.3 @@ -0,0 +1,51 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_forward_listen_ex - listen to inbound connections +.SH SYNOPSIS +.nf +#include + +LIBSSH2_LISTENER * +libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, + char *host, int port, + int *bound_port, int queue_maxsize); + +LIBSSH2_LISTENER * +libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); +.fi +.SH DESCRIPTION +Instruct the remote SSH server to begin listening for inbound TCP/IP +connections. New connections will be queued by the library until accepted by +\fIlibssh2_channel_forward_accept(3)\fP. + +\fIsession\fP - instance as returned by libssh2_session_init(). + +\fIhost\fP - specific address to bind to on the remote host. Binding to +0.0.0.0 (default when NULL is passed) will bind to all available addresses. + +\fIport\fP - port to bind to on the remote host. When 0 is passed, the remote +host will select the first available dynamic port. + +\fIbound_port\fP - Populated with the actual port bound on the remote +host. Useful when requesting dynamic port numbers. + +\fIqueue_maxsize\fP - Maximum number of pending connections to queue before +rejecting further attempts. + +\fIlibssh2_channel_forward_listen(3)\fP is a macro. +.SH RETURN VALUE +A newly allocated LIBSSH2_LISTENER instance or NULL on failure. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on the socket. + +\fILIBSSH2_ERROR_REQUEST_DENIED\fP - The remote server refused the request. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH SEE ALSO +.BR libssh2_channel_forward_accept(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_free.3 b/miniconda3/share/man/man3/libssh2_channel_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..66fddc0643cf7f73e145062ac694b62faeeca48f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_free.3 @@ -0,0 +1,26 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_free - free all resources associated with a channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_free(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +\fIchannel\fP - Channel stream to free. + +Release all resources associated with a channel stream. If the channel has +not yet been closed with +.BR libssh2_channel_close(3) +, it will be called automatically so that the remote end may know that it +can safely free its own resources. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_channel_close(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_get_exit_signal.3 b/miniconda3/share/man/man3/libssh2_channel_get_exit_signal.3 new file mode 100644 index 0000000000000000000000000000000000000000..e1ce01fde459c1f4bdfe18f74b887ac44ee751e1 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_get_exit_signal.3 @@ -0,0 +1,39 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2" +.SH NAME +libssh2_channel_get_exit_signal - get the remote exit signal +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, + char **exitsignal, size_t *exitsignal_len, + char **errmsg, size_t *errmsg_len, + char **langtag, size_t *langtag_len); +.fi +.SH DESCRIPTION +\fIchannel\fP - Closed channel stream to retrieve exit signal from. + +\fIexitsignal\fP - If not NULL, is populated by reference with the exit signal +(without leading "SIG"). Note that the string is stored in a newly allocated +buffer. If the remote program exited cleanly, the referenced string pointer +will be set to NULL. + +\fIexitsignal_len\fP - If not NULL, is populated by reference with the length +of exitsignal. + +\fIerrmsg\fP - If not NULL, is populated by reference with the error message +(if provided by remote server, if not it will be set to NULL). Note that the +string is stored in a newly allocated buffer. + +\fIerrmsg_len\fP - If not NULL, is populated by reference with the length of errmsg. + +\fIlangtag\fP - If not NULL, is populated by reference with the language tag +(if provided by remote server, if not it will be set to NULL). Note that the +string is stored in a newly allocated buffer. + +\fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag. +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. diff --git a/miniconda3/share/man/man3/libssh2_channel_get_exit_status.3 b/miniconda3/share/man/man3/libssh2_channel_get_exit_status.3 new file mode 100644 index 0000000000000000000000000000000000000000..7171b6574aaa6bf25b5306c85c4156515fac3f29 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_get_exit_status.3 @@ -0,0 +1,20 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_get_exit_status - get the remote exit code +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel) +.fi +.SH DESCRIPTION +\fIchannel\fP - Closed channel stream to retrieve exit status from. + +Returns the exit code raised by the process running on the remote host at +the other end of the named channel. Note that the exit status may not be +available if the remote end has not yet set its status to closed. +.SH RETURN VALUE +Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host diff --git a/miniconda3/share/man/man3/libssh2_channel_handle_extended_data.3 b/miniconda3/share/man/man3/libssh2_channel_handle_extended_data.3 new file mode 100644 index 0000000000000000000000000000000000000000..ff4943830a0faa1b3c8fef02f5efda4433fbef84 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_handle_extended_data.3 @@ -0,0 +1,39 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_handle_extended_data - set extended data handling mode +.SH SYNOPSIS +.nf +#include + +void +libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, + int ignore_mode); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 1.1.0. Use the +\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! + +\fIchannel\fP - Active channel stream to change extended data handling on. + +\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual +reading +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary +data the same. Merge all substreams such that calls to +\fIlibssh2_channel_read(3)\fP will pull from all substreams on a +first-in/first-out basis. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it +arrives. + +Change how a channel deals with extended data packets. By default all extended +data is queued until read by \fIlibssh2_channel_read_ex(3)\fP +.SH RETURN VALUE +None. +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data2(3) +.BR libssh2_channel_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_handle_extended_data2.3 b/miniconda3/share/man/man3/libssh2_channel_handle_extended_data2.3 new file mode 100644 index 0000000000000000000000000000000000000000..ac970fcb830bddfb8d9a32adb00c66c94ab57949 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_handle_extended_data2.3 @@ -0,0 +1,37 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_handle_extended_data2 - set extended data handling mode +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, + int ignore_mode); +.fi +.SH DESCRIPTION +\fIchannel\fP - Active channel stream to change extended data handling on. + +\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual +reading +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary +data the same. Merge all substreams such that calls to +.BR libssh2_channel_read(3) +will pull from all substreams on a first-in/first-out basis. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it +arrives. + +Change how a channel deals with extended data packets. By default all +extended data is queued until read by +.BR libssh2_channel_read_ex(3) +.SH RETURN VALUE +Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block. +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data(3) +.BR libssh2_channel_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_ignore_extended_data.3 b/miniconda3/share/man/man3/libssh2_channel_ignore_extended_data.3 new file mode 100644 index 0000000000000000000000000000000000000000..ff8f4900b455d8e86457ad7141654fb3ed47e8b0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_ignore_extended_data.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls +.SH SYNOPSIS +.nf +#include + +void +libssh2_channel_ignore_extended_data(LIBSSH2_CHANNEL *channel, + int ignore_mode); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 0.3.0. Use the +\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! + +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_handle_extended_data(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH ERRORS +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_open_ex.3 b/miniconda3/share/man/man3/libssh2_channel_open_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..66fd802247d400beb7c22d06f79c383fb64bb2bd --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_open_ex.3 @@ -0,0 +1,58 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_open_ex - establish a generic session channel +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, + unsigned int channel_type_len, + unsigned int window_size, + unsigned int packet_size, + const char *message, unsigned int message_len); + +LIBSSH2_CHANNEL * +libssh2_channel_open_session(session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIchannel_type\fP - Channel type to open. Typically one of session, +direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional +types including local, custom channel types. + +\fIchannel_type_len\fP - Length of channel_type + +\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is +allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet. + +\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send +in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet. + +\fImessage\fP - Additional data as required by the selected channel_type. + +\fImessage_len\fP - Length of message parameter. + +Allocate a new channel for exchanging data with the server. This method is +typically called through its macroized form: +.BR libssh2_channel_open_session(3) +or via +.BR libssh2_channel_direct_tcpip(3) +or +.BR libssh2_channel_forward_listen(3) +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_FAILURE\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH SEE ALSO +Add related functions diff --git a/miniconda3/share/man/man3/libssh2_channel_open_session.3 b/miniconda3/share/man/man3/libssh2_channel_open_session.3 new file mode 100644 index 0000000000000000000000000000000000000000..89039ea35fdd26c2bb1a5c8b8fd323233a74a41f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_open_session.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_channel_open_session(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_process_startup.3 b/miniconda3/share/man/man3/libssh2_channel_process_startup.3 new file mode 100644 index 0000000000000000000000000000000000000000..5f827db13ef942e6fe7fa024d27167bd17f0b0a7 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_process_startup.3 @@ -0,0 +1,42 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_process_startup - request a shell on a channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, + const char *request, + unsigned int request_len, + const char *message, + unsigned int message_len); +.fi +.SH DESCRIPTION +\fIchannel\fP - Active session channel instance. + +\fIrequest\fP - Type of process to startup. The SSH2 protocol currently +defines shell, exec, and subsystem as standard process services. + +\fIrequest_len\fP - Length of request parameter. + +\fImessage\fP - Request specific message data to include. + +\fImessage_len\fP - Length of message parameter. + +Initiate a request on a session type channel such as returned by +.BR libssh2_channel_open_ex(3) +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_read.3 b/miniconda3/share/man/man3/libssh2_channel_read.3 new file mode 100644 index 0000000000000000000000000000000000000000..0644e185196bbb093afc70207975a15c6586446c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_read.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_read(LIBSSH2_CHANNEL *channel, + char *buf, size_t buflen); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_read_ex.3 b/miniconda3/share/man/man3/libssh2_channel_read_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..200fe800325e69bb5b2c73b5ac80d68e7526db35 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_read_ex.3 @@ -0,0 +1,50 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_read_ex - read data from a channel stream +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, + char *buf, size_t buflen); + +ssize_t +libssh2_channel_read(LIBSSH2_CHANNEL *channel, + char *buf, size_t buflen); + +ssize_t +libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, + char *buf, size_t buflen); +.fi +.SH DESCRIPTION +Attempt to read data from an active channel stream. All channel streams have +one standard I/O substream (stream_id == 0), and may have up to 2^32 extended +data streams as identified by the selected \fIstream_id\fP. The SSH2 protocol +currently defines a stream ID of 1 to be the stderr substream. + +\fIchannel\fP - active channel stream to read from. + +\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) + +\fIbuf\fP - pointer to storage buffer to read data into + +\fIbuflen\fP - size of the buf storage + +\fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are +macros. +.SH RETURN VALUE +Actual number of bytes read or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. + +Note that a return value of zero (0) can in fact be a legitimate value and +only signals that no payload data was read. It is not an error. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. +.SH SEE ALSO +.BR libssh2_poll_channel_read(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_read_stderr.3 b/miniconda3/share/man/man3/libssh2_channel_read_stderr.3 new file mode 100644 index 0000000000000000000000000000000000000000..25b5ba7240b21199f8bde8568d9722964e92d6c0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_read_stderr.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, + char *buf, size_t buflen); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust.3 b/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust.3 new file mode 100644 index 0000000000000000000000000000000000000000..af0df2e2b6d5c48e5bc86882fcad6a79bf660b1a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_receive_window_adjust - adjust the channel window +.SH SYNOPSIS +.nf +#include + +unsigned long +libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, + unsigned long adjustment, + unsigned char force); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 1.1.0. Use the +\fIlibssh2_channel_receive_window_adjust2(3)\fP function instead! + +Adjust the receive window for a channel by adjustment bytes. If the amount to +be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the +adjustment amount will be queued for a later packet. +.SH RETURN VALUE +Returns the new size of the receive window (as understood by remote end). Note +that the window value sent over the wire is strictly 32bit, but this API is +made to return a 'long' which may not be 32 bit on all platforms. +.SH ERRORS +In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for +non-blocking channels where it would otherwise block. However, that is a +negative number and this function only returns an unsigned value and this then +leads to a very strange value being returned. +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust2.3 b/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust2.3 new file mode 100644 index 0000000000000000000000000000000000000000..730889af1238cbea86e57e44d61e5b7763e173d4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_receive_window_adjust2.3 @@ -0,0 +1,30 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2" +.SH NAME +libssh2_channel_receive_window_adjust2 - adjust the channel window +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel, + unsigned long adjustment, + unsigned char force, + unsigned int *window); +.fi +.SH DESCRIPTION +Adjust the receive window for a channel by adjustment bytes. If the amount to +be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the +adjustment amount will be queued for a later packet. + +This function stores the new size of the receive window (as understood by +remote end) in the variable 'window' points to. +.SH RETURN VALUE +Return 0 on success and a negative value on error. If used in non-blocking +mode it will return LIBSSH2_ERROR_EAGAIN when it would otherwise block. +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 1.1 since the previous API has deficiencies. +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_request_auth_agent.3 b/miniconda3/share/man/man3/libssh2_channel_request_auth_agent.3 new file mode 100644 index 0000000000000000000000000000000000000000..8f9ab62ba4ded7fa17893c49ef349c7e9ed208fa --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_request_auth_agent.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_request_auth_agent - request agent forwarding for a session +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +Request that agent forwarding be enabled for this SSH session. This sends the +request over this specific channel, which causes the agent listener to be +started on the remote side upon success. This agent listener will then run +for the duration of the SSH session. + +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. diff --git a/miniconda3/share/man/man3/libssh2_channel_request_pty.3 b/miniconda3/share/man/man3/libssh2_channel_request_pty.3 new file mode 100644 index 0000000000000000000000000000000000000000..7a3b75eaf1043fdbdd39ad1eec8c0168bbbb2b41 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_request_pty.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_request_pty_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_request_pty_ex.3 b/miniconda3/share/man/man3/libssh2_channel_request_pty_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..30ad750ca04f31d69e1aee93d7878ad18636810d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_request_pty_ex.3 @@ -0,0 +1,54 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_request_pty_ex - short function description +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, + unsigned int term_len, + const char *modes, unsigned int modes_len, + int width, int height, + int width_px, int height_px); + +int +libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term); +.fi +.SH DESCRIPTION +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) + +\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...) + +\fIterm_len\fP - Length of term parameter + +\fImodes\fP - Terminal mode modifier values + +\fImodes_len\fP - Length of modes parameter. + +\fIwidth\fP - Width of pty in characters + +\fIheight\fP - Height of pty in characters + +\fIwidth_px\fP - Width of pty in pixels + +\fIheight_px\fP - Height of pty in pixels + +Request a PTY on an established channel. Note that this does not make sense +for all channel types and may be ignored by the server despite returning +success. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_request_pty_size.3 b/miniconda3/share/man/man3/libssh2_channel_request_pty_size.3 new file mode 100644 index 0000000000000000000000000000000000000000..7de31d612427a61a44a7283b54e84bfc10651add --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_request_pty_size.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, + int width, int height); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_size_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_request_pty_size_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_request_pty_size_ex.3 b/miniconda3/share/man/man3/libssh2_channel_request_pty_size_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..54daf4f5baf3c62d989ec62a81f98124b9d1948c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_request_pty_size_ex.3 @@ -0,0 +1,12 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_request_pty_size_ex 3 "1 Jun 2007" "libssh2" "libssh2" +.SH NAME +libssh2_channel_request_pty_size_ex - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_channel_send_eof.3 b/miniconda3/share/man/man3/libssh2_channel_send_eof.3 new file mode 100644 index 0000000000000000000000000000000000000000..d4bf52e526de56da128163aa081c04e5f4257d1d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_send_eof.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_send_eof - send EOF to remote server +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +Tell the remote host that no further data will be sent on the specified +channel. Processes typically interpret this as a closed stdin descriptor. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. +.SH SEE ALSO +.BR libssh2_channel_wait_eof(3) +.BR libssh2_channel_eof(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_set_blocking.3 b/miniconda3/share/man/man3/libssh2_channel_set_blocking.3 new file mode 100644 index 0000000000000000000000000000000000000000..07a1049aefd12215ef92fc58ce1c28e3c35a5209 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_set_blocking.3 @@ -0,0 +1,27 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_set_blocking - set or clear blocking mode on channel +.SH SYNOPSIS +.nf +#include + +void +libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); +.fi +.SH DESCRIPTION +\fIchannel\fP - channel stream to set or clean blocking status on. + +\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to +make it non-blocking. + +Currently this is a short cut call to +.BR libssh2_session_set_blocking(3) +and therefore will affect the session and all channels. +.SH RETURN VALUE +None +.SH SEE ALSO +.BR libssh2_session_set_blocking(3) +.BR libssh2_channel_read_ex(3) +.BR libssh2_channel_write_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_setenv.3 b/miniconda3/share/man/man3/libssh2_channel_setenv.3 new file mode 100644 index 0000000000000000000000000000000000000000..0fa097b55c3936cf356750de0ab44e2a51706e1c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_setenv.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, + const char *varname, const char *value); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_setenv_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_setenv_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_setenv_ex.3 b/miniconda3/share/man/man3/libssh2_channel_setenv_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..692d9f8ebfcad8a53ae38415f6a79bb438e3d667 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_setenv_ex.3 @@ -0,0 +1,47 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_setenv_ex - set an environment variable on the channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, + char *varname, unsigned int varname_len, + const char *value, unsigned int value_len); + +int +libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, + char *varname, const char *value); +.fi +.SH DESCRIPTION +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) + +\fIvarname\fP - Name of environment variable to set on the remote +channel instance. + +\fIvarname_len\fP - Length of passed varname parameter. + +\fIvalue\fP - Value to set varname to. + +\fIvalue_len\fP - Length of value parameter. + +Set an environment variable in the remote channel's process space. Note that +this does not make sense for all channel types and may be ignored by the +server despite returning success. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_shell.3 b/miniconda3/share/man/man3/libssh2_channel_shell.3 new file mode 100644 index 0000000000000000000000000000000000000000..70ba6d456e18a3d431e10dcf3df84c29b8463c77 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_shell.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_shell(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_signal_ex.3 b/miniconda3/share/man/man3/libssh2_channel_signal_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..aadea41bc7757bd93c7f08b5b67b4c7910c25a78 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_signal_ex.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_signal_ex 3 "20 Apr 2023" "libssh2 1.11.0" "libssh2" +.SH NAME +libssh2_channel_signal_ex -- Send a signal to process previously opened on channel. +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_signal_ex(LIBSSH2_CHANNEL *channel, + const char *signame, + size_t signame_len) +.fi +.SH DESCRIPTION +A signal can be delivered to the remote process/service. Some servers or +systems may not implement signals, in which case they will probably ignore this +message. + +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) + +\fIsigname\fP - The signal name is the same as the signal name constant, without the leading "SIG". + +\fIsigname_len\fP - Length of passed signal name parameter. + +There is also a macro \fIlibssh2_channel_signal(channel, signame)\fP that supplies the strlen of the signame. +.SH RETURN VALUE +Normal channel error codes. +LIBSSH2_ERROR_EAGAIN when it would block. +.SH SEE ALSO +.BR libssh2_channel_get_exit_signal(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_subsystem.3 b/miniconda3/share/man/man3/libssh2_channel_subsystem.3 new file mode 100644 index 0000000000000000000000000000000000000000..31d0b3337c33fc423cfb0b3fc9671c3b9fd1bc6a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_subsystem.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_wait_closed.3 b/miniconda3/share/man/man3/libssh2_channel_wait_closed.3 new file mode 100644 index 0000000000000000000000000000000000000000..7ef058cfecec1f35522a9608f45faae4946b27b5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_wait_closed.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2" +.SH NAME +libssh2_channel_wait_closed - wait for the remote to close the channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +Enter a temporary blocking state until the remote host closes the named +channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to +examine the exit status. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN +when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative +number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_channel_send_eof(3) +.BR libssh2_channel_eof(3) +.BR libssh2_channel_wait_eof(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_wait_eof.3 b/miniconda3/share/man/man3/libssh2_channel_wait_eof.3 new file mode 100644 index 0000000000000000000000000000000000000000..dcd1f5d5b402195a4908a8a01c32590f02af4ca7 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_wait_eof.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_wait_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_wait_eof - wait for the remote to reply to an EOF request +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +Wait for the remote end to send EOF. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_channel_send_eof(3) +.BR libssh2_channel_eof(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_window_read.3 b/miniconda3/share/man/man3/libssh2_channel_window_read.3 new file mode 100644 index 0000000000000000000000000000000000000000..f6218cb65419649547f2b8c12bdcb89b4709efee --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_window_read.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +unsigned long +libssh2_channel_window_read(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_window_read_ex.3 b/miniconda3/share/man/man3/libssh2_channel_window_read_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..3e1eebceaac6e555ba3dcc0d0bf734f70e421aea --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_window_read_ex.3 @@ -0,0 +1,27 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_window_read_ex - Check the status of the read window +.SH SYNOPSIS +.nf +#include + +unsigned long +libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, + unsigned long *read_avail, + unsigned long *window_size_initial) +.fi +.SH DESCRIPTION +Check the status of the read window. Returns the number of bytes which the +remote end may send without overflowing the window limit read_avail (if +passed) will be populated with the number of bytes actually available to be +read window_size_initial (if passed) will be populated with the +window_size_initial as defined by the channel_open request +.SH RETURN VALUE +The number of bytes which the remote end may send without overflowing the +window limit +.SH ERRORS +.SH SEE ALSO +.BR libssh2_channel_receive_window_adjust(3), +.BR libssh2_channel_window_write_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_window_write.3 b/miniconda3/share/man/man3/libssh2_channel_window_write.3 new file mode 100644 index 0000000000000000000000000000000000000000..aa20d02d8512268fb4ddea13ec88d252746329c8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_window_write.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +unsigned long +libssh2_channel_window_write(LIBSSH2_CHANNEL *channel); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_window_write_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_window_write_ex.3 b/miniconda3/share/man/man3/libssh2_channel_window_write_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..7e8ff5fea93f457e1eea118938c492b85bb1cac6 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_window_write_ex.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_window_write_ex - Check the status of the write window +.SH SYNOPSIS +.nf +#include + +unsigned long +libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel, + unsigned long *window_size_initial) +.fi +.SH DESCRIPTION +Check the status of the write window Returns the number of bytes which may be +safely written on the channel without blocking. 'window_size_initial' (if +passed) will be populated with the size of the initial window as defined by +the channel_open request +.SH RETURN VALUE +Number of bytes which may be safely written on the channel without blocking. +.SH ERRORS +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3), +.BR libssh2_channel_receive_window_adjust(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_write.3 b/miniconda3/share/man/man3/libssh2_channel_write.3 new file mode 100644 index 0000000000000000000000000000000000000000..6ced72d929fe4ef035a61a308a23b411676e3cc6 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_write.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_write(LIBSSH2_CHANNEL *channel, + const char *buf, size_t buflen); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_write_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_write_ex.3 b/miniconda3/share/man/man3/libssh2_channel_write_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..934a79c2b93b267726279888c3db510baf47dc6b --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_write_ex.3 @@ -0,0 +1,56 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_write_ex - write data to a channel stream blocking +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, + int stream_id, char *buf, + size_t buflen); +.fi +.SH DESCRIPTION +Write data to a channel stream. All channel streams have one standard I/O +substream (stream_id == 0), and may have up to 2^32 extended data streams as +identified by the selected \fIstream_id\fP. The SSH2 protocol currently +defines a stream ID of 1 to be the stderr substream. + +\fIchannel\fP - active channel stream to write to. + +\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) + +\fIbuf\fP - pointer to buffer to write + +\fIbuflen\fP - size of the data to write + +\fIlibssh2_channel_write(3)\fP and \fIlibssh2_channel_write_stderr(3)\fP are +convenience macros for this function. + +\fIlibssh2_channel_write_ex(3)\fP will use as much as possible of the buffer +and put it into a single SSH protocol packet. This means that to get maximum +performance when sending larger files, you should try to always pass in at +least 32K of data to this function. +.SH RETURN VALUE +Actual number of bytes written or negative on failure. +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. + +\fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be + +\fILIBSSH2_ERROR_BAD_USE\fP - This can be returned if you ignored a previous +return for LIBSSH2_ERROR_EAGAIN and rather than sending the original buffer with +the original size, you sent a new buffer with a different size. + +closed. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) +.BR libssh2_channel_read_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_write_stderr.3 b/miniconda3/share/man/man3/libssh2_channel_write_stderr.3 new file mode 100644 index 0000000000000000000000000000000000000000..832a5c26c50c942f834cc88387ede1eda88a9c51 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_write_stderr.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP +.SH SYNOPSIS +.nf +#include + +ssize_t +libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, + const char *buf, size_t buflen); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_write_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_x11_req.3 b/miniconda3/share/man/man3/libssh2_channel_x11_req.3 new file mode 100644 index 0000000000000000000000000000000000000000..15300a22950ec4a07140fb9e91a6ac06f7a0b5f7 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_x11_req.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_x11_req_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_x11_req_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_channel_x11_req_ex.3 b/miniconda3/share/man/man3/libssh2_channel_x11_req_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..a87e40eeca2beebc366064d157ac1da9dac500a0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_channel_x11_req_ex.3 @@ -0,0 +1,47 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_channel_x11_req_ex - request an X11 forwarding channel +.SH SYNOPSIS +.nf +#include + +int +libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, + const char *auth_proto, const char *auth_cookie, + int screen_number); + +int +libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, + int screen_number); +.fi +.SH DESCRIPTION +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) + +\fIsingle_connection\fP - non-zero to only forward a single connection. + +\fIauth_proto\fP - X11 authentication protocol to use + +\fIauth_cookie\fP - the cookie (hexadecimal encoded). + +\fIscreen_number\fP - the XLL screen to forward + +Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding, +.BR libssh2_session_callback_set2(3) +must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be +invoked when the remote host accepts the X11 forwarding. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) +.BR libssh2_session_callback_set2(3) diff --git a/miniconda3/share/man/man3/libssh2_crypto_engine.3 b/miniconda3/share/man/man3/libssh2_crypto_engine.3 new file mode 100644 index 0000000000000000000000000000000000000000..591a84acf1c4e266f9430cc892ba9d41fed3d2f3 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_crypto_engine.3 @@ -0,0 +1,16 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_crypto_engine 3 "22 Nov 2021" "libssh2" "libssh2" +.SH NAME +libssh2_crypto_engine - retrieve used crypto engine +.SH SYNOPSIS +.nf +#include + +libssh2_crypto_engine_t +libssh2_crypto_engine(void); +.fi +.SH DESCRIPTION +Returns currently used crypto engine, as en enum value. +.SH AVAILABILITY +Added in libssh2 1.11 diff --git a/miniconda3/share/man/man3/libssh2_exit.3 b/miniconda3/share/man/man3/libssh2_exit.3 new file mode 100644 index 0000000000000000000000000000000000000000..cc5f158ff3603e9b10ef303976f23d4e26f07eff --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_exit.3 @@ -0,0 +1,18 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_exit 3 "19 Mar 2010" "libssh2" "libssh2" +.SH NAME +libssh2_exit - global library deinitialization +.SH SYNOPSIS +.nf +#include + +void +libssh2_exit(void); +.fi +.SH DESCRIPTION +Exit the libssh2 functions and frees all memory used internal. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_init(3) diff --git a/miniconda3/share/man/man3/libssh2_free.3 b/miniconda3/share/man/man3/libssh2_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..3aeed4af7ee41e8bc3f8c1ae7b61fb89477b06f3 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_free.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_free 3 "13 Oct 2010" "libssh2" "libssh2" +.SH NAME +libssh2_free - deallocate libssh2 memory +.SH SYNOPSIS +.nf +#include + +void +libssh2_free(LIBSSH2_SESSION *session, void *ptr); +.fi +.SH DESCRIPTION +Deallocate memory allocated by earlier call to libssh2 functions. It +uses the memory allocation callbacks provided by the application, if any. +Otherwise, this will call free(). + +This function is mostly useful under Windows when libssh2 is linked to +one run-time library and the application to another. +.SH AVAILABILITY +Added in libssh2 1.2.8 +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_hostkey_hash.3 b/miniconda3/share/man/man3/libssh2_hostkey_hash.3 new file mode 100644 index 0000000000000000000000000000000000000000..a33edac0487cc93b026815015012b2b708dac8e5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_hostkey_hash.3 @@ -0,0 +1,29 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_hostkey_hash - return a hash of the remote host's key +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIhash_type\fP - One of: \fBLIBSSH2_HOSTKEY_HASH_MD5\fP, +\fBLIBSSH2_HOSTKEY_HASH_SHA1\fP or \fBLIBSSH2_HOSTKEY_HASH_SHA256\fP. + +Returns the computed digest of the remote system's hostkey. The length of +the returned string is hash_type specific (e.g. 16 bytes for MD5, +20 bytes for SHA1, 32 bytes for SHA256). +.SH RETURN VALUE +Computed hostkey hash value, or NULL if the information is not available +(either the session has not yet been started up, or the requested hash +algorithm was not available). The hash consists of raw binary bytes, not hex +digits, so it is not directly printable. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_init.3 b/miniconda3/share/man/man3/libssh2_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..5631d7f79a0883cb202f51fbde15eb9a4ad52b0f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_init.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_init 3 "19 Mar 2010" "libssh2" "libssh2" +.SH NAME +libssh2_init - global library initialization +.SH SYNOPSIS +.nf +#include + +#define LIBSSH2_INIT_NO_CRYPTO 0x0001 + +int +libssh2_init(int flags); +.fi +.SH DESCRIPTION +Initialize the libssh2 functions. This typically initialize the +crypto library. It uses a global state, and is not thread safe -- you +must make sure this function is not called concurrently. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_exit(3) diff --git a/miniconda3/share/man/man3/libssh2_keepalive_config.3 b/miniconda3/share/man/man3/libssh2_keepalive_config.3 new file mode 100644 index 0000000000000000000000000000000000000000..c78053e9bfb01a38cdabcb1518f3b4323fc8744c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_keepalive_config.3 @@ -0,0 +1,29 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_keepalive_config 3 "12 Apr 2011" "libssh2" "libssh2" +.SH NAME +libssh2_keepalive_config - short function description +.SH SYNOPSIS +.nf +#include + +void +libssh2_keepalive_config(LIBSSH2_SESSION *session, + int want_reply, + unsigned int interval); +.fi +.SH DESCRIPTION +Set how often keepalive messages should be sent. \fBwant_reply\fP indicates +whether the keepalive messages should request a response from the server. +\fBinterval\fP is number of seconds that can pass without any I/O, use 0 (the +default) to disable keepalives. To avoid some busy-loop corner-cases, if you +specify an interval of 1 it will be treated as 2. + +Note that non-blocking applications are responsible for sending the keepalive +messages using \fBlibssh2_keepalive_send(3)\fP. +.SH RETURN VALUE +Nothing +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_keepalive_send(3) diff --git a/miniconda3/share/man/man3/libssh2_keepalive_send.3 b/miniconda3/share/man/man3/libssh2_keepalive_send.3 new file mode 100644 index 0000000000000000000000000000000000000000..b660d461479f3a5c7c6328b3d91943a3ded6c595 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_keepalive_send.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2" "libssh2" +.SH NAME +libssh2_keepalive_send - short function description +.SH SYNOPSIS +.nf +#include + +int +libssh2_keepalive_send(LIBSSH2_SESSION *session, + int *seconds_to_next); +.fi +.SH DESCRIPTION +Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many +seconds you can sleep after this call before you need to call it again. +.SH RETURN VALUE +Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_keepalive_config(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_add.3 b/miniconda3/share/man/man3/libssh2_knownhost_add.3 new file mode 100644 index 0000000000000000000000000000000000000000..c881e36f67dfb930bfed945887bbf1618f92c946 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_add.3 @@ -0,0 +1,67 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_add - add a known host +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts, + char *host, char *salt, + char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **store); +.fi +.SH DESCRIPTION +We discourage use of this function as of libssh2 1.2.5. Instead we strongly +urge users to use \fIlibssh2_knownhost_addc(3)\fP instead, which as a more +complete API. \fIlibssh2_knownhost_add(3)\fP is subject for removal in a +future release. + +Adds a known host to the collection of known hosts identified by the 'hosts' +handle. + +\fIhost\fP is a pointer the host name in plain text or hashed. If hashed, it +must be provided base64 encoded. The host name can be the IP numerical address +of the host or the full name. + +\fIsalt\P is a pointer to the salt used for the host hashing, if the host is +provided hashed. If the host is provided in plain text, salt has no meaning. +The salt has to be provided base64 encoded with a trailing zero byte. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or +LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +The key is using one of these algorithms: +LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or +LIBSSH2_KNOWNHOST_KEY_SSHDSS (deprecated). + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data after the addition. NULL can be passed if you do not care about +this pointer. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2, deprecated since libssh2 1.2.5. Use +\fIlibssh2_knownhost_addc(3)\fP instead! +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) +.BR libssh2_knownhost_addc(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_addc.3 b/miniconda3/share/man/man3/libssh2_knownhost_addc.3 new file mode 100644 index 0000000000000000000000000000000000000000..5a1b8c56058ca1203cbffd2a069216bdb6b413c8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_addc.3 @@ -0,0 +1,70 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_addc 3 "28 May 2009" "libssh2 1.2" "libssh2" +.SH NAME +libssh2_knownhost_addc - add a known host +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_addc(LIBSSH2_KNOWNHOSTS *hosts, + char *host, char *salt, + char *key, size_t keylen, + const char *comment, size_t commentlen, + int typemask, + struct libssh2_knownhost **store); +.fi +.SH DESCRIPTION +Adds a known host to the collection of known hosts identified by the 'hosts' +handle. + +\fIhost\fP is a pointer the host name in plain text or hashed. If hashed, it +must be provided base64 encoded. The host name can be the IP numerical address +of the host or the full name. + +If you want to add a key for a specific port number for the given host, you +must provide the host name like '[host]:port' with the actual characters '[' +and ']' enclosing the host name and a colon separating the host part from the +port number. For example: \&"[host.example.com]:222". + +\fIsalt\fP is a pointer to the salt used for the host hashing, if the host is +provided hashed. If the host is provided in plain text, salt has no meaning. +The salt has to be provided base64 encoded with a trailing zero byte. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fIcomment\fP is a pointer to a comment for the key. + +\fIcommentlen\fP is the total size in bytes of the comment pointed to by the \fIcomment\fP argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or +LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +The key is using one of these algorithms: +LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or +LIBSSH2_KNOWNHOST_KEY_SSHDSS (deprecated). + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data after the addition. NULL can be passed if you do not care about +this pointer. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_check.3 b/miniconda3/share/man/man3/libssh2_knownhost_check.3 new file mode 100644 index 0000000000000000000000000000000000000000..37d5c230868c89dd5f2a035bb1246e0024f0efb1 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_check.3 @@ -0,0 +1,60 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_check 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_check - check a host+key against the list of known hosts +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts, + const char *host, + const char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **knownhost); +.fi +.SH DESCRIPTION +Checks a host and its associated key against the collection of known hosts, +and returns info back about the (partially) matched entry. + +\fIhost\fP is a pointer the host name in plain text. The host name can be the +IP numerical address of the host or the full name. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +\fIknownhost\fP if set to non-NULL, it must be a pointer to a 'struct +libssh2_knownhost' pointer that gets filled in to point to info about a known +host that matches or partially matches. +.SH RETURN VALUE +\fIlibssh2_knownhost_check(3)\fP returns info about how well the provided +host + key pair matched one of the entries in the list of known hosts. + +LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made + +LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found + +LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. + +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys did not match! +.SH AVAILABILITY +Added in libssh2 1.2 +.SH EXAMPLE +See the ssh2_exec.c example as provided in the tarball. +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_checkp.3 b/miniconda3/share/man/man3/libssh2_knownhost_checkp.3 new file mode 100644 index 0000000000000000000000000000000000000000..de60390993b8a497a046f3e57d4ae6bfc983f4c2 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_checkp.3 @@ -0,0 +1,65 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_checkp 3 "1 May 2010" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_checkp - check a host+key against the list of known hosts +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_checkp(LIBSSH2_KNOWNHOSTS *hosts, + const char *host, int port, + const char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **knownhost); +.fi +.SH DESCRIPTION +Checks a host and its associated key against the collection of known hosts, +and returns info back about the (partially) matched entry. + +\fIhost\fP is a pointer the host name in plain text. The host name can be the +IP numerical address of the host or the full name. + +\fIport\fP is the port number used by the host (or a negative number +to check the generic host). If the port number is given, libssh2 will +check the key for the specific host + port number combination in +addition to the plain host name only check. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +\fIknownhost\fP if set to non-NULL, it must be a pointer to a 'struct +libssh2_knownhost' pointer that gets filled in to point to info about a known +host that matches or partially matches. +.SH RETURN VALUE +\fIlibssh2_knownhost_check(3)\fP returns info about how well the provided +host + key pair matched one of the entries in the list of known hosts. + +LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made + +LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found + +LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. + +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys did not match! +.SH AVAILABILITY +Added in libssh2 1.2.6 +.SH EXAMPLE +See the ssh2_exec.c example as provided in the tarball. +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_del.3 b/miniconda3/share/man/man3/libssh2_knownhost_del.3 new file mode 100644 index 0000000000000000000000000000000000000000..9efc4c67093f203e71629aaa88167a6e2359b1cb --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_del.3 @@ -0,0 +1,28 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_del 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_del - delete a known host entry +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost *entry); +.fi +.SH DESCRIPTION +Delete a known host entry from the collection of known hosts. + +\fIentry\fP is a pointer to a struct that you can extract with +\fIlibssh2_knownhost_check(3)\fP or \fIlibssh2_knownhost_get(3)\fP. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_free.3 b/miniconda3/share/man/man3/libssh2_knownhost_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..f9e173445d59ad1bc3ebb25d74d663298311c9a8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_free.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_free 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_free - free a collection of known hosts +.SH SYNOPSIS +.nf +#include + +void +libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts); +.fi +.SH DESCRIPTION +Free a collection of known hosts. +.SH RETURN VALUE +None. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_get.3 b/miniconda3/share/man/man3/libssh2_knownhost_get.3 new file mode 100644 index 0000000000000000000000000000000000000000..318a7fc4547a4d04394bf3f1c03e1fb5b7ccd328 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_get.3 @@ -0,0 +1,37 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_get 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_get - get a known host off the collection of known hosts +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost **store, + struct libssh2_knownhost *prev): +.fi +.SH DESCRIPTION +\fIlibssh2_knownhost_get(3)\fP allows an application to iterate over all known +hosts in the collection. + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data. + +\fIprev\fP is a pointer to a previous 'struct libssh2_knownhost' as returned +by a previous invoke of this function, or NULL to get the first entry in the +internal collection. +.SH RETURN VALUE +Returns 0 if everything is fine and information about a host was stored in +the \fIstore\fP struct. + +Returns 1 if it reached the end of hosts. + +Returns negative values for error +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_readfile(3) +.BR libssh2_knownhost_writefile(3) +.BR libssh2_knownhost_add(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_init.3 b/miniconda3/share/man/man3/libssh2_knownhost_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..95b7c62efffd42bf4195b435cc9e1a5e30b2d51f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_init.3 @@ -0,0 +1,27 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_init 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_init - init a collection of known hosts +.SH SYNOPSIS +.nf +#include + +LIBSSH2_KNOWNHOSTS * +libssh2_knownhost_init(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Init a collection of known hosts for this session. Returns the handle to an +internal representation of a known host collection. + +Call \fBlibssh2_knownhost_free(3)\fP to free the collection again after you are +doing using it. +.SH RETURN VALUE +Returns a handle pointer or NULL if something went wrong. The returned handle +is used as input to all other known host related functions libssh2 provides. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_readfile.3 b/miniconda3/share/man/man3/libssh2_knownhost_readfile.3 new file mode 100644 index 0000000000000000000000000000000000000000..c5a46970882bdb76ee5579bde04dd5b66752f44c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_readfile.3 @@ -0,0 +1,31 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_readfile 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_readfile - parse a file of known hosts +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts, + const char *filename, int type); +.fi +.SH DESCRIPTION +Reads a collection of known hosts from a specified file and adds them to the +collection of known hosts. + +\fIfilename\fP specifies which file to read + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. This file is normally found named ~/.ssh/known_hosts +.SH RETURN VALUE +Returns a negative value, a regular libssh2 error code for errors, or a +positive number as number of parsed known hosts in the file. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_readline.3 b/miniconda3/share/man/man3/libssh2_knownhost_readline.3 new file mode 100644 index 0000000000000000000000000000000000000000..2418494247817ce96390abb8a3c85852188694a8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_readline.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_readline - read a known host line +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts, + const char *line, size_t len, int type): +.fi +.SH DESCRIPTION +Tell libssh2 to read a buffer as it if is a line from a known hosts file. + +\fIline\fP points to the start of the line + +\fIlen\fP is the length of the line in bytes + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. This file is normally found named ~/.ssh/known_hosts +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_get(3) +.BR libssh2_knownhost_writeline(3) +.BR libssh2_knownhost_readfile(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_writefile.3 b/miniconda3/share/man/man3/libssh2_knownhost_writefile.3 new file mode 100644 index 0000000000000000000000000000000000000000..2e2b0a2fc6ab6a68cb1b1186268ea958e5c568d8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_writefile.3 @@ -0,0 +1,30 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_writefile 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_writefile - write a collection of known hosts to a file +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts, + const char *filename, int type); +.fi +.SH DESCRIPTION +Writes all the known hosts to the specified file using the specified file +format. + +\fIfilename\fP specifies what filename to create + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_readfile(3) +.BR libssh2_knownhost_add(3) diff --git a/miniconda3/share/man/man3/libssh2_knownhost_writeline.3 b/miniconda3/share/man/man3/libssh2_knownhost_writeline.3 new file mode 100644 index 0000000000000000000000000000000000000000..03023f7246f4dbd99449f554391269f08fb6ca66 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_knownhost_writeline.3 @@ -0,0 +1,47 @@ +.\" Copyright (C) Daniel Stenberg +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2" "libssh2" +.SH NAME +libssh2_knownhost_writeline - convert a known host to a line for storage +.SH SYNOPSIS +.nf +#include + +int +libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost *known, + char *buffer, size_t buflen, + size_t *outlen, + int type); +.fi +.SH DESCRIPTION +Converts a single known host to a single line of output for storage, using +the 'type' output format. + +\fIknown\fP identifies which particular known host + +\fIbuffer\fP points to an allocated buffer + +\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size. + +\fIoutlen\fP must be a pointer to a size_t variable that will get the output +length of the stored data chunk. The number does not included the trailing +zero! + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. + +If the provided buffer is deemed too small to fit the data libssh2 wants to +store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be returned. The application +is then advised to call the function again with a larger buffer. The +\fIoutlen\fP size will then hold the requested size. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_get(3) +.BR libssh2_knownhost_readline(3) +.BR libssh2_knownhost_writefile(3) diff --git a/miniconda3/share/man/man3/libssh2_poll.3 b/miniconda3/share/man/man3/libssh2_poll.3 new file mode 100644 index 0000000000000000000000000000000000000000..7bda2f2a9575139ca242026c00e3bcf5097d1ffe --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_poll.3 @@ -0,0 +1,26 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_poll - poll for activity on a socket, channel or listener +.SH SYNOPSIS +.nf +#include + +int +libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); +.fi +.SH DESCRIPTION +This function is deprecated. Do note use. We encourage users to instead use +the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or +when specific sockets are ready to get received from or send to. + +Poll for activity on a socket, channel, listener, or any combination of these +three types. The calling semantics for this function generally match +\fIpoll(2)\fP however the structure of fds is somewhat more complex in order +to accommodate the disparate datatypes, POLLFD constants have been namespaced +to avoid platform discrepancies, and revents has additional values defined. +.SH "RETURN VALUE" +Number of fds with interesting events. +.SH SEE ALSO +.BR libssh2_poll_channel_read(3) diff --git a/miniconda3/share/man/man3/libssh2_poll_channel_read.3 b/miniconda3/share/man/man3/libssh2_poll_channel_read.3 new file mode 100644 index 0000000000000000000000000000000000000000..9878c3b1d2a8608fcc07452bb17f2bbd0d6fdc55 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_poll_channel_read.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_poll_channel_read - check if data is available +.SH SYNOPSIS +.nf +#include + +int +libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); +.fi +.SH DESCRIPTION +This function is deprecated. Do note use. + +\fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the +\fIchannel\fP's read buffer. No attempt is made with this method to see if +packets are available to be processed. For full polling support, use +\fIlibssh2_poll(3)\fP. +.SH RETURN VALUE +Returns 1 when data is available and 0 otherwise. +.SH SEE ALSO +.BR libssh2_poll(3) diff --git a/miniconda3/share/man/man3/libssh2_publickey_add.3 b/miniconda3/share/man/man3/libssh2_publickey_add.3 new file mode 100644 index 0000000000000000000000000000000000000000..75abb1152235a134f55b79467df990047b19d713 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_add.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, + const unsigned char *blob, unsigned long blob_len, + char overwrite, unsigned long num_attrs, + const libssh2_publickey_attribute attrs[]); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_add_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_add_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_add_ex(3)\fP +.SH SEE ALSO +.BR libssh2_publickey_add_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_publickey_add_ex.3 b/miniconda3/share/man/man3/libssh2_publickey_add_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..2446915bb495f065f0c2768e2c40efed7ab6edcc --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_add_ex.3 @@ -0,0 +1,28 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2" "libssh2" +.SH NAME +libssh2_publickey_add_ex - Add a public key entry +.SH SYNOPSIS +.nf +#include + +int +libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, unsigned long name_len, + const unsigned char *blob, unsigned long blob_len, + char overwrite, unsigned long num_attrs, + const libssh2_publickey_attribute attrs[]) +.fi +.SH DESCRIPTION +TBD +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +LIBSSH2_ERROR_BAD_USE +LIBSSH2_ERROR_ALLOC, +LIBSSH2_ERROR_EAGAIN +LIBSSH2_ERROR_SOCKET_SEND, +LIBSSH2_ERROR_SOCKET_TIMEOUT, +LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_publickey_init.3 b/miniconda3/share/man/man3/libssh2_publickey_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..6703ebe33c3243c6dd494dafce0b177e984998b8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_init.3 @@ -0,0 +1,14 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_init 3 "1 Jun 2007" "libssh2" "libssh2" +.SH NAME +libssh2_publickey_init - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 ?.?.? +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_publickey_list_fetch.3 b/miniconda3/share/man/man3/libssh2_publickey_list_fetch.3 new file mode 100644 index 0000000000000000000000000000000000000000..aa23b7c5a6fb4d09e6b78639ec22a4547715241c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_list_fetch.3 @@ -0,0 +1,14 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_list_fetch 3 "1 Jun 2007" "libssh2" "libssh2" +.SH NAME +libssh2_publickey_list_fetch - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 ?.?.? +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_publickey_list_free.3 b/miniconda3/share/man/man3/libssh2_publickey_list_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..17c15304cb72c8c91987753eba65f2ea93d276c9 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_list_free.3 @@ -0,0 +1,14 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_list_free 3 "1 Jun 2007" "libssh2" "libssh2" +.SH NAME +libssh2_publickey_list_free - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 ?.?.? +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_publickey_remove.3 b/miniconda3/share/man/man3/libssh2_publickey_remove.3 new file mode 100644 index 0000000000000000000000000000000000000000..a07c9b2baa82efa79bdd05a7f3a97da59564722c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_remove.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, unsigned long name_len, + const unsigned char *blob, unsigned long blob_len); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_remove_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH SEE ALSO +.BR libssh2_publickey_remove_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_publickey_remove_ex.3 b/miniconda3/share/man/man3/libssh2_publickey_remove_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..8a2ce834b232a0f8f5da304a55dae007689f2d8a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_remove_ex.3 @@ -0,0 +1,14 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_list_remove_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_publickey_list_remove_ex - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 ?.?.? +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_publickey_shutdown.3 b/miniconda3/share/man/man3/libssh2_publickey_shutdown.3 new file mode 100644 index 0000000000000000000000000000000000000000..6ad8019689eb1bacd5733f35d91b77893402ac56 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_publickey_shutdown.3 @@ -0,0 +1,14 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_publickey_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_publickey_shutdown - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 ?.?.? +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_scp_recv.3 b/miniconda3/share/man/man3/libssh2_scp_recv.3 new file mode 100644 index 0000000000000000000000000000000000000000..93bcee86aecbc22bc5e375e750dded9d3e37cf58 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_scp_recv.3 @@ -0,0 +1,37 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_scp_recv - request a remote file via SCP +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 1.7.0. Use the +\fIlibssh2_scp_recv2(3)\fP function instead! + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer. That is the remote +file name. + +\fIsb\fP - Populated with remote file's size, mode, mtime, and atime + +Request a file from the remote host via SCP. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_scp_recv2.3 b/miniconda3/share/man/man3/libssh2_scp_recv2.3 new file mode 100644 index 0000000000000000000000000000000000000000..c3a27c2c2f72b96651691d1b85d936f3946f1f7c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_scp_recv2.3 @@ -0,0 +1,34 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_scp_recv2 3 "29 Jun 2015" "libssh2 1.6.1" "libssh2" +.SH NAME +libssh2_scp_recv2 - request a remote file via SCP +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_scp_recv2(LIBSSH2_SESSION *session, const char *path, struct_stat *sb); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer. That is the remote +file name. + +\fIsb\fP - Populated with remote file's size, mode, mtime, and atime + +Request a file from the remote host via SCP. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_scp_send.3 b/miniconda3/share/man/man3/libssh2_scp_send.3 new file mode 100644 index 0000000000000000000000000000000000000000..128a24c6a33fd2ec36d0064586c71646896fd776 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_scp_send.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, + int mode, size_t size); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_scp_send_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_scp_send_ex(3)\fP +.SH ERRORS +See \fIlibssh2_scp_send_ex(3)\fP +.SH SEE ALSO +.BR libssh2_scp_send_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_scp_send64.3 b/miniconda3/share/man/man3/libssh2_scp_send64.3 new file mode 100644 index 0000000000000000000000000000000000000000..6561103716b369bd6d20fe6876465843d5533bb1 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_scp_send64.3 @@ -0,0 +1,50 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2" +.SH NAME +libssh2_scp_send64 - Send a file via SCP +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, + libssh2_uint64_t size, time_t mtime, time_t atime); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer to. That is the remote +file name. + +\fImode\fP - File access mode to create file with + +\fIsize\fP - Size of file being transmitted (Must be known ahead of +time). Note that this needs to be passed on as variable type +libssh2_uint64_t. This type is 64 bit on modern operating systems and +compilers. + +\fImtime\fP - mtime to assign to file being created + +\fIatime\fP - atime to assign to file being created (Set this and +mtime to zero to instruct remote host to use current time). + +Send a file to the remote host via SCP. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH AVAILABILITY +This function was added in libssh2 1.2.6 and is meant to replace the former +\fIlibssh2_scp_send_ex(3)\fP function. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_scp_send_ex.3 b/miniconda3/share/man/man3/libssh2_scp_send_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..cc3a723efad7ce38f65ec95d2db1756c2ccee14f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_scp_send_ex.3 @@ -0,0 +1,51 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_scp_send_ex - Send a file via SCP +.SH SYNOPSIS +.nf +#include + +LIBSSH2_CHANNEL * +libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, + size_t size, long mtime, long atime); +.fi +.SH DESCRIPTION +This function has been deemed deprecated since libssh2 1.2.6. See +\fIlibssh2_scp_send64(3)\fP. + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer to. That is the remote +file name. + +\fImode\fP - File access mode to create file with + +\fIsize\fP - Size of file being transmitted (Must be known +ahead of time precisely) + +\fImtime\fP - mtime to assign to file being created + +\fIatime\fP - atime to assign to file being created (Set this and +mtime to zero to instruct remote host to use current time). + +Send a file to the remote host via SCP. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH AVAILABILITY +This function was marked deprecated in libssh2 1.2.6 as + \fIlibssh2_scp_send64(3)\fP has been introduced to replace this function. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_abstract.3 b/miniconda3/share/man/man3/libssh2_session_abstract.3 new file mode 100644 index 0000000000000000000000000000000000000000..09f0e4de8033f9541d30912f3b7e6a298b649162 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_abstract.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_abstract 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_abstract - return a pointer to a session's abstract pointer +.SH SYNOPSIS +.nf +#include + +void ** +libssh2_session_abstract(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Return a pointer to where the abstract pointer provided to +\fBlibssh2_session_init_ex(3)\fP is stored. By providing a doubly +de-referenced pointer, the internal storage of the session instance may be +modified in place. +.SH RETURN VALUE +A pointer to session internal storage whose contents point to previously +provided abstract data. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_banner_get.3 b/miniconda3/share/man/man3/libssh2_session_banner_get.3 new file mode 100644 index 0000000000000000000000000000000000000000..88f23995e2cb8013bc0c05e11138fe10d770e16d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_banner_get.3 @@ -0,0 +1,26 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2" "libssh2" +.SH NAME +libssh2_session_banner_get - get the remote banner +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_session_banner_get(oLIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has +completed successfully, this function can be used to get the server id from +the banner each server presents. +.SH RETURN VALUE +A pointer to a string or NULL if something failed. The data pointed to will be +allocated and associated to the session handle and will be freed by libssh2 +when \fIlibssh2_session_free(3)\fP is used. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_session_banner_set(3), +.BR libssh2_session_handshake(3), +.BR libssh2_session_free(3) diff --git a/miniconda3/share/man/man3/libssh2_session_banner_set.3 b/miniconda3/share/man/man3/libssh2_session_banner_set.3 new file mode 100644 index 0000000000000000000000000000000000000000..037a4d6ab4812a3b6c56af9efa3ee1e90fc76843 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_banner_set.3 @@ -0,0 +1,35 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2" "libssh2" +.SH NAME +libssh2_session_banner_set - set the SSH protocol banner for the local client +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - A pointer to a zero-terminated string holding the user defined +banner + +Set the banner that will be sent to the remote host when the SSH session is +started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner +corresponding to the protocol and libssh2 version will be sent by default. +.SH RETURN VALUE +Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN +when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative +number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. +.SH AVAILABILITY +Added in 1.4.0. + +Before 1.4.0 this function was known as libssh2_banner_set(3) +.SH SEE ALSO +.BR libssh2_session_handshake(3), +.BR libssh2_session_banner_get(3) diff --git a/miniconda3/share/man/man3/libssh2_session_block_directions.3 b/miniconda3/share/man/man3/libssh2_session_block_directions.3 new file mode 100644 index 0000000000000000000000000000000000000000..106de22155a4a19fc5c6dbbe25b9bfd6267a01ec --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_block_directions.3 @@ -0,0 +1,33 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2" "libssh2" +.SH NAME +libssh2_session_block_directions - get directions to wait for +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_block_directions(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP + +When any of libssh2 functions return \fBLIBSSH2_ERROR_EAGAIN\fP an application +should wait for the socket to have data available for reading or +writing. Depending on the return value of +\fIlibssh2_session_block_directions(3)\fP an application should wait for read, +write or both. +.SH RETURN VALUE +Returns the set of directions as a binary mask. Can be a combination of: + +LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked. + +LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked. + +Application should wait for data to be available for socket prior to calling a +libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select +should contain the session socket in readfds set. Correspondingly in case of +\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket. +.SH AVAILABILITY +Added in 1.0 diff --git a/miniconda3/share/man/man3/libssh2_session_callback_set.3 b/miniconda3/share/man/man3/libssh2_session_callback_set.3 new file mode 100644 index 0000000000000000000000000000000000000000..70c94c13b4af609d518e2de807dc8d6559259290 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_callback_set.3 @@ -0,0 +1,31 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_callback_set - set a callback function +.SH SYNOPSIS +.nf +#include + +void * +libssh2_session_callback_set(LIBSSH2_SESSION *session, + int cbtype, void *callback); +.fi +.SH DESCRIPTION +This function is \fBDEPRECATED\fP in 1.11.1. Use the +\fIlibssh2_session_callback_set2(3)\fP function instead! + +This implementation is expecting and returning a data pointer for callback +functions. + +For the details about the replacement function, see +.BR libssh2_session_callback_set2(3) +which is expecting and returning a function pointer. + +.SH RETURN VALUE +Pointer to previous callback handler. Returns NULL if no prior callback +handler was set or the callback type was unknown. +.SH SEE ALSO +.BR libssh2_session_callback_set2(3) +.BR libssh2_session_init_ex(3) +.BR libssh2_agent_sign(3) diff --git a/miniconda3/share/man/man3/libssh2_session_callback_set2.3 b/miniconda3/share/man/man3/libssh2_session_callback_set2.3 new file mode 100644 index 0000000000000000000000000000000000000000..ee55af9426ad1885c2337cab0b8de0b22baf2170 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_callback_set2.3 @@ -0,0 +1,139 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_callback_set2 3 "13 Dec 2023" "libssh2 1.11.1" "libssh2" +.SH NAME +libssh2_session_callback_set2 - set a callback function +.SH SYNOPSIS +.nf +#include + +libssh2_cb_generic * +libssh2_session_callback_set2(LIBSSH2_SESSION *session, int cbtype, + libssh2_cb_generic *callback); +.fi +.SH DESCRIPTION +Sets a custom callback handler for a previously initialized session +object. Callbacks are triggered by the receipt of special packets at the +Transport layer. To disable a callback, set it to NULL. + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIcbtype\fP - Callback type. One of the types listed in Callback Types. + +\fIcallback\fP - Pointer to custom callback function. The prototype for +this function must match the associated callback declaration macro. +.SH CALLBACK TYPES +.IP LIBSSH2_CALLBACK_IGNORE +Called when a SSH_MSG_IGNORE message is received +.IP LIBSSH2_CALLBACK_DEBUG +Called when a SSH_MSG_DEBUG message is received +.IP LIBSSH2_CALLBACK_DISCONNECT +Called when a SSH_MSG_DISCONNECT message is received +.IP LIBSSH2_CALLBACK_MACERROR +Called when a mismatched MAC has been detected in the transport layer. If the +function returns 0, the packet will be accepted nonetheless. +.IP LIBSSH2_CALLBACK_X11 +Called when an X11 connection has been accepted +.IP LIBSSH2_CALLBACK_SEND +Called when libssh2 wants to send data on the connection. Can be set to a +custom function to handle I/O your own way. + +The prototype of the callback: + +.nf +ssize_t sendcb(libssh2_socket_t sockfd, const void *buffer, + size_t length, int flags, void **abstract); +.fi + +\fBsockfd\fP is the socket to write to, \fBbuffer\fP points to the data to +send, \fBlength\fP is the size of the data, \fBflags\fP is the flags that +would have been used to a \fIsend()\fP call and \fBabstract\fP is a pointer +to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call. + +The callback returns the number of bytes sent, or \-1 for error. The special +return code \fB-EAGAIN\fP can be returned to signal that the send was aborted +to prevent getting blocked and it needs to be called again. +.IP LIBSSH2_CALLBACK_RECV +Called when libssh2 wants to read data from the connection. Can be set to a +custom function to handle I/O your own way. + +The prototype of the callback: + +.nf +ssize_t recvcb(libssh2_socket_t sockfd, void *buffer, + size_t length, int flags, void **abstract); +.fi + +\fBsockfd\fP is the socket to read from, \fBbuffer\fP where to store received +data into, \fBlength\fP is the size of the buffer, \fBflags\fP is the flags +that would have been used to a \fIrecv()\fP call and \fBabstract\fP is a pointer +to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call. + +The callback returns the number of bytes read, or \-1 for error. The special +return code \fB-EAGAIN\fP can be returned to signal that the read was aborted +to prevent getting blocked and it needs to be called again. +.IP LIBSSH2_CALLBACK_AUTHAGENT +Called during authentication process to allow the client to connect to the +ssh-agent and perform any setup, such as configuring the agent or adding keys. + +The prototype of the callback: + +.nf +void authagent(LIBSSH2_SESSION* session, LIBSSH2_CHANNEL *channel, + void **abstract); +.fi +.IP LIBSSH2_CALLBACK_AUTHAGENT_IDENTITIES +Not called by libssh2. The client is responsible for calling this method when +a SSH2_AGENTC_REQUEST_IDENTITIES message has been received. + +The prototype of the callback: + +.nf +void identities(LIBSSH2_SESSION* session, void *buffer, + const char *agent_path, + void **abstract) +.fi + +\fBbuffer\fP must be filled in by the callback. Different clients may implement +this differently. For example, one client may pass in an unsigned char ** for +this parameter, while another may pass in a pointer to a struct. + +Regardless of the type of buffer used, the client will need to send back a list +of identities in the following format. + +uint32 buffer length +uint32 number of entries +entries + +Where each entry in the entries list is of the format: + +string data +cstring comment + +\fBagent_path\fP The path to a running ssh-agent on the client machine, from +which identities can be listed. +.IP LIBSSH2_CALLBACK_AUTHAGENT_SIGN +Not called by libssh2. The client is responsible for calling this method when +a SSH2_AGENTC_SIGN_REQUEST message has been received. + +The prototype of the callback: + +.nf +void sign(LIBSSH2_SESSION* session, + unsigned char *blob, unsigned int blen, + const unsigned char *data, unsigned int dlen, + unsigned char **sig, unsigned int *sig_len, + const char *agent_path, + void **abstract); +.fi + +When interfacing with an ssh-agent installed on the client system, this method +can call libssh2_agent_sign(3) to perform signing. + +.SH RETURN VALUE +Pointer to previous callback handler. Returns NULL if no prior callback +handler was set or the callback type was unknown. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_agent_sign(3) diff --git a/miniconda3/share/man/man3/libssh2_session_disconnect.3 b/miniconda3/share/man/man3/libssh2_session_disconnect.3 new file mode 100644 index 0000000000000000000000000000000000000000..85e141998acbf01f360524364936c79ecf5d071a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_disconnect.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_disconnect_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH SEE ALSO +.BR libssh2_session_disconnect_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_disconnect_ex.3 b/miniconda3/share/man/man3/libssh2_session_disconnect_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..b1674eb62a0ea41e6bf60b8502e9a99578191d53 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_disconnect_ex.3 @@ -0,0 +1,43 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_disconnect_ex - terminate transport layer +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, + const char *description, + const char *lang); + +int +libssh2_session_disconnect(LIBSSH2_SESSION *session, + const char *description); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIreason\fP - One of the Disconnect Reason constants. + +\fIdescription\fP - Human readable reason for disconnection. + +\fIlang\fP - Localization string describing the language/encoding of the description provided. + +Send a disconnect message to the remote host associated with \fIsession\fP, +along with a \fIreason\fP symbol and a verbose \fIdescription\fP. + +As a convenience, the macro +.BR libssh2_session_disconnect(3) +is provided. It calls +.BR libssh2_session_disconnect_ex(3) +with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION +and \fIlang\fP set to an empty string. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_flag.3 b/miniconda3/share/man/man3/libssh2_session_flag.3 new file mode 100644 index 0000000000000000000000000000000000000000..b8e8fec8a5a17d3b26f6ead0f37898a9314366ee --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_flag.3 @@ -0,0 +1,29 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_flag - TODO +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value); +.fi +.SH DESCRIPTION +Set options for the created session. \fIflag\fP is the option to set, while +\fIvalue\fP is typically set to 1 or 0 to enable or disable the option. +.SH FLAGS +.IP LIBSSH2_FLAG_SIGPIPE +If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger +from the underlying socket layer. +.IP LIBSSH2_FLAG_COMPRESS +If set - before the connection negotiation is performed - libssh2 will try to +negotiate compression enabling for this connection. By default libssh2 will +not attempt to use compression. +.SH RETURN VALUE +Returns regular libssh2 error code. +.SH AVAILABILITY +This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was +added in version 1.2.8. +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_session_free.3 b/miniconda3/share/man/man3/libssh2_session_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..618653ac2cdf4d805a44c30bbefc28a922c8beab --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_free.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_free - frees resources associated with a session instance +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_free(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Frees all resources associated with a session instance. Typically called after +.BR libssh2_session_disconnect_ex(3) +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_session_disconnect_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_get_blocking.3 b/miniconda3/share/man/man3/libssh2_session_get_blocking.3 new file mode 100644 index 0000000000000000000000000000000000000000..2d3b793ec3881b8353e3cde492c56bfaf3a82f31 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_get_blocking.3 @@ -0,0 +1,19 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_get_blocking - evaluate blocking mode on session +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_get_blocking(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Returns 0 if the state of the session has previously be set to non-blocking +and it returns 1 if the state was set to blocking. +.SH RETURN VALUE +See description. +.SH SEE ALSO +.BR libssh2_session_set_blocking(3) diff --git a/miniconda3/share/man/man3/libssh2_session_get_read_timeout.3 b/miniconda3/share/man/man3/libssh2_session_get_read_timeout.3 new file mode 100644 index 0000000000000000000000000000000000000000..81b0cb1fcf45a2b2dbe452c784e9e7b99fe39156 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_get_read_timeout.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_get_read_timeout 3 "13 Jan 2023" "libssh2" "libssh2" +.SH NAME +libssh2_session_get_read_timeout - get the timeout for packet read functions +.SH SYNOPSIS +.nf +#include + +long +libssh2_session_get_read_timeout(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Returns the \fBtimeout\fP (in seconds) for how long the ssh2 packet receive +function calls may wait until they consider the situation an error and +return LIBSSH2_ERROR_TIMEOUT. + +By default the timeout is 60 seconds. +.SH RETURN VALUE +The value of the timeout setting. +.SH AVAILABILITY +Added in 1.10.1 +.SH SEE ALSO +.BR libssh2_session_set_read_timeout(3) diff --git a/miniconda3/share/man/man3/libssh2_session_get_timeout.3 b/miniconda3/share/man/man3/libssh2_session_get_timeout.3 new file mode 100644 index 0000000000000000000000000000000000000000..4a57cedf482c77d688f19cbf1b2ca0a0e4de2c63 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_get_timeout.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2" "libssh2" +.SH NAME +libssh2_session_get_timeout - get the timeout for blocking functions +.SH SYNOPSIS +.nf +#include + +long +libssh2_session_get_timeout(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the +libssh2 function calls may wait until they consider the situation an error and +return LIBSSH2_ERROR_TIMEOUT. + +By default libssh2 has no timeout (zero) for blocking functions. +.SH RETURN VALUE +The value of the timeout setting. +.SH AVAILABILITY +Added in 1.2.9 +.SH SEE ALSO +.BR libssh2_session_set_timeout(3) diff --git a/miniconda3/share/man/man3/libssh2_session_handshake.3 b/miniconda3/share/man/man3/libssh2_session_handshake.3 new file mode 100644 index 0000000000000000000000000000000000000000..4d5cc51172e10af13432d21b26e950d88de9151b --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_handshake.3 @@ -0,0 +1,44 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2" "libssh2" +.SH NAME +libssh2_session_handshake - perform the SSH handshake +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_handshake(LIBSSH2_SESSION *session, libssh2_socket_t socket); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIsocket\fP - Connected socket descriptor. Typically a TCP connection +though the protocol allows for any reliable transport and the library will +attempt to use any berkeley socket. + +Begin transport layer protocol negotiation with the connected host. +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid. + +\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host. + +\fILIBSSH2_ERROR_KEX_FAILURE\fP - Encryption key exchange with the remote +host failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected. + +\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on +the socket. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH AVAILABILITY +Added in 1.2.8 +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_hostkey.3 b/miniconda3/share/man/man3/libssh2_session_hostkey.3 new file mode 100644 index 0000000000000000000000000000000000000000..4190843d810b13e69ac0e949363b90c4cdc940b8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_hostkey.3 @@ -0,0 +1,26 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_hostkey - get the remote key +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_session_hostkey(LIBSSH2_SESSION *session, + size_t *len, int *type); +.fi +.SH DESCRIPTION +Returns a pointer to the current host key, the value \fIlen\fP points to will +get the length of the key. + +The value \fItype\fP points to the type of hostkey which is one of: +LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS (deprecated), or +LIBSSH2_HOSTKEY_TYPE_UNKNOWN. + +.SH RETURN VALUE +A pointer, or NULL if something went wrong. +.SH SEE ALSO +.BR libssh2_knownhost_check(3) +.BR libssh2_knownhost_add(3) diff --git a/miniconda3/share/man/man3/libssh2_session_init.3 b/miniconda3/share/man/man3/libssh2_session_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..88f1fa8cc18eaf38f846f6a717de42eeb7bd0c21 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_init.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +LIBSSH2_SESSION * +libssh2_session_init(void); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_init_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_init_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_init_ex(3)\fP +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_init_ex.3 b/miniconda3/share/man/man3/libssh2_session_init_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..3a79e7864e5e6c81760cbb4d90202bf683783190 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_init_ex.3 @@ -0,0 +1,48 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_init_ex - initializes an SSH session object +.SH SYNOPSIS +.nf +#include + +LIBSSH2_SESSION * +libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)), + LIBSSH2_FREE_FUNC((*myfree)), + LIBSSH2_REALLOC_FUNC((*myrealloc)), + void *abstract); + +LIBSSH2_SESSION * +libssh2_session_init(void); +.fi +.SH DESCRIPTION +\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks +for implementing an allocator callback. Pass a value of NULL to use the +default system allocator. + +\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks +for implementing a deallocator callback. Pass a value of NULL to use the +default system deallocator. + +\fImyrealloc\fP - Custom re-allocator function. Refer to the section on +Callbacks for implementing a reallocator callback. Pass a value of NULL to +use the default system reallocator. + +\fIabstract\fP - Arbitrary pointer to application specific callback data. +This value will be passed to any callback function associated with the named +session instance. + +Initializes an SSH session object. By default system memory allocators +(malloc(), free(), realloc()) will be used for any dynamically allocated memory +blocks. Alternate memory allocation functions may be specified using the +extended version of this API call, and/or optional application specific data +may be attached to the session object. + +This method must be called first, prior to configuring session options or +starting up an SSH session with a remote server. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors. +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_handshake(3) diff --git a/miniconda3/share/man/man3/libssh2_session_last_errno.3 b/miniconda3/share/man/man3/libssh2_session_last_errno.3 new file mode 100644 index 0000000000000000000000000000000000000000..029f49c28a641aea47e035403dec5069c995af9c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_last_errno.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_last_errno 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_last_errno - get the most recent error number +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_last_errno(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Determine the most recent error condition. +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. +.SH SEE ALSO +.BR libssh2_session_last_error(3) +.BR libssh2_session_set_last_error(3) diff --git a/miniconda3/share/man/man3/libssh2_session_last_error.3 b/miniconda3/share/man/man3/libssh2_session_last_error.3 new file mode 100644 index 0000000000000000000000000000000000000000..f11d65ff9b67f7a3245cd11438bc1fc17f3e1500 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_last_error.3 @@ -0,0 +1,34 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_last_error - get the most recent error +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_last_error(LIBSSH2_SESSION *session, + char **errmsg, int *errmsg_len, int want_buf); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIerrmsg\fP - If not NULL, is populated by reference with the human +readable form of the most recent error message. + +\fIerrmsg_len\fP - If not NULL, is populated by reference with the length +of errmsg. (The string is NUL-terminated, so the length is only useful as +an optimization, to avoid calling strlen.) + +\fIwant_buf\fP - If set to a non-zero value, "ownership" of the errmsg +buffer will be given to the calling scope. If necessary, the errmsg buffer +will be duplicated. + +Determine the most recent error condition and its cause. +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. +.SH SEE ALSO +.BR libssh2_session_last_errno(3) +.BR libssh2_session_set_last_error(3) diff --git a/miniconda3/share/man/man3/libssh2_session_method_pref.3 b/miniconda3/share/man/man3/libssh2_session_method_pref.3 new file mode 100644 index 0000000000000000000000000000000000000000..310d50263872a6fdac6a83aa60178616985368c4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_method_pref.3 @@ -0,0 +1,41 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_method_pref 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_method_pref - set preferred key exchange method +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_method_pref(LIBSSH2_SESSION *session, + int method_type, const char *prefs); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fImethod_type\fP - One of the Method Type constants. + +\fIprefs\fP - Coma delimited list of preferred methods to use with +the most preferred listed first and the least preferred listed last. +If a method is listed which is not supported by libssh2 it will be +ignored and not sent to the remote host during protocol negotiation. + +Set preferred methods to be negotiated. These +preferences must be set prior to calling +.BR libssh2_session_handshake(3) +as they are used during the protocol initiation phase. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_session_handshake(3) diff --git a/miniconda3/share/man/man3/libssh2_session_methods.3 b/miniconda3/share/man/man3/libssh2_session_methods.3 new file mode 100644 index 0000000000000000000000000000000000000000..5748626df3e6b20912d90e654754002d0cb699bd --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_methods.3 @@ -0,0 +1,31 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_methods 3 "8 Nov 2021" "libssh2 1.11" "libssh2" +.SH NAME +libssh2_session_methods - return the currently active algorithms +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_session_methods(LIBSSH2_SESSION *session, int method_type); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fImethod_type\fP - one of the method type constants: LIBSSH2_METHOD_KEX, +LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC, +LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS, +LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC, +LIBSSH2_METHOD_SIGN_ALGO. + +Returns the actual method negotiated for a particular transport parameter. +.SH RETURN VALUE +Negotiated method or NULL if the session has not yet been started. +.SH ERRORS +\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. + +\fILIBSSH2_ERROR_METHOD_NONE\fP - no method has been set +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_set_blocking.3 b/miniconda3/share/man/man3/libssh2_session_set_blocking.3 new file mode 100644 index 0000000000000000000000000000000000000000..db596481adebd32f8d2c215be9be2753039887d7 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_set_blocking.3 @@ -0,0 +1,31 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_set_blocking - set or clear blocking mode on session +.SH SYNOPSIS +.nf +#include + +void +libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking); +.fi +.SH DESCRIPTION +\fIsession\fP - session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to +make it non-blocking. + +Set or clear blocking mode on the selected on the session. This will +instantly affect any channels associated with this session. If a read is +performed on a session with no data currently available, a blocking session +will wait for data to arrive and return what it receives. A non-blocking +session will return immediately with an empty buffer. If a write is performed +on a session with no room for more data, a blocking session will wait for +room. A non-blocking session will return immediately without writing +anything. +.SH RETURN VALUE +None +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_set_last_error.3 b/miniconda3/share/man/man3/libssh2_session_set_last_error.3 new file mode 100644 index 0000000000000000000000000000000000000000..7a5bdaa9675dc36f13caa1352e89ab9f0b5d382a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_set_last_error.3 @@ -0,0 +1,34 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2" "libssh2" +.SH NAME +libssh2_session_set_last_error - sets the internal error state +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_set_last_error(LIBSSH2_SESSION *session, + int errcode, const char *errmsg) +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIerrcode\fP - One of the error codes as defined in the public +libssh2 header file. + +\fIerrmsg\fP - If not NULL, a copy of the given string is stored +inside the session object as the error message. + +This function is provided for high level language wrappers +(i.e. Python or Perl) and other libraries that may extend libssh2 with +additional features while still relying on its error reporting +mechanism. +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. +.SH AVAILABILITY +Added in 1.6.1 +.SH SEE ALSO +.BR libssh2_session_last_error(3) +.BR libssh2_session_last_errno(3) diff --git a/miniconda3/share/man/man3/libssh2_session_set_read_timeout.3 b/miniconda3/share/man/man3/libssh2_session_set_read_timeout.3 new file mode 100644 index 0000000000000000000000000000000000000000..487c28900bc9feeda692c515a35006630d3ea155 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_set_read_timeout.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_set_read_timeout 3 "13 Jan 2023" "libssh2" "libssh2" +.SH NAME +libssh2_session_set_read_timeout - set timeout for packet read functions +.SH SYNOPSIS +.nf +#include + +void +libssh2_session_set_read_timeout(LIBSSH2_SESSION *session, long timeout); +.fi +.SH DESCRIPTION +Set the \fBtimeout\fP in seconds for how long libssh2 packet read +function calls may wait until they consider the situation an error and return +LIBSSH2_ERROR_TIMEOUT. + +By default or if you set the timeout to zero, the timeout will be set to +60 seconds. +.SH RETURN VALUE +Nothing +.SH AVAILABILITY +Added in 1.10.1 +.SH SEE ALSO +.BR libssh2_session_get_read_timeout(3) diff --git a/miniconda3/share/man/man3/libssh2_session_set_timeout.3 b/miniconda3/share/man/man3/libssh2_session_set_timeout.3 new file mode 100644 index 0000000000000000000000000000000000000000..2732685162fb24fd9275cce639217ddbc7bbf8eb --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_set_timeout.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2" "libssh2" +.SH NAME +libssh2_session_set_timeout - set timeout for blocking functions +.SH SYNOPSIS +.nf +#include + +void +libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout); +.fi +.SH DESCRIPTION +Set the \fBtimeout\fP in milliseconds for how long a blocking the libssh2 +function calls may wait until they consider the situation an error and return +LIBSSH2_ERROR_TIMEOUT. + +By default or if you set the timeout to zero, libssh2 has no timeout for +blocking functions. +.SH RETURN VALUE +Nothing +.SH AVAILABILITY +Added in 1.2.9 +.SH SEE ALSO +.BR libssh2_session_get_timeout(3) diff --git a/miniconda3/share/man/man3/libssh2_session_startup.3 b/miniconda3/share/man/man3/libssh2_session_startup.3 new file mode 100644 index 0000000000000000000000000000000000000000..53e95266733ed1308d323fc72888ded1c72b93df --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_startup.3 @@ -0,0 +1,45 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_session_startup - begin transport layer +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_startup(LIBSSH2_SESSION *session, int socket); +.fi +.SH DESCRIPTION +Starting in libssh2 version 1.2.8 this function is considered deprecated. Use +\fIlibssh2_session_handshake(3)\fP instead. + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIsocket\fP - Connected socket descriptor. Typically a TCP connection +though the protocol allows for any reliable transport and the library will +attempt to use any berkeley socket. + +Begin transport layer protocol negotiation with the connected host. +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid. + +\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host. + +\fILIBSSH2_ERROR_KEX_FAILURE\fP - Encryption key exchange with the remote +host failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected. + +\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on +the socket. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_session_supported_algs.3 b/miniconda3/share/man/man3/libssh2_session_supported_algs.3 new file mode 100644 index 0000000000000000000000000000000000000000..c17d53d50cb38acbeaeb9feef357076de3a24ea5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_session_supported_algs.3 @@ -0,0 +1,79 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_session_supported_algs 3 "23 Oct 2011" "libssh2" "libssh2" +.SH NAME +libssh2_session_supported_algs - get list of supported algorithms +.SH SYNOPSIS +.nf +#include + +int +libssh2_session_supported_algs(LIBSSH2_SESSION* session, + int method_type, + const char*** algs); +.fi +.SH DESCRIPTION +\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will +use its pointer to the memory allocation function). \fImethod_type\fP - +Method type. See \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address +of a pointer that will point to an array of returned algorithms + +Get a list of supported algorithms for the given \fImethod_type\fP. The +method_type parameter is equivalent to method_type in +\fIlibssh2_session_method_pref(3)\fP. If successful, the function will +allocate the appropriate amount of memory. When not needed anymore, it must be +deallocated by calling \fIlibssh2_free(3)\fP. When this function is +unsuccessful, this must not be done. + +In order to get a list of all supported compression algorithms, +libssh2_session_flag(session, LIBSSH2_FLAG_COMPRESS, 1) must be called before +calling this function, otherwise only "none" will be returned. + +If successful, the function will allocate and fill the array with supported +algorithms (the same names as defined in RFC 4253). The array is not NULL +terminated. +.SH EXAMPLE +.nf +#include "libssh2.h" + +const char **algorithms; +int rc, i; +LIBSSH2_SESSION *session; + +/* initialize session */ +session = libssh2_session_init(); +rc = libssh2_session_supported_algs(session, + LIBSSH2_METHOD_CRYPT_CS, + &algorithms); +if(rc > 0) { + /* the call succeeded, do sth. with the list of algorithms + (e.g. list them)... */ + printf("Supported symmetric algorithms:\\n"); + for(i = 0; i < rc; i++) + printf("\\t%s\\n", algorithms[i]); + + /* ... and free the allocated memory when not needed anymore */ + libssh2_free(session, algorithms); +} +else { + /* call failed, error handling */ +} +.fi +.SH RETURN VALUE +On success, a number of returned algorithms (i.e a positive number will be +returned). In case of a failure, an error code (a negative number, see below) +is returned. 0 should never be returned. +.SH ERRORS +\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs. + +\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type. + +\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur). + +\fILIBSSH2_ERROR_ALLOC\fP - Allocation of memory failed. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_session_methods(3), +.BR libssh2_session_method_pref(3) +.BR libssh2_free(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_close.3 b/miniconda3/share/man/man3/libssh2_sftp_close.3 new file mode 100644 index 0000000000000000000000000000000000000000..bf9c4c7f1c1340ee054e0dbf4e1c20605dad49f0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_close.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_close_handle.3 b/miniconda3/share/man/man3/libssh2_sftp_close_handle.3 new file mode 100644 index 0000000000000000000000000000000000000000..30794d4dde6de01d758f2aa36f215dde7c21064e --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_close_handle.3 @@ -0,0 +1,43 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_close_handle - close filehandle +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle); +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP +or \fBlibssh2_sftp_opendir(3)\fP (which is a macro). + +Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the +same underlying storage mechanism these methods may be used +interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP +are macros for \fBlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_closedir.3 b/miniconda3/share/man/man3/libssh2_sftp_closedir.3 new file mode 100644 index 0000000000000000000000000000000000000000..c1913d2dd6d37d5365295a7b464d0e0005db3225 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_closedir.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle) +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_fsetstat.3 b/miniconda3/share/man/man3/libssh2_sftp_fsetstat.3 new file mode 100644 index 0000000000000000000000000000000000000000..c3d8dabc9e2e12ee0952711b913e320699530a98 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_fsetstat.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_fstat.3 b/miniconda3/share/man/man3/libssh2_sftp_fstat.3 new file mode 100644 index 0000000000000000000000000000000000000000..b2dfacd9915201a878c2b9343364e8241521a631 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_fstat.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_fstat_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_fstat_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..65051e58f21f8fccc1c68c765222d0d05692b20a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_fstat_ex.3 @@ -0,0 +1,106 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_fstat_ex - get or set attributes on an SFTP file handle +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat) + +#define libssh2_sftp_fstat(handle, attrs) \\ + libssh2_sftp_fstat_ex((handle), (attrs), 0) +#define libssh2_sftp_fsetstat(handle, attrs) \\ + libssh2_sftp_fstat_ex((handle), (attrs), 1) +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIattrs\fP - Pointer to an LIBSSH2_SFTP_ATTRIBUTES structure to set file +metadata from or into depending on the value of setstat. + +\fIsetstat\fP - When non-zero, the file's metadata will be updated +with the data found in attrs according to the values of attrs->flags +and other relevant member attributes. + +Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance. +.SH DATA TYPES +LIBSSH2_SFTP_ATTRIBUTES is a typedefed struct that is defined as below + +.nf +struct _LIBSSH2_SFTP_ATTRIBUTES { + + /* If flags & ATTR_* bit is set, then the value in this + * struct will be meaningful Otherwise it should be ignored + */ + unsigned long flags; + + /* size of file, in bytes */ + libssh2_uint64_t filesize; + + /* numerical representation of the user and group owner of + * the file + */ + unsigned long uid, gid; + + /* bitmask of permissions */ + unsigned long permissions; + + /* access time and modified time of file */ + unsigned long atime, mtime; +}; +.fi + +You will find a full set of defines and macros to identify flags and +permissions on the \fBlibssh2_sftp.h\fP header file, but some of the +most common ones are: + +To check for specific user permissions, the set of defines are in the +pattern LIBSSH2_SFTP_S_I where is R, W or X for +read, write and executable and is USR, GRP and OTH for user, +group and other. So, you check for a user readable file, use the bit +\fILIBSSH2_SFTP_S_IRUSR\fP while you want to see if it is executable +for other, you use \fILIBSSH2_SFTP_S_IXOTH\fP and so on. + +To check for specific file types, you would previously (before libssh2 +1.2.5) use the standard posix S_IS***() macros, but since 1.2.5 +libssh2 offers its own set of macros for this functionality: +.IP LIBSSH2_SFTP_S_ISLNK +Test for a symbolic link +.IP LIBSSH2_SFTP_S_ISREG +Test for a regular file +.IP LIBSSH2_SFTP_S_ISDIR +Test for a directory +.IP LIBSSH2_SFTP_S_ISCHR +Test for a character special file +.IP LIBSSH2_SFTP_S_ISBLK +Test for a block special file +.IP LIBSSH2_SFTP_S_ISFIFO +Test for a pipe or FIFO special file +.IP LIBSSH2_SFTP_S_ISSOCK +Test for a socket +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH AVAILABILITY +This function has been around since forever, but most of the +LIBSSH2_SFTP_S_* defines were introduced in libssh2 0.14 and the +LIBSSH2_SFTP_S_IS***() macros were introduced in libssh2 1.2.5. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_fstatvfs.3 b/miniconda3/share/man/man3/libssh2_sftp_fstatvfs.3 new file mode 100644 index 0000000000000000000000000000000000000000..1546b9749145d4e7db21b32885b63d2c16793733 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_fstatvfs.3 @@ -0,0 +1,3 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.so man3/libssh2_sftp_statvfs.3 diff --git a/miniconda3/share/man/man3/libssh2_sftp_fsync.3 b/miniconda3/share/man/man3/libssh2_sftp_fsync.3 new file mode 100644 index 0000000000000000000000000000000000000000..e9cf3f3f834bb7236c1d397f43d1bb2565602cf6 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_fsync.3 @@ -0,0 +1,39 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_fsync 3 "8 Apr 2013" "libssh2" "libssh2" +.SH NAME +libssh2_sftp_fsync - synchronize file to disk +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_fsync(LIBSSH2_SFTP_HANDLE *handle) +.fi +.SH DESCRIPTION +This function causes the remote server to synchronize the file +data and metadata to disk (like fsync(2)). + +For this to work requires fsync@openssh.com support on the server. + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) +.SH RETURN VALUE +Returns 0 on success or negative on failure. If used in non-blocking mode, it +returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response +was received on the socket, or an SFTP operation caused an errorcode +to be returned by the server. In particular, this can be returned if +the SSH server does not support the fsync operation: the SFTP subcode +\fILIBSSH2_FX_OP_UNSUPPORTED\fP will be returned in this case. +.SH AVAILABILITY +Added in libssh2 1.4.4 and OpenSSH 6.3. +.SH SEE ALSO +.BR fsync(2) diff --git a/miniconda3/share/man/man3/libssh2_sftp_get_channel.3 b/miniconda3/share/man/man3/libssh2_sftp_get_channel.3 new file mode 100644 index 0000000000000000000000000000000000000000..0da7cdac4c88648e6e2c60867cd70034a5bb372e --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_get_channel.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_get_channel 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2" +.SH NAME +libssh2_sftp_get_channel - return the channel of sftp +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_CHANNEL * +libssh2_sftp_get_channel(LIBSSH2_SFTP *sftp); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Return the channel of the given sftp handle. +.SH RETURN VALUE +The channel of the SFTP instance or NULL if something was wrong. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_init.3 b/miniconda3/share/man/man3/libssh2_sftp_init.3 new file mode 100644 index 0000000000000000000000000000000000000000..dab613d6c1d8a1f4de66537aee7e35d73ee8de59 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_init.3 @@ -0,0 +1,42 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_init - open SFTP channel for the given SSH session. +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP * +libssh2_sftp_init(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem +operates over the same type of channel as those exported by the Channel API, +the protocol itself implements its own unique binary packet protocol which +must be managed with the libssh2_sftp_*() family of functions. When an SFTP +session is complete, it must be destroyed using the +.BR libssh2_sftp_shutdown(3) +function. +.SH RETURN VALUE +A pointer to the newly allocated SFTP instance or NULL on failure. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH SEE ALSO +.BR libssh2_sftp_shutdown(3) +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_last_error.3 b/miniconda3/share/man/man3/libssh2_sftp_last_error.3 new file mode 100644 index 0000000000000000000000000000000000000000..f5993b4d411378de1adee4f74ea0d85f67c566ef --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_last_error.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_last_error - return the last SFTP-specific error code +.SH SYNOPSIS +.nf +#include +#include + +unsigned long +libssh2_sftp_last_error(LIBSSH2_SFTP *sftp); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Returns the last error code produced by the SFTP layer. Note that this only +returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL +in a previous call. Using \fBlibssh2_sftp_last_error(3)\fP without a +preceding SFTP protocol error, it will return an unspecified value. +.SH RETURN VALUE +Current error code state of the SFTP instance. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_lstat.3 b/miniconda3/share/man/man3/libssh2_sftp_lstat.3 new file mode 100644 index 0000000000000000000000000000000000000000..8165cdb887d58ce9be525eefd9bad5644cf4207e --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_lstat.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_lstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_lstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_stat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_mkdir.3 b/miniconda3/share/man/man3/libssh2_sftp_mkdir.3 new file mode 100644 index 0000000000000000000000000000000000000000..193ec09e82eac51c3d998b0ad25f25b09a3b13a3 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_mkdir.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_mkdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_mkdir - convenience macro for \fIlibssh2_sftp_mkdir_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, + long mode); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_mkdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_mkdir_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_mkdir_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_mkdir_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..3e5759dc24df93f2048717d2ea25cd6be7f31f2d --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_mkdir_ex.3 @@ -0,0 +1,48 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_mkdir_ex - create a directory on the remote file system +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, + const char *path, unsigned int path_len, + long mode); + +int +libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, + const char *path, + long mode); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIpath\fP - full path of the new directory to create. Note that the new +directory's parents must all exist prior to making this call. + +\fIpath_len\fP - length of the full path of the new directory to create. + +\fImode\fP - directory creation mode (e.g. 0755). + +Create a directory on the remote file system. +.SH RETURN VALUE +Return 0 on success or negative on failure. +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_open.3 b/miniconda3/share/man/man3/libssh2_sftp_open.3 new file mode 100644 index 0000000000000000000000000000000000000000..7918b506bf30fac6e54d0143fa22349f668810e4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_open.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_open 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_open - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *filename, + unsigned long flags, + long mode); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_open_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_open_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..f0dced8cc2e999c9909a2f05d700dd992bef7a57 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_open_ex.3 @@ -0,0 +1,69 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_open_ex - open filehandle for file on SFTP. +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, + unsigned int filename_len, + unsigned long flags, + long mode, + int open_type); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP + +\fIfilename\fP - Remote file/directory resource to open + +\fIfilename_len\fP - Length of filename + +\fIflags\fP - Any reasonable combination of the LIBSSH2_FXF_* constants: +.RS +.IP LIBSSH2_FXF_READ +Open the file for reading. +.IP LIBSSH2_FXF_WRITE +Open the file for writing. If both this and LIBSSH2_FXF_READ are specified, +the file is opened for both reading and writing. +.IP LIBSSH2_FXF_APPEND +Force all writes to append data at the end of the file. +.IP LIBSSH2_FXF_CREAT, +If this flag is specified, then a new file will be created if one does not +already exist (if LIBSSH2_FXF_TRUNC is specified, the new file will be +truncated to zero length if it previously exists) +.IP LIBSSH2_FXF_TRUNC +Forces an existing file with the same name to be truncated to zero length when +creating a file by specifying LIBSSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also +be specified if this flag is used. +.IP LIBSSH2_FXF_EXCL +Causes the request to fail if the named file already exists. +LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. + +.RE +\fImode\fP - POSIX file permissions to assign if the file is being newly +created. See the LIBSSH2_SFTP_S_* convenience defines in + +\fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or +LIBSSH2_SFTP_OPENDIR (to open a directory). +.SH RETURN VALUE +A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on +failure. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_open_ex_r.3 b/miniconda3/share/man/man3/libssh2_sftp_open_ex_r.3 new file mode 100644 index 0000000000000000000000000000000000000000..11bb6c17e6cc10f036174b617cf0fb3f3ea883f8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_open_ex_r.3 @@ -0,0 +1,77 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_open_ex_r 3 "10 Apr 2023" "libssh2" "libssh2" +.SH NAME +libssh2_sftp_open_ex_r - open filehandle for file on SFTP. +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open_ex_r(LIBSSH2_SFTP *sftp, const char *filename, + size_t filename_len, + unsigned long flags, + long mode, + int open_type, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP + +\fIfilename\fP - Remote file/directory resource to open + +\fIfilename_len\fP - Length of filename + +\fIflags\fP - Any reasonable combination of the LIBSSH2_FXF_* constants: +.RS +.IP LIBSSH2_FXF_READ +Open the file for reading. +.IP LIBSSH2_FXF_WRITE +Open the file for writing. If both this and LIBSSH2_FXF_READ are specified, +the file is opened for both reading and writing. +.IP LIBSSH2_FXF_APPEND +Force all writes to append data at the end of the file. +.IP LIBSSH2_FXF_CREAT, +If this flag is specified, then a new file will be created if one does not +already exist (if LIBSSH2_FXF_TRUNC is specified, the new file will be +truncated to zero length if it previously exists) +.IP LIBSSH2_FXF_TRUNC +Forces an existing file with the same name to be truncated to zero length when +creating a file by specifying LIBSSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also +be specified if this flag is used. +.IP LIBSSH2_FXF_EXCL +Causes the request to fail if the named file already exists. +LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. + +.RE +\fImode\fP - POSIX file permissions to assign if the file is being newly +created. See the LIBSSH2_SFTP_S_* convenience defines in + +\fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or +LIBSSH2_SFTP_OPENDIR (to open a directory). + +\fIattrs\fP - Pointer to LIBSSH2_SFTP_ATTRIBUTES struct. See +libssh2_sftp_fstat_ex for detailed usage. + +.SH RETURN VALUE +A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on +failure. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH AVAILABILITY +Added in libssh2 1.11.0 +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) +.BR libssh2_sftp_fstat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_open_r.3 b/miniconda3/share/man/man3/libssh2_sftp_open_r.3 new file mode 100644 index 0000000000000000000000000000000000000000..2627c9d760e1b4e8a720a66947d1a50545985efc --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_open_r.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_open_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2" +.SH NAME +libssh2_sftp_open_r - convenience macro for \fIlibssh2_sftp_open_ex_r(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open_r(LIBSSH2_SFTP *sftp, const char *filename, + unsigned long flags, + long mode, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex_r(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex_r(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex_r(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_open_ex_r(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_opendir.3 b/miniconda3/share/man/man3/libssh2_sftp_opendir.3 new file mode 100644 index 0000000000000000000000000000000000000000..fbba59480c548859038b4454bbff36d7a1672dfa --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_opendir.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_opendir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_opendir - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_posix_rename.3 b/miniconda3/share/man/man3/libssh2_sftp_posix_rename.3 new file mode 100644 index 0000000000000000000000000000000000000000..95cbd4dea58149542bfe042c9e4deaf93c531130 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_posix_rename.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_posix_rename 3 "9 May 2024" "libssh2 1.11.1" "libssh2" +.SH NAME +libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_posix_rename_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_posix_rename(LIBSSH2_SFTP *sftp, + const char *source_filename, + const char *destination_filename); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_posix_rename_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_posix_rename_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_posix_rename_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_posix_rename_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_posix_rename_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_posix_rename_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..03b6c39f30dcff28b7c4b1602bfccfe91e9b2107 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_posix_rename_ex.3 @@ -0,0 +1,58 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_posix_rename_ex 3 "9 May 2024" "libssh2 1.11.1" "libssh2" +.SH NAME +libssh2_sftp_posix_rename_ex - rename an SFTP file using POSIX semantics +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_posix_rename_ex(LIBSSH2_SFTP *sftp, + const char *source_filename, + size_t source_filename_len, + const char *dest_filename, + size_t dest_filename_len); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIsourcefile\fP - Path and name of the existing filesystem entry + +\fIsourcefile_len\fP - Length of the path and name of the existing +filesystem entry + +\fIdestfile\fP - Path and name of the target filesystem entry + +\fIdestfile_len\fP - Length of the path and name of the target +filesystem entry + +This function implements the posix-rename@openssh.com extension, which is +useful when, for example, moving files across filesystems on a remote server. +SSH_FXP_RENAME does not specify a specific implementation, but many servers +will attempt to user hard links when moving files using SSH_FXP_RENAME. + +If the server does not support posix-rename@openssh.com, this function will +return LIBSSH2_FX_OP_UNSUPPORTED and you can call libssh2_sftp_rename_ex (3) as +a backup. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_FX_OP_UNSUPPORTED\fP - Server does not support +posix-rename@openssh.com + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_read.3 b/miniconda3/share/man/man3/libssh2_sftp_read.3 new file mode 100644 index 0000000000000000000000000000000000000000..86df3e2bd18b0f24122d9ac3e5493533972b1f0b --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_read.3 @@ -0,0 +1,47 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_read - read data from an SFTP handle +.SH SYNOPSIS +.nf +#include +#include + +ssize_t +libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, + char *buffer, size_t buffer_maxlen); +.fi +.SH DESCRIPTION +\fIhandle\fP is the SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIbuffer\fP is a pointer to a pre-allocated buffer of at least + +\fIbuffer_maxlen\fP bytes to read data into. + +Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled +after the POSIX +.BR read(2) +function and uses the same calling semantics. +.BR libssh2_sftp_read(3) +will attempt to read as much as possible however it may not fill all of buffer +if the file pointer reaches the end or if further reads would cause the socket +to block. +.SH RETURN VALUE +Number of bytes actually populated into buffer, or negative on failure. +It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) +.BR libssh2_sftp_read(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_readdir.3 b/miniconda3/share/man/man3/libssh2_sftp_readdir.3 new file mode 100644 index 0000000000000000000000000000000000000000..9764a8b0a185a3c92d7c3f2ab72cbae3e6e3111c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_readdir.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, + char *buffer, size_t buffer_maxlen, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_readdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_readdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_readdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_readdir_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_readdir_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_readdir_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..ef8d757657bfc4ccb0fadbf1e655faa98efeeab5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_readdir_ex.3 @@ -0,0 +1,68 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_readdir_ex - read directory data from an SFTP handle +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, + char *buffer, size_t buffer_maxlen, + char *longentry, size_t longentry_maxlen, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +Reads a block of data from a LIBSSH2_SFTP_HANDLE and returns file entry +information for the next entry, if any. + +\fIhandle\fP - is the SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIbuffer\fP - is a pointer to a pre-allocated buffer of at least +\fIbuffer_maxlen\fP bytes to read data into. + +\fIbuffer_maxlen\fP - is the length of buffer in bytes. If the length of the +filename is longer than the space provided by buffer_maxlen it will be +truncated to fit. + +\fIlongentry\fP - is a pointer to a pre-allocated buffer of at least +\fIlongentry_maxlen\fP bytes to read data into. The format of the `longname' +field is unspecified by SFTP protocol. It MUST be suitable for use in the +output of a directory listing command (in fact, the recommended operation for +a directory listing command is to display this data). + +\fIlongentry_maxlen\fP - is the length of longentry in bytes. If the length of +the full directory entry is longer than the space provided by +\fIlongentry_maxlen\fP it will be truncated to fit. + +\fIattrs\fP - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate +statbuf style data into. +.SH RETURN VALUE +Number of bytes actually populated into buffer (not counting the terminating +zero), or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would +otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not +really a failure per se. +.SH BUG +Passing in a too small buffer for 'buffer' or 'longentry' when receiving data +only results in libssh2 1.2.7 or earlier to not copy the entire data amount, +and it is not possible for the application to tell when it happens! +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be +returned by the server. + +From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if any of the +given 'buffer' or 'longentry' buffers are too small to fit the requested +object name. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_close_handle(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_readlink.3 b/miniconda3/share/man/man3/libssh2_sftp_readlink.3 new file mode 100644 index 0000000000000000000000000000000000000000..f48da0c1f066f0483085182a1c794c6f205bc6a0 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_readlink.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include +#include + +#define libssh2_sftp_readlink(sftp, path, target, maxlen) \\ + libssh2_sftp_symlink_ex((sftp), (path), strlen(path), \\ + (target), (maxlen), \\ + LIBSSH2_SFTP_READLINK) +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_realpath.3 b/miniconda3/share/man/man3/libssh2_sftp_realpath.3 new file mode 100644 index 0000000000000000000000000000000000000000..1685622ddd3c7551db1c6344ad61d1c20c1955c4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_realpath.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_realpath 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_realpath - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include +#include + +#define libssh2_sftp_realpath(sftp, path, target, maxlen) \\ + libssh2_sftp_symlink_ex((sftp), (path), strlen(path), \\ + (target), (maxlen), \\ + LIBSSH2_SFTP_REALPATH) +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_rename.3 b/miniconda3/share/man/man3/libssh2_sftp_rename.3 new file mode 100644 index 0000000000000000000000000000000000000000..7207780b1004c94fda8f8cf8a8c9c89517066034 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_rename.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_rename 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_rename_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_rename(LIBSSH2_SFTP *sftp, + const char *source_filename, + const char *destination_filename); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rename_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_rename_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_rename_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_rename_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..8feb4d21235b1af046e0ab4919597db453aa31fe --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_rename_ex.3 @@ -0,0 +1,63 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_rename_ex - rename an SFTP file +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, + const char *source_filename, + unsigned int source_filename_len, + const char *dest_filename, + unsigned int dest_filename_len, + long flags); + +int +libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, + const char *source_filename, + const char *dest_filename); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIsourcefile\fP - Path and name of the existing filesystem entry + +\fIsourcefile_len\fP - Length of the path and name of the existing +filesystem entry + +\fIdestfile\fP - Path and name of the target filesystem entry + +\fIdestfile_len\fP - Length of the path and name of the target +filesystem entry + +\fIflags\fP - +Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants. + +Rename a filesystem object on the remote filesystem. The semantics of +this command typically include the ability to move a filesystem object +between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE +flag is not set and the destfile entry already exists, the operation +will fail. Use of the other two flags indicate a preference (but not a +requirement) for the remote end to perform an atomic rename operation +and/or using native system calls when possible. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_rewind.3 b/miniconda3/share/man/man3/libssh2_sftp_rewind.3 new file mode 100644 index 0000000000000000000000000000000000000000..5e4ddde4fa6efb8ae75d8217df88149ad84aa006 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_rewind.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_rewind 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_rewind(LIBSSH2_SFTP_HANDLE *handle); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_seek64(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_seek64(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_seek64(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_seek64(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_rmdir.3 b/miniconda3/share/man/man3/libssh2_sftp_rmdir.3 new file mode 100644 index 0000000000000000000000000000000000000000..523534ac0bb7460e532d9418b0320eaf996ab7cf --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_rmdir.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_rmdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_rmdir - convenience macro for \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH SYNOPSIS +.nf +#include +#include + +#define libssh2_sftp_rmdir(sftp, path) \\ + libssh2_sftp_rmdir_ex((sftp), (path), strlen(path)) +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rmdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_rmdir_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_rmdir_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_rmdir_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..79a73bfa9db37a4eac9012cbc568ca1a03e675a8 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_rmdir_ex.3 @@ -0,0 +1,40 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_rmdir_ex - remove an SFTP directory +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len); +.fi +.SH DESCRIPTION +Remove a directory from the remote file system. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIsourcefile\fP - Full path of the existing directory to remove. + +\fIsourcefile_len\fP - Length of the full path of the existing directory to +remove. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_seek.3 b/miniconda3/share/man/man3/libssh2_sftp_seek.3 new file mode 100644 index 0000000000000000000000000000000000000000..87782de1121b5affd2bcb301e66b05922067c176 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_seek.3 @@ -0,0 +1,30 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2" +.SH NAME +libssh2_sftp_seek - set the read/write position indicator within a file +.SH SYNOPSIS +.nf +#include +#include + +void +libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, + size_t offset); +.fi +.SH DESCRIPTION +Deprecated function. Use \fIlibssh2_sftp_seek64(3)\fP instead! + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIoffset\fP - Number of bytes from the beginning of file to seek to. + +Move the file handle's internal pointer to an arbitrary location. +Note that libssh2 implements file pointers as a localized concept to make +file access appear more POSIX like. No packets are exchanged with the server +during a seek operation. The localized file pointer is used as a convenience +offset during read/write operations. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_seek64(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_seek64.3 b/miniconda3/share/man/man3/libssh2_sftp_seek64.3 new file mode 100644 index 0000000000000000000000000000000000000000..d40cc84b1cba66df04a365d9da0255910173dffe --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_seek64.3 @@ -0,0 +1,33 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2" "libssh2" +.SH NAME +libssh2_sftp_seek64 - set the read/write position within a file +.SH SYNOPSIS +.nf +#include +#include + +void +libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle, + libssh2_uint64_t offset); +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIoffset\fP - Number of bytes from the beginning of file to seek to. + +Move the file handle's internal pointer to an arbitrary location. libssh2 +implements file pointers as a localized concept to make file access appear +more POSIX like. No packets are exchanged with the server during a seek +operation. The localized file pointer is used as a convenience offset during +read/write operations. + +You MUST NOT seek during writing or reading a file with SFTP, as the internals +use outstanding packets and changing the "file position" during transit will +results in badness. +.SH AVAILABILITY +Added in 1.0 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_setstat.3 b/miniconda3/share/man/man3/libssh2_sftp_setstat.3 new file mode 100644 index 0000000000000000000000000000000000000000..3bd42f5f3e590f6ac69ef6c46c08a06ca4195ef3 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_setstat.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_setstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_setstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, + LIBSSH2_SFTP_ATTRIBUTES *attr); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_stat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_shutdown.3 b/miniconda3/share/man/man3/libssh2_sftp_shutdown.3 new file mode 100644 index 0000000000000000000000000000000000000000..d0f097bae748f78f4f3d93de1af7da92575a12fe --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_shutdown.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_shutdown - shut down an SFTP session +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Destroys a previously initialized SFTP session and frees all resources +associated with it. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_stat.3 b/miniconda3/share/man/man3/libssh2_sftp_stat.3 new file mode 100644 index 0000000000000000000000000000000000000000..30e28a24db83eaefe12b89eea595943657b04c7a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_stat.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_stat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_stat_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_stat_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..3ba536e0b5c404a9a04c58312caf3ac404c01db2 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_stat_ex.3 @@ -0,0 +1,78 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_stat_ex - get status about an SFTP file +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, int stat_type, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIpath\fP - Remote filesystem object to stat/lstat/setstat. + +\fIpath_len\fP - Length of the name of the remote filesystem object +to stat/lstat/setstat. + +\fIstat_type\fP - One of the three constants specifying the type of +stat operation to perform: + +.br +\fBLIBSSH2_SFTP_STAT\fP: performs stat(2) operation +.br +\fBLIBSSH2_SFTP_LSTAT\fP: performs lstat(2) operation +.br +\fBLIBSSH2_SFTP_SETSTAT\fP: performs operation to set stat info on file + +\fIattrs\fP - Pointer to a \fBLIBSSH2_SFTP_ATTRIBUTES\fP structure to set file +metadata from or into depending on the value of stat_type. + +Get or Set statbuf type data on a remote filesystem object. When getting +statbuf data, +.BR libssh2_sftp_stat(3) +will follow all symlinks, while +.BR libssh2_sftp_lstat(3) +will return data about the object encountered, even if that object +happens to be a symlink. + +The LIBSSH2_SFTP_ATTRIBUTES struct looks like this: + +.nf +struct LIBSSH2_SFTP_ATTRIBUTES { + /* If flags & ATTR_* bit is set, then the value in this struct will be + * meaningful Otherwise it should be ignored + */ + unsigned long flags; + + libssh2_uint64_t filesize; + unsigned long uid; + unsigned long gid; + unsigned long permissions; + unsigned long atime; + unsigned long mtime; +}; +.fi +.SH RETURN VALUE +Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN +when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative +number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_statvfs.3 b/miniconda3/share/man/man3/libssh2_sftp_statvfs.3 new file mode 100644 index 0000000000000000000000000000000000000000..75b23847ef6efebb994b5d198891e4b246423119 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_statvfs.3 @@ -0,0 +1,79 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_statvfs 3 "22 May 2010" "libssh2" "libssh2" +.SH NAME +libssh2_sftp_statvfs, libssh2_sftp_fstatvfs - get file system statistics +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, const char *path, + size_t path_len, LIBSSH2_SFTP_STATVFS *st); + +int +libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_STATVFS *st) +.fi +.SH DESCRIPTION +These functions provide statvfs(2)-like operations and require +statvfs@openssh.com and fstatvfs@openssh.com extension support on the server. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIpath\fP - full path of any file within the mounted file system. + +\fIpath_len\fP - length of the full path. + +\fIst\fP - Pointer to a LIBSSH2_SFTP_STATVFS structure to place file system +statistics into. +.SH DATA TYPES +LIBSSH2_SFTP_STATVFS is a typedefed struct that is defined as below + +.nf +struct _LIBSSH2_SFTP_STATVFS { + libssh2_uint64_t f_bsize; /* file system block size */ + libssh2_uint64_t f_frsize; /* fragment size */ + libssh2_uint64_t f_blocks; /* size of fs in f_frsize units */ + libssh2_uint64_t f_bfree; /* # free blocks */ + libssh2_uint64_t f_bavail; /* # free blocks for non-root */ + libssh2_uint64_t f_files; /* # inodes */ + libssh2_uint64_t f_ffree; /* # free inodes */ + libssh2_uint64_t f_favail; /* # free inodes for non-root */ + libssh2_uint64_t f_fsid; /* file system ID */ + libssh2_uint64_t f_flag; /* mount flags */ + libssh2_uint64_t f_namemax; /* maximum filename length */ +}; +.fi + +It is unspecified whether all members of the returned struct have meaningful +values on all file systems. + +The field \fIf_flag\fP is a bit mask. Bits are defined as follows: +.IP LIBSSH2_SFTP_ST_RDONLY +Read-only file system. +.IP LIBSSH2_SFTP_ST_NOSUID +Set-user-ID/set-group-ID bits are ignored by \fBexec\fP(3). +.SH RETURN VALUE +Returns 0 on success or negative on failure. If used in non-blocking mode, it +returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be returned +by the server. +.SH AVAILABILITY +Added in libssh2 1.2.6 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_symlink.3 b/miniconda3/share/man/man3/libssh2_sftp_symlink.3 new file mode 100644 index 0000000000000000000000000000000000000000..8fb70df078d1bdcde5222993e879413f65b250ae --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_symlink.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_symlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_symlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include +#include + +#define libssh2_sftp_symlink(sftp, orig, linkpath) \\ + libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \\ + strlen(linkpath), LIBSSH2_SFTP_SYMLINK) +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_symlink_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_symlink_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..e4dad4bedb9986e7672426f17dbf101ee049864a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_symlink_ex.3 @@ -0,0 +1,81 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_symlink_ex - read or set a symbolic link +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, char *target, + unsigned int target_len, int link_type); +.fi +.SH DESCRIPTION +Create a symlink or read out symlink information from the remote side. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIpath\fP - Remote filesystem object to create a symlink from or resolve. + +\fIpath_len\fP - Length of the name of the remote filesystem object to +create a symlink from or resolve. + +\fItarget\fP - a pointer to a buffer. The buffer has different uses depending +what the \fIlink_type\fP argument is set to. +.br +\fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to. +.br +\fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target +into. +.br +\fBLIBSSH2_SFTP_REALPATH\fP: Pre-allocated buffer to resolve realpath target +into. + +\fItarget_len\fP - Length of the name of the remote filesystem target object. + +\fIlink_type\fP - One of the three previously mentioned constants which +determines the resulting behavior of this function. + +These are convenience macros: + +.BR libssh2_sftp_symlink(3) +: Create a symbolic link between two filesystem objects. +.br +.BR libssh2_sftp_readlink(3) +: Resolve a symbolic link filesystem object to its next target. +.br +.BR libssh2_sftp_realpath(3) +: Resolve a complex, relative, or symlinked filepath to its effective target. +.SH RETURN VALUE +When using LIBSSH2_SFTP_SYMLINK, this function returns 0 on success or negative +on failure. + +When using LIBSSH2_SFTP_READLINK or LIBSSH2_SFTP_REALPATH, it returns the +number of bytes it copied to the target buffer (not including the terminating +zero) or negative on failure. + +It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. + +From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if the given 'target' +buffer is too small to fit the requested object name. +.SH BUG +Passing in a too small buffer when receiving data only results in libssh2 +1.2.7 or earlier to not copy the entire data amount, and it is not possible +for the application to tell when it happens! +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_tell.3 b/miniconda3/share/man/man3/libssh2_sftp_tell.3 new file mode 100644 index 0000000000000000000000000000000000000000..88b65370de95777ac6c60fc408f36a7fb56d5bc9 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_tell.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_tell - get the current read/write position indicator for a file +.SH SYNOPSIS +.nf +#include +#include + +size_t +libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle); +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP. + +Returns the current offset of the file handle's internal pointer. Note that +this is now deprecated. Use the newer \fBlibssh2_sftp_tell64(3)\fP instead! +.SH RETURN VALUE +Current offset from beginning of file in bytes. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_tell64(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_tell64.3 b/miniconda3/share/man/man3/libssh2_sftp_tell64.3 new file mode 100644 index 0000000000000000000000000000000000000000..013e7dad2880681d2fa582f9fa359fd3d867851e --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_tell64.3 @@ -0,0 +1,24 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_tell64 3 "22 Dec 2008" "libssh2 1.0" "libssh2" +.SH NAME +libssh2_sftp_tell64 - get the current read/write position indicator for a file +.SH SYNOPSIS +.nf +#include +#include + +libssh2_uint64_t +libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle); +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP + +Identify the current offset of the file handle's internal pointer. +.SH RETURN VALUE +Current offset from beginning of file in bytes. +.SH AVAILABILITY +Added in libssh2 1.0 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_tell(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_unlink.3 b/miniconda3/share/man/man3/libssh2_sftp_unlink.3 new file mode 100644 index 0000000000000000000000000000000000000000..da4874c1079de88a8ef36e2da08cfb6f2da5e8f6 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_unlink.3 @@ -0,0 +1,22 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_unlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_sftp_unlink - convenience macro for \fIlibssh2_sftp_unlink_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_unlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_unlink_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_unlink_ex.3 b/miniconda3/share/man/man3/libssh2_sftp_unlink_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..e92df5f6a73040d6bafbeaed7da5dfe664c28a5b --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_unlink_ex.3 @@ -0,0 +1,42 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_unlink_ex - unlink an SFTP file +.SH SYNOPSIS +.nf +#include +#include + +int +libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); + +int +libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); +.fi +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIfilename\fP - Path and name of the existing filesystem entry + +\fIfilename_len\fP - Length of the path and name of the existing +filesystem entry + +Unlink (delete) a file from the remote filesystem. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/miniconda3/share/man/man3/libssh2_sftp_write.3 b/miniconda3/share/man/man3/libssh2_sftp_write.3 new file mode 100644 index 0000000000000000000000000000000000000000..818022164c0c5dfb2ead12787d54c66fa495f57c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sftp_write.3 @@ -0,0 +1,73 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sftp_write 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_sftp_write - write SFTP data +.SH SYNOPSIS +.nf +#include +#include + +ssize_t +libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, + const char *buffer, + size_t count); +.fi +.SH DESCRIPTION +\fBlibssh2_sftp_write(3)\fP writes a block of data to the SFTP server. This +method is modeled after the POSIX write() function and uses the same calling +semantics. + +\fIhandle\fP - SFTP file handle as returned by \fIlibssh2_sftp_open_ex(3)\fP. + +\fIbuffer\fP - points to the data to send off. + +\fIcount\fP - Number of bytes from 'buffer' to write. Note that it may not be +possible to write all bytes as requested. + +\fIlibssh2_sftp_handle(3)\fP will use as much as possible of the buffer and +put it into a single SFTP protocol packet. This means that to get maximum +performance when sending larger files, you should try to always pass in at +least 32K of data to this function. +.SH WRITE AHEAD +Starting in libssh2 version 1.2.8, the default behavior of libssh2 is to +create several smaller outgoing packets for all data you pass to this function +and it will return a positive number as soon as the first packet is +acknowledged from the server. + +This has the effect that sometimes more data has been sent off but is not acked +yet when this function returns, and when this function is subsequently called +again to write more data, libssh2 will immediately figure out that the data is +already received remotely. + +In most normal situation this should not cause any problems, but it should be +noted that if you have once called libssh2_sftp_write() with data and it returns +short, you MUST still assume that the rest of the data might have been cached so +you need to make sure you do not alter that data and think that the version you +have in your next function invoke will be detected or used. + +The reason for this funny behavior is that SFTP can only send 32K data in each +packet and it gets all packets acked individually. This means we cannot use a +simple serial approach if we want to reach high performance even on high +latency connections. And we want that. +.SH RETURN VALUE +Actual number of bytes written or negative on failure. + +If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would +otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not +really a failure per se. + +If this function returns 0 (zero) it should not be considered an error, but +that there was no error but yet no payload data got sent to the other end. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_sign_sk.3 b/miniconda3/share/man/man3/libssh2_sign_sk.3 new file mode 100644 index 0000000000000000000000000000000000000000..57b742b1196a05e65a50873a20a6df98b6648535 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_sign_sk.3 @@ -0,0 +1,87 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_sign_sk 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2" +.SH NAME +libssh2_sign_sk - Create a signature from a FIDO2 authenticator. +.SH SYNOPSIS +.nf +#include + +int +libssh2_sign_sk(LIBSSH2_SESSION *session, + unsigned char **sig, + size_t *sig_len, + const unsigned char *data, + size_t data_len, + void **abstract); + +typedef struct _LIBSSH2_PRIVKEY_SK { + int algorithm; + uint8_t flags; + const char *application; + const unsigned char *key_handle; + size_t handle_len; + LIBSSH2_USERAUTH_SK_SIGN_FUNC((*sign_callback)); + void **orig_abstract; +} LIBSSH2_PRIVKEY_SK; +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIsig\fP - A pointer to a buffer in which to place the signature. The caller +is responsible for freeing the signature with LIBSSH2_FREE. + +\fIsig_len\fP - A pointer to the length of the sig parameter. + +\fIdata\fP - The data to sign. + +\fIdata_len\fP - The length of the data parameter. + +\fIabstract\fP - A pointer to a pointer to a LIBSSH2_PRIVKEY_SK. See +description below. + +Create a signature from a FIDO2 authenticator, using either the +sk-ssh-ed25519@openssh.com or sk-ecdsa-sha2-nistp256@openssh.com key +exchange algorithms. + +The abstract parameter is a pointer to a pointer due to the internal workings +of libssh2. The LIBSSH2_PRIVKEY_SK must be completely filled out, and the +caller is responsible for all memory management of its fields. + +\fIalgorithm\fP - The signing algorithm to use. Possible values are +LIBSSH2_HOSTKEY_TYPE_ED25519 and LIBSSH2_HOSTKEY_TYPE_ECDSA_256. + +\fIflags\fP - A bitmask specifying options for the authenticator. When +LIBSSH2_SK_PRESENCE_REQUIRED is set, the authenticator requires a touch. When +LIBSSH2_SK_VERIFICATION_REQUIRED is set, the authenticator requires a PIN. +Many servers and authenticators do not work properly when +LIBSSH2_SK_PRESENCE_REQUIRED is not set. + +\fIapplication\fP - A user-defined string to use as the RP name for the +authenticator. Usually "ssh:". + +\fIkey_handle\fP - The key handle to use for the authenticator's allow list. + +\fIhandle_len\fP - The length of the key_handle parameter. + +\fIabstract\fP - User-defined data. When a PIN is required, use this to pass in +the PIN, or a function pointer to retrieve the PIN. + +\fIkey_handle\fP The decoded key handle from the private key file. + +\fIhandle_len\fP The length of the key_handle parameter. + +\fIsign_callback\fP - Responsible for communicating with the hardware +authenticator to generate a signature. On success, the signature information +must be placed in the `\fIsig_info\fP sig_info parameter and the callback must +return 0. On failure, it should return a negative number. See +.BR libssh2_userauth_publickey_sk(3) + for more information. + +\fIorig_abstract\fP - User-defined data. When a PIN is required, use this to +pass in the PIN, or a function pointer to retrieve the PIN. +.SH RETURN VALUE +Return 0 on success or negative on failure. +.SH SEE ALSO +.BR libssh2_userauth_publickey_sk(3) diff --git a/miniconda3/share/man/man3/libssh2_trace.3 b/miniconda3/share/man/man3/libssh2_trace.3 new file mode 100644 index 0000000000000000000000000000000000000000..c3be38770252b6ec0b918e3e86e309c57391ca76 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_trace.3 @@ -0,0 +1,39 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2" +.SH NAME +libssh2_trace - enable debug info from inside libssh2 +.SH SYNOPSIS +.nf +#include + +void +libssh2_trace(LIBSSH2_SESSION *session, int bitmask); +.fi +.SH DESCRIPTION +This is a function present in the library that can be used to get debug info +from within libssh2 when it is running. Helpful when trying to trace or debug +behaviors. Note that this function has no effect unless libssh2 was built to +support tracing! It is usually disabled in release builds. + +\fBbitmask\fP can be set to the logical OR of none, one or more of these: +.RS +.IP LIBSSH2_TRACE_SOCKET +Socket low-level debugging +.IP LIBSSH2_TRACE_TRANS +Transport layer debugging +.IP LIBSSH2_TRACE_KEX +Key exchange debugging +.IP LIBSSH2_TRACE_AUTH +Authentication debugging +.IP LIBSSH2_TRACE_CONN +Connection layer debugging +.IP LIBSSH2_TRACE_SCP +SCP debugging +.IP LIBSSH2_TRACE_SFTP +SFTP debugging +.IP LIBSSH2_TRACE_ERROR +Error debugging +.IP LIBSSH2_TRACE_PUBLICKEY +Public Key debugging +.RE diff --git a/miniconda3/share/man/man3/libssh2_trace_sethandler.3 b/miniconda3/share/man/man3/libssh2_trace_sethandler.3 new file mode 100644 index 0000000000000000000000000000000000000000..453d468a0d40712a4188a3fdb257d922d1dfe757 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_trace_sethandler.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2" "libssh2" +.SH NAME +libssh2_trace_sethandler - set a trace output handler +.SH SYNOPSIS +.nf +#include + +typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session, + void *context, + const char *data, + size_t length); + +int +libssh2_trace_sethandler(LIBSSH2_SESSION *session, + void *context, + libssh2_trace_handler_func callback); +.fi +.SH DESCRIPTION +libssh2_trace_sethandler installs a trace output handler for your application. +By default, when tracing has been switched on via a call to libssh2_trace(), +all output is written to stderr. By calling this method and passing a +function pointer that matches the libssh2_trace_handler_func prototype, +libssh2 will call back as it generates trace output. This can be used to +capture the trace output and put it into a log file or diagnostic window. +This function has no effect unless libssh2 was built to support this option, +and a typical "release build" might not. + +\fBcontext\fP can be used to pass arbitrary user defined data back into the callback when invoked. +.SH AVAILABILITY +Added in libssh2 version 1.2.3 diff --git a/miniconda3/share/man/man3/libssh2_userauth_authenticated.3 b/miniconda3/share/man/man3/libssh2_userauth_authenticated.3 new file mode 100644 index 0000000000000000000000000000000000000000..11568c46ad5bcff24a43a41deec0468bb4113a74 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_authenticated.3 @@ -0,0 +1,21 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_authenticated - return authentication status +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_authenticated(LIBSSH2_SESSION *session); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Indicates whether or not the named session has been successfully authenticated. +.SH RETURN VALUE +Returns 1 if authenticated and 0 if not. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_banner.3 b/miniconda3/share/man/man3/libssh2_userauth_banner.3 new file mode 100644 index 0000000000000000000000000000000000000000..1369fa5f2e8b217e618119c73bc408bf86fb3f49 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_banner.3 @@ -0,0 +1,33 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_banner 3 "1 Jun 2021" "libssh2 1.9.0" "libssh2" +.SH NAME +libssh2_userauth_banner - get the server's userauth banner message +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_banner(LIBSSH2_SESSION *session, char **banner); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - Should point to a pointer that gets filled with banner message. + +After an authentication has been attempted, such as a +\fBSSH_USERAUTH_NONE\fP request sent by +.BR libssh2_userauth_list(3) , +this function can be called to retrieve the userauth banner sent by +the server. If no such banner is sent, or if an authentication has not +yet been attempted, returns LIBSSH2_ERROR_MISSING_USERAUTH_BANNER. +.SH RETURN VALUE +On success returns 0 and an UTF-8 NUL-terminated string is stored in the +\fIbanner\fP. This string is internally managed by libssh2 and will be +deallocated upon session termination. +On failure returns +LIBSSH2_ERROR_MISSING_USERAUTH_BANNER. +.SH SEE ALSO +.BR libssh2_session_init_ex(3), +.BR libssh2_userauth_list(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile.3 b/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile.3 new file mode 100644 index 0000000000000000000000000000000000000000..e29880f0de114438ff67cf6c3286d17615a943cb --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile.3 @@ -0,0 +1,26 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_hostbased_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_userauth_hostbased_fromfile - convenience macro for \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_hostbased_fromfile(LIBSSH2_SESSION *session, + const char *username, + const char *publickey, + const char *privatekey, + const char *passphrase, + const char *hostname); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_hostbased_fromfile_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile_ex.3 b/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..c37f5561995d026a800ec126f950d006c53ab05b --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_hostbased_fromfile_ex.3 @@ -0,0 +1,12 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_hostbased_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_hostbased_fromfile_ex - TODO +.SH SYNOPSIS +.nf +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH SEE ALSO diff --git a/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive.3 b/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive.3 new file mode 100644 index 0000000000000000000000000000000000000000..902cc5d24397f9eeae433846473f49bf77212c2c --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_keyboard_interactive 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_userauth_keyboard_interactive - convenience macro for \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION* session, + const char *username, + LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC((*response_callback))); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_keyboard_interactive_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive_ex.3 b/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..91b0e72ea2e75e923685bef30d0f8a4acd45ee6f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_keyboard_interactive_ex.3 @@ -0,0 +1,61 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2" +.SH NAME +libssh2_userauth_keyboard_interactive_ex - authenticate a session using +keyboard-interactive authentication +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len, + LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback)); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +\fIlibssh2_session_init_ex(3)\fP. + +\fIusername\fP - Name of user to attempt keyboard-interactive authentication +for. + +\fIusername_len\fP - Length of username parameter. + +\fIresponse_callback\fP - As authentication proceeds, the host issues several +(1 or more) challenges and requires responses. This callback will be called at +this moment. The callback is responsible to obtain responses for the +challenges, fill the provided data structure and then return +control. Responses will be sent to the host. String values will be free(3)ed +by the library. The callback prototype must match this: + +.nf +void response(const char *name, + int name_len, const char *instruction, + int instruction_len, + int num_prompts, + const LIBSSH2_USERAUTH_KBDINT_PROMPT *prompts, + LIBSSH2_USERAUTH_KBDINT_RESPONSE *responses, + void **abstract); +.fi + +Attempts keyboard-interactive (challenge/response) authentication. + +Note that many SSH servers will always issue a single "password" challenge, +requesting actual password as response, but it is not required by the +protocol, and various authentication schemes, such as smartcard authentication +may use keyboard-interactive authentication type too. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN +when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative +number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password +or public/private key. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_list.3 b/miniconda3/share/man/man3/libssh2_userauth_list.3 new file mode 100644 index 0000000000000000000000000000000000000000..e4d23f8af827617c0ab4d7dbc416367c605e996f --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_list.3 @@ -0,0 +1,43 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_list - list supported authentication methods +.SH SYNOPSIS +.nf +#include + +char * +libssh2_userauth_list(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Username which will be used while authenticating. Note that +most server implementations do not permit attempting authentication with +different usernames between requests. Therefore this must be the same username +you will use on later userauth calls. + +\fIusername_len\fP - Length of username parameter. + +Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the remote +host is configured to accept none as a viable authentication scheme +(unlikely), it will return \fBSSH_USERAUTH_FAILURE\fP along with a listing of +what authentication schemes it does support. In the unlikely event that none +authentication succeeds, this method with return NULL. This case may be +distinguished from a failing case by examining +\fIlibssh2_userauth_authenticated(3)\fP. +.SH RETURN VALUE +On success a comma delimited list of supported authentication schemes. This +list is internally managed by libssh2. On failure returns NULL. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_password.3 b/miniconda3/share/man/man3/libssh2_userauth_password.3 new file mode 100644 index 0000000000000000000000000000000000000000..61fcdbb19b8199898365f232010d80f27c14352a --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_password.3 @@ -0,0 +1,23 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_password 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_userauth_password - convenience macro for \fIlibssh2_userauth_password_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_password(LIBSSH2_SESSION *session, + const char *username, + const char *password); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_password_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_password_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_password_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_password_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_password_ex.3 b/miniconda3/share/man/man3/libssh2_userauth_password_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..e2bd20f29ff46fd0e0e5d92b204734c60eaf5e69 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_password_ex.3 @@ -0,0 +1,60 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_password_ex - authenticate a session with username and password +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_password_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len, + const char *password, + unsigned int password_len, + LIBSSH2_PASSWD_CHANGEREQ_FUNC((*passwd_change_cb))); + +#define libssh2_userauth_password(session, username, password) \\ + libssh2_userauth_password_ex((session), (username), \\ + strlen(username), \\ + (password), strlen(password), NULL) +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Name of user to attempt plain password authentication for. + +\fIusername_len\fP - Length of username parameter. + +\fIpassword\fP - Password to use for authenticating username. + +\fIpassword_len\fP - Length of password parameter. + +\fIpasswd_change_cb\fP - If the host accepts authentication but +requests that the password be changed, this callback will be issued. +If no callback is defined, but server required password change, +authentication will fail. + +Attempt basic password authentication. Note that many SSH servers +which appear to support ordinary password authentication actually have +it disabled and use Keyboard Interactive authentication (routed via +PAM or another authentication backed) instead. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +Some of the errors this function may return include: + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_PASSWORD_EXPIRED\fP - + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password +or public/private key. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_publickey.3 b/miniconda3/share/man/man3/libssh2_userauth_publickey.3 new file mode 100644 index 0000000000000000000000000000000000000000..ea282b199e06dc155a3487a2caa76f643e2ba6b5 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_publickey.3 @@ -0,0 +1,31 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_publickey 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_publickey - authenticate using a callback function +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_publickey(LIBSSH2_SESSION *session, + const char *user, + const unsigned char *pubkeydata, + size_t pubkeydata_len, + sign_callback, + void **abstract); +.fi +.SH DESCRIPTION +Authenticate with the \fIsign_callback\fP callback that matches the prototype +below +.SH CALLBACK +.nf +int name(LIBSSH2_SESSION *session, unsigned char **sig, size_t *sig_len, + const unsigned char *data, size_t data_len, void **abstract); +.fi + +This function gets called... +.SH RETURN VALUE +Return 0 on success or negative on failure. +.SH SEE ALSO +.BR libssh2_userauth_publickey_fromfile_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile.3 b/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile.3 new file mode 100644 index 0000000000000000000000000000000000000000..7614c9e6012bc82a307311b73ee0ab4b135a4ab9 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile.3 @@ -0,0 +1,25 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_publickey_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" +.SH NAME +libssh2_userauth_publickey_fromfile - convenience macro for \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP calls +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_publickey_fromfile(LIBSSH2_SESSION *session, + const char *username, + const char *publickey, + const char *privatekey, + const char *passphrase); +.fi +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_publickey_fromfile_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile_ex.3 b/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile_ex.3 new file mode 100644 index 0000000000000000000000000000000000000000..dcd5db369f8ab02c46fd8b19fff122bc83ecb565 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_publickey_fromfile_ex.3 @@ -0,0 +1,57 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_publickey_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" +.SH NAME +libssh2_userauth_publickey_fromfile_ex - authenticate a session with a public key, read from a file +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len, + const char *publickey, + const char *privatekey, + const char *passphrase); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +\fBlibssh2_session_init_ex(3)\fP + +\fIusername\fP - Pointer to user name to authenticate as. + +\fIusername_len\fP - Length of \fIusername\fP. + +\fIpublickey\fP - Path name of the public key file. +(e.g. /etc/ssh/hostkey.pub). If libssh2 is built against OpenSSL, this option +can be set to NULL. + +\fIprivatekey\fP - Path name of the private key file. (e.g. /etc/ssh/hostkey) + +\fIpassphrase\fP - Passphrase to use when decoding \fIprivatekey\fP. + +Attempt public key authentication using either a public key file or a PEM +encoded private key file stored on disk. When providing a private key, the +public key is automatically extracted from it. When providing both, the +passed public key takes precedence. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_FILE\fP - An issue opening, reading or parsing the disk file. + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_PUBLICKEY_UNVERIFIED\fP - The username/public key +combination was invalid. + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - Authentication using the supplied +public key was not accepted. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_publickey_frommemory.3 b/miniconda3/share/man/man3/libssh2_userauth_publickey_frommemory.3 new file mode 100644 index 0000000000000000000000000000000000000000..e6ced00316f5217706ec3ac844bf0847af67ebe4 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_publickey_frommemory.3 @@ -0,0 +1,62 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_publickey_frommemory 3 "1 Sep 2014" "libssh2" "libssh2" +.SH NAME +libssh2_userauth_publickey_frommemory - authenticate a session with a public key, read from memory +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_publickey_frommemory(LIBSSH2_SESSION *session, + const char *username, + size_t username_len, + const char *publickeydata, + size_t publickeydata_len, + const char *privatekeydata, + size_t privatekeydata_len, + const char *passphrase); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Remote user name to authenticate as. + +\fIusername_len\fP - Length of username. + +\fIpublickeydata\fP - Buffer containing the contents of a public key file. + +\fIpublickeydata_len\fP - Length of public key data. + +\fIprivatekeydata\fP - Buffer containing the contents of a private key file. + +\fIprivatekeydata_len\fP - Length of private key data. + +\fIpassphrase\fP - Passphrase to use when decoding private key file. + +Attempt public key authentication using either a public key file or a PEM +encoded private key file stored in memory. When providing a private key, the +public key is automatically extracted from it. When providing both, the +passed public key takes precedence. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_PUBLICKEY_UNVERIFIED\fP - The username/public key +combination was invalid. + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - Authentication using the supplied +public key was not accepted. +.SH AVAILABILITY +libssh2_userauth_publickey_frommemory was added in libssh2 1.6.0 +Supported with OpenSSL, WinCNG, mbedTLS, OS/400 crypto backends. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_userauth_publickey_sk.3 b/miniconda3/share/man/man3/libssh2_userauth_publickey_sk.3 new file mode 100644 index 0000000000000000000000000000000000000000..e2eff8f274398e4de8c4c626ef5fc508e37ca6bb --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_userauth_publickey_sk.3 @@ -0,0 +1,144 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_userauth_publickey_sk 3 "1 Jun 2022" "libssh2" "libssh2" +.SH NAME +libssh2_userauth_publickey_sk - authenticate a session with a FIDO2 authenticator +.SH SYNOPSIS +.nf +#include + +int +libssh2_userauth_publickey_sk(LIBSSH2_SESSION *session, + const char *username, + size_t username_len, + const unsigned char *publickeydata, + size_t publickeydata_len, + const char *privatekeydata, + size_t privatekeydata_len, + const char *passphrase, + LIBSSH2_USERAUTH_SK_SIGN_FUNC((*sign_callback)), + void **abstract); +.fi +.SH CALLBACK +.nf +#define LIBSSH2_SK_PRESENCE_REQUIRED 0x01 +#define LIBSSH2_SK_VERIFICATION_REQUIRED 0x04 + +typedef struct _LIBSSH2_SK_SIG_INFO { + uint8_t flags; + uint32_t counter; + unsigned char *sig_r; + size_t sig_r_len; + unsigned char *sig_s; + size_t sig_s_len; +} LIBSSH2_SK_SIG_INFO; + +int name(LIBSSH2_SESSION *session, LIBSSH2_SK_SIG_INFO *sig_info, + const unsigned char *data, size_t data_len, int algorithm, + uint8_t flags, const char *application, + const unsigned char *key_handle, size_t handle_len, + void **abstract); +.fi +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Name of user to attempt authentication for. + +\fIusername_len\fP - Length of username parameter. + +\fIpublickeydata\fP - Buffer containing the contents of a public key file. If +NULL, the public key will be extracted from the privatekeydata. When using +certificate authentication, this buffer should contain the public certificate +data. + +\fIpublickeydata_len\fP - Length of public key data. + +\fIprivatekeydata\fP - Buffer containing the contents of a private key file. + +\fIprivatekeydata_len\fP - Length of private key data. + +\fIpassphrase\fP - Passphrase to use when decoding private key file. + +\fIsign_callback\fP - Callback to communicate with FIDO2 authenticator. + +\fIabstract\fP - User-provided data to pass to callback. + +Attempt FIDO2 authentication. using either the sk-ssh-ed25519@openssh.com or +sk-ecdsa-sha2-nistp256@openssh.com key exchange algorithms. + +This function is only supported when libssh2 is backed by OpenSSL. + +.SH CALLBACK DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIsig_info\fP - Filled in by the callback with the signature and accompanying +information from the authenticator. + +\fIdata\fP - The data to sign. + +\fIdata_len\fP - The length of the data parameter. + +\fIalgorithm\fP - The signing algorithm to use. Possible values are +LIBSSH2_HOSTKEY_TYPE_ED25519 and LIBSSH2_HOSTKEY_TYPE_ECDSA_256. + +\fIflags\fP - A bitmask specifying options for the authenticator. When +LIBSSH2_SK_PRESENCE_REQUIRED is set, the authenticator requires a touch. When +LIBSSH2_SK_VERIFICATION_REQUIRED is set, the authenticator requires a PIN. +Many servers and authenticators do not work properly when +LIBSSH2_SK_PRESENCE_REQUIRED is not set. + +\fIapplication\fP - A user-defined string to use as the RP name for the +authenticator. Usually "ssh:". + +\fIkey_handle\fP - The key handle to use for the authenticator's allow list. + +\fIhandle_len\fP - The length of the key_handle parameter. + +\fIabstract\fP - User-defined data. When a PIN is required, use this to pass in +the PIN, or a function pointer to retrieve the PIN. + +The \fIsign_callback\fP is responsible for communicating with the hardware +authenticator to generate a signature. On success, the signature information +must be placed in the `\fIsig_info\fP sig_info parameter and the callback must +return 0. On failure, it should return a negative number. + +The fields of the LIBSSH2_SK_SIG_INFO are as follows. + +\fIflags\fP - A bitmask specifying options for the authenticator. This should +be read from the authenticator and not merely copied from the flags parameter +to the callback. + +\fIcounter\fP - A value returned from the authenticator. + +\fIsig_r\fP - For Ed25519 signatures, this contains the entire signature, as +returned directly from the authenticator. For ECDSA signatures, this contains +the r component of the signature in a big-endian binary representation. For +both algorithms, use LIBSSH2_ALLOC to allocate memory. It will be freed by the +caller. + +\fIsig_r_len\fP - The length of the sig_r parameter. + +\fIsig_s\fP - For ECDSA signatures, this contains the s component of the +signature in a big-endian binary representation. Use LIBSSH2_ALLOC to allocate +memory. It will be freed by the caller. For Ed25519 signatures, set this to +NULL. + +\fIsig_s_len\fP - The length of the sig_s parameter. +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. +.SH ERRORS +Some of the errors this function may return include: + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/key. +.SH AVAILABILITY +Added in libssh2 1.10.0 +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/miniconda3/share/man/man3/libssh2_version.3 b/miniconda3/share/man/man3/libssh2_version.3 new file mode 100644 index 0000000000000000000000000000000000000000..3f36d717e846c9f37a0a874798467af106d61fd3 --- /dev/null +++ b/miniconda3/share/man/man3/libssh2_version.3 @@ -0,0 +1,42 @@ +.\" Copyright (C) The libssh2 project and its contributors. +.\" SPDX-License-Identifier: BSD-3-Clause +.TH libssh2_version 3 "23 Feb 2009" "libssh2" "libssh2" +.SH NAME +libssh2_version - return the libssh2 version number +.SH SYNOPSIS +.nf +#include + +const char * +libssh2_version(int required_version); +.fi +.SH DESCRIPTION +If \fIrequired_version\fP is lower than or equal to the version number of the +libssh2 in use, the version number of libssh2 is returned as a pointer to a +zero terminated string. + +The \fIrequired_version\fP should be the version number as constructed by the +LIBSSH2_VERSION_NUM define in the libssh2.h public header file, which is a 24 +bit number in the 0xMMmmpp format. MM for major, mm for minor and pp for patch +number. +.SH RETURN VALUE +The version number of libssh2 is returned as a pointer to a zero terminated +string or NULL if the \fIrequired_version\fP is not fulfilled. +.SH EXAMPLE +To make sure you run with the correct libssh2 version: + +.nf +if(!libssh2_version(LIBSSH2_VERSION_NUM)) { + fprintf(stderr, \&"Runtime libssh2 version too old.\&"); + exit(1); +} +.fi + +Unconditionally get the version number: + +.nf +printf(\&"libssh2 version: %s\&", libssh2_version(0)); +.fi +.SH AVAILABILITY +This function was added in libssh2 1.1, in previous versions there way no way +to extract this info in run-time. diff --git a/miniconda3/share/man/man3/ngettext.3 b/miniconda3/share/man/man3/ngettext.3 new file mode 100644 index 0000000000000000000000000000000000000000..93c5149fa750e4b8c418c4314c2aac971f785694 --- /dev/null +++ b/miniconda3/share/man/man3/ngettext.3 @@ -0,0 +1,60 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH NGETTEXT 3 "May 2001" "GNU gettext 0.25.1" +.SH NAME +ngettext, dngettext, dcngettext \- translate message and choose plural form +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * ngettext (const char * " msgid ", const char * " msgid_plural , +.BI " unsigned long int " n ); +.BI "char * dngettext (const char * " domainname , +.BI " const char * " msgid ", const char * " msgid_plural , +.BI " unsigned long int " n ); +.BI "char * dcngettext (const char * " domainname , +.BI " const char * " msgid ", const char * " msgid_plural , +.BI " unsigned long int " n ", int " category ); +.fi +.SH DESCRIPTION +The \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP functions attempt to +translate a text string into the user's native language, by looking up the +appropriate plural form of the translation in a message catalog. +.PP +Plural forms are grammatical variants depending on the a number. Some languages +have two forms, called singular and plural. Other languages have three forms, +called singular, dual and plural. There are also languages with four forms. +.PP +The \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP functions work like +the \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions, respectively. +Additionally, they choose the appropriate plural form, which depends on the +number \fIn\fP and the language of the message catalog where the translation +was found. +.PP +In the "C" locale, or if none of the used catalogs contain a translation for +\fImsgid\fP, the \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP functions +return \fImsgid\fP if \fIn\fP == 1, or \fImsgid_plural\fP if \fIn\fP != 1. +.SH "RETURN VALUE" +If a translation was found in one of the specified catalogs, the appropriate +plural form is converted to the locale's codeset and returned. The resulting +string is statically allocated and must not be modified or freed. Otherwise +\fImsgid\fP or \fImsgid_plural\fP is returned, as described above. +.SH ERRORS +\fBerrno\fP is not modified. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.SH "SEE ALSO" +.BR gettext (3), +.BR dgettext (3), +.BR dcgettext (3) diff --git a/miniconda3/share/man/man3/pcre2.3 b/miniconda3/share/man/man3/pcre2.3 new file mode 100644 index 0000000000000000000000000000000000000000..32c7c9c56d1380fee20917affecc89d73fed45e6 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2.3 @@ -0,0 +1,211 @@ +.TH PCRE2 3 "18 December 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH INTRODUCTION +.rs +.sp +PCRE2 is the name used for a revised API for the PCRE library, which is a set +of functions, written in C, that implement regular expression pattern matching +using the same syntax and semantics as Perl, with just a few differences. After +nearly two decades, the limitations of the original API were making development +increasingly difficult. The new API is more extensible, and it was simplified +by abolishing the separate "study" optimizing function; in PCRE2, patterns are +automatically optimized where possible. Since forking from PCRE1, the code has +been extensively refactored and new features introduced. The old library is now +obsolete and is no longer maintained. +.P +As well as Perl-style regular expression patterns, some features that appeared +in Python and the original PCRE before they appeared in Perl are available +using the Python syntax. There is also some support for one or two .NET and +Oniguruma syntax items, and there are options for requesting some minor changes +that give better ECMAScript (aka JavaScript) compatibility. +.P +The source code for PCRE2 can be compiled to support strings of 8-bit, 16-bit, +or 32-bit code units, which means that up to three separate libraries may be +installed, one for each code unit size. The size of code unit is not related to +the bit size of the underlying hardware. In a 64-bit environment that also +supports 32-bit applications, versions of PCRE2 that are compiled in both +64-bit and 32-bit modes may be needed. +.P +The original work to extend PCRE to 16-bit and 32-bit code units was done by +Zoltan Herczeg and Christian Persch, respectively. In all three cases, strings +can be interpreted either as one character per code unit, or as UTF-encoded +Unicode, with support for Unicode general category properties. Unicode support +is optional at build time (but is the default). However, processing strings as +UTF code units must be enabled explicitly at run time. The version of Unicode +in use can be discovered by running +.sp + pcre2test -C +.P +The three libraries contain identical sets of functions, with names ending in +_8, _16, or _32, respectively (for example, \fBpcre2_compile_8()\fP). However, +by defining PCRE2_CODE_UNIT_WIDTH to be 8, 16, or 32, a program that uses just +one code unit width can be written using generic names such as +\fBpcre2_compile()\fP, and the documentation is written assuming that this is +the case. +.P +In addition to the Perl-compatible matching function, PCRE2 contains an +alternative function that matches the same compiled patterns in a different +way. In certain circumstances, the alternative function has some advantages. +For a discussion of the two matching algorithms, see the +.\" HREF +\fBpcre2matching\fP +.\" +page. +.P +Details of exactly which Perl regular expression features are and are not +supported by PCRE2 are given in separate documents. See the +.\" HREF +\fBpcre2pattern\fP +.\" +and +.\" HREF +\fBpcre2compat\fP +.\" +pages. There is a syntax summary in the +.\" HREF +\fBpcre2syntax\fP +.\" +page. +.P +Some features of PCRE2 can be included, excluded, or changed when the library +is built. The +.\" HREF +\fBpcre2_config()\fP +.\" +function makes it possible for a client to discover which features are +available. The features themselves are described in the +.\" HREF +\fBpcre2build\fP +.\" +page. Documentation about building PCRE2 for various operating systems can be +found in the +.\" HTML +.\" +\fBREADME\fP +.\" +and +.\" HTML +.\" +\fBNON-AUTOTOOLS_BUILD\fP +.\" +files in the source distribution. +.P +The libraries contains a number of undocumented internal functions and data +tables that are used by more than one of the exported external functions, but +which are not intended for use by external callers. Their names all begin with +"_pcre2", which hopefully will not provoke any name clashes. In some +environments, it is possible to control which external symbols are exported +when a shared library is built, and in these cases the undocumented symbols are +not exported. +. +. +.SH "SECURITY CONSIDERATIONS" +.rs +.sp +If you are using PCRE2 in a non-UTF application that permits users to supply +arbitrary patterns for compilation, you should be aware of a feature that +allows users to turn on UTF support from within a pattern. For example, an +8-bit pattern that begins with "(*UTF)" turns on UTF-8 mode, which interprets +patterns and subjects as strings of UTF-8 code units instead of individual +8-bit characters. This causes both the pattern and any data against which it is +matched to be checked for UTF-8 validity. If the data string is very long, such +a check might use sufficiently many resources as to cause your application to +lose performance. +.P +One way of guarding against this possibility is to use the +\fBpcre2_pattern_info()\fP function to check the compiled pattern's options for +PCRE2_UTF. Alternatively, you can set the PCRE2_NEVER_UTF option when calling +\fBpcre2_compile()\fP. This causes a compile time error if the pattern contains +a UTF-setting sequence. +.P +The use of Unicode properties for character types such as \ed can also be +enabled from within the pattern, by specifying "(*UCP)". This feature can be +disallowed by setting the PCRE2_NEVER_UCP option. +.P +If your application is one that supports UTF, be aware that validity checking +can take time. If the same data string is to be matched many times, you can use +the PCRE2_NO_UTF_CHECK option for the second and subsequent matches to avoid +running redundant checks. +.P +The use of the \eC escape sequence in a UTF-8 or UTF-16 pattern can lead to +problems, because it may leave the current matching point in the middle of a +multi-code-unit character. The PCRE2_NEVER_BACKSLASH_C option can be used by an +application to lock out the use of \eC, causing a compile-time error if it is +encountered. It is also possible to build PCRE2 with the use of \eC permanently +disabled. +.P +Another way that performance can be hit is by running a pattern that has a very +large search tree against a string that will never match. Nested unlimited +repeats in a pattern are a common example. PCRE2 provides some protection +against this: see the \fBpcre2_set_match_limit()\fP function in the +.\" HREF +\fBpcre2api\fP +.\" +page. There is a similar function called \fBpcre2_set_depth_limit()\fP that can +be used to restrict the amount of memory that is used. +. +. +.SH "USER DOCUMENTATION" +.rs +.sp +The user documentation for PCRE2 comprises a number of different sections. In +the "man" format, each of these is a separate "man page". In the HTML format, +each is a separate page, linked from the index page. In the plain text format, +the descriptions of the \fBpcre2grep\fP and \fBpcre2test\fP programs are in +files called \fBpcre2grep.txt\fP and \fBpcre2test.txt\fP, respectively. The +remaining sections, except for the \fBpcre2demo\fP section (which is a program +listing), and the short pages for individual functions, are concatenated in +\fBpcre2.txt\fP, for ease of searching. The sections are as follows: +.sp + pcre2 this document + pcre2-config show PCRE2 installation configuration information + pcre2api details of PCRE2's native C API + pcre2build building PCRE2 + pcre2callout details of the pattern callout feature + pcre2compat discussion of Perl compatibility + pcre2convert details of pattern conversion functions + pcre2demo a demonstration C program that uses PCRE2 + pcre2grep description of the \fBpcre2grep\fP command (8-bit only) + pcre2jit discussion of just-in-time optimization support + pcre2limits details of size and other limits + pcre2matching discussion of the two matching algorithms + pcre2partial details of the partial matching facility +.\" JOIN + pcre2pattern syntax and semantics of supported regular + expression patterns + pcre2perform discussion of performance issues + pcre2posix the POSIX-compatible C API for the 8-bit library + pcre2sample discussion of the pcre2demo program + pcre2serialize details of pattern serialization + pcre2syntax quick syntax reference + pcre2test description of the \fBpcre2test\fP command + pcre2unicode discussion of Unicode and UTF support +.sp +In the "man" and HTML formats, there is also a short page for each C library +function, listing its arguments and results. +. +. +.SH AUTHORS +.rs +.sp +The current maintainers of PCRE2 are Nicholas Wilson and Zoltan Herczeg. +.P +PCRE2 was written by Philip Hazel, of the University Computing Service, +Cambridge, England. Many others have also contributed. +.P +To contact the maintainers, please use the GitHub issues tracker or PCRE2 +mailing list, as described at the project page: +.\" HTML +.\" +https://github.com/PCRE2Project/pcre2 +.\" +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 18 December 2024 +Copyright (c) 1997-2021 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2_callout_enumerate.3 b/miniconda3/share/man/man3/pcre2_callout_enumerate.3 new file mode 100644 index 0000000000000000000000000000000000000000..0c241146e1a510dce70aaa3d4b0e718f6bef9b5f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_callout_enumerate.3 @@ -0,0 +1,51 @@ +.TH PCRE2_COMPILE 3 "23 March 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_callout_enumerate(const pcre2_code *\fIcode\fP, +.B " int (*\fIcallback\fP)(pcre2_callout_enumerate_block *, void *)," +.B " void *\fIcallout_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function scans a compiled regular expression and calls the \fIcallback()\fP +function for each callout within the pattern. The yield of the function is zero +for success and non-zero otherwise. The arguments are: +.sp + \fIcode\fP Points to the compiled pattern + \fIcallback\fP The callback function + \fIcallout_data\fP User data that is passed to the callback +.sp +The \fIcallback()\fP function is passed a pointer to a data block containing +the following fields (not necessarily in this order): +.sp + uint32_t \fIversion\fP Block version number + uint32_t \fIcallout_number\fP Number for numbered callouts + PCRE2_SIZE \fIpattern_position\fP Offset to next item in pattern + PCRE2_SIZE \fInext_item_length\fP Length of next item in pattern + PCRE2_SIZE \fIcallout_string_offset\fP Offset to string within pattern + PCRE2_SIZE \fIcallout_string_length\fP Length of callout string + PCRE2_SPTR \fIcallout_string\fP Points to callout string or is NULL +.sp +The second argument passed to the \fBcallback()\fP function is the callout data +that was passed to \fBpcre2_callout_enumerate()\fP. The \fBcallback()\fP +function must return zero for success. Any other value causes the pattern scan +to stop, with the value being passed back as the result of +\fBpcre2_callout_enumerate()\fP. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_code_copy.3 b/miniconda3/share/man/man3/pcre2_code_copy.3 new file mode 100644 index 0000000000000000000000000000000000000000..f7a2d789ed922ab39f66143293b5f0943bdac9c4 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_code_copy.3 @@ -0,0 +1,31 @@ +.TH PCRE2_CODE_COPY 3 "22 November 2016" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_code *pcre2_code_copy(const pcre2_code *\fIcode\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function makes a copy of the memory used for a compiled pattern, excluding +any memory used by the JIT compiler. Without a subsequent call to +\fBpcre2_jit_compile()\fP, the copy can be used only for non-JIT matching. The +pointer to the character tables is copied, not the tables themselves (see +\fBpcre2_code_copy_with_tables()\fP). The yield of the function is NULL if +\fIcode\fP is NULL or if sufficient memory cannot be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_code_copy_with_tables.3 b/miniconda3/share/man/man3/pcre2_code_copy_with_tables.3 new file mode 100644 index 0000000000000000000000000000000000000000..ebde43b8d1f0abfeb4d237aa53ecf4341a55191d --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_code_copy_with_tables.3 @@ -0,0 +1,32 @@ +.TH PCRE2_CODE_COPY 3 "16 January 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_code *pcre2_code_copy_with_tables(const pcre2_code *\fIcode\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function makes a copy of the memory used for a compiled pattern, excluding +any memory used by the JIT compiler. Without a subsequent call to +\fBpcre2_jit_compile()\fP, the copy can be used only for non-JIT matching. +Unlike \fBpcre2_code_copy()\fP, a separate copy of the character tables is also +made, with the new code pointing to it. This memory will be automatically freed +when \fBpcre2_code_free()\fP is called. The yield of the function is NULL if +\fIcode\fP is NULL or if sufficient memory cannot be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_code_free.3 b/miniconda3/share/man/man3/pcre2_code_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..101d3950e9132e45684664004e5af700e419ad4e --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_code_free.3 @@ -0,0 +1,30 @@ +.TH PCRE2_CODE_FREE 3 "28 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_code_free(pcre2_code *\fIcode\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +If \fIcode\fP is NULL, this function does nothing. Otherwise, \fIcode\fP must +point to a compiled pattern. This function frees its memory, including any +memory used by the JIT compiler. If the compiled pattern was created by a call +to \fBpcre2_code_copy_with_tables()\fP, the memory for the character tables is +also freed. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_compile.3 b/miniconda3/share/man/man3/pcre2_compile.3 new file mode 100644 index 0000000000000000000000000000000000000000..e2dab6258ae5ddb58eaeb624b5795d8c58cd1d14 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_compile.3 @@ -0,0 +1,107 @@ +.TH PCRE2_COMPILE 3 "30 October 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_code *pcre2_compile(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, int *\fIerrorcode\fP, PCRE2_SIZE *\fIerroroffset,\fP" +.B " pcre2_compile_context *\fIccontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function compiles a regular expression pattern into an internal form. Its +arguments are: +.sp + \fIpattern\fP A string containing expression to be compiled + \fIlength\fP The length of the string or PCRE2_ZERO_TERMINATED + \fIoptions\fP Primary option bits + \fIerrorcode\fP Where to put an error code + \fIerroffset\fP Where to put an error offset + \fIccontext\fP Pointer to a compile context or NULL +.sp +The length of the pattern and any error offset that is returned are in code +units, not characters. A NULL pattern with zero length is treated as an empty +string. A compile context is needed only if you want to provide custom memory +allocation functions, or to provide an external function for system stack size +checking (see \fBpcre2_set_compile_recursion_guard()\fP), or to change one or +more of these parameters: +.sp + What \eR matches (Unicode newlines, or CR, LF, CRLF only); + PCRE2's character tables; + The newline character sequence; + The compile time nested parentheses limit; + The maximum pattern length (in code units) that is allowed; + The additional options bits. +.sp +The primary option bits are: +.sp + PCRE2_ANCHORED Force pattern anchoring + PCRE2_ALLOW_EMPTY_CLASS Allow empty classes + PCRE2_ALT_BSUX Alternative handling of \eu, \eU, and \ex + PCRE2_ALT_CIRCUMFLEX Alternative handling of ^ in multiline mode + PCRE2_ALT_EXTENDED_CLASS Alternative extended character class syntax + PCRE2_ALT_VERBNAMES Process backslashes in verb names + PCRE2_AUTO_CALLOUT Compile automatic callouts + PCRE2_CASELESS Do caseless matching + PCRE2_DOLLAR_ENDONLY $ not to match newline at end + PCRE2_DOTALL . matches anything including NL + PCRE2_DUPNAMES Allow duplicate names for subpatterns + PCRE2_ENDANCHORED Pattern can match only at end of subject + PCRE2_EXTENDED Ignore white space and # comments + PCRE2_FIRSTLINE Force matching to be before newline + PCRE2_LITERAL Pattern characters are all literal + PCRE2_MATCH_INVALID_UTF Enable support for matching invalid UTF + PCRE2_MATCH_UNSET_BACKREF Match unset backreferences + PCRE2_MULTILINE ^ and $ match newlines within data + PCRE2_NEVER_BACKSLASH_C Lock out the use of \eC in patterns + PCRE2_NEVER_UCP Lock out PCRE2_UCP, e.g. via (*UCP) + PCRE2_NEVER_UTF Lock out PCRE2_UTF, e.g. via (*UTF) + PCRE2_NO_AUTO_CAPTURE Disable numbered capturing paren- + theses (named ones available) + PCRE2_NO_AUTO_POSSESS Disable auto-possessification + PCRE2_NO_DOTSTAR_ANCHOR Disable automatic anchoring for .* + PCRE2_NO_START_OPTIMIZE Disable match-time start optimizations + PCRE2_NO_UTF_CHECK Do not check the pattern for UTF validity + (only relevant if PCRE2_UTF is set) + PCRE2_UCP Use Unicode properties for \ed, \ew, etc. + PCRE2_UNGREEDY Invert greediness of quantifiers + PCRE2_USE_OFFSET_LIMIT Enable offset limit for unanchored matching + PCRE2_UTF Treat pattern and subjects as UTF strings +.sp +PCRE2 must be built with Unicode support (the default) in order to use +PCRE2_UTF, PCRE2_UCP and related options. +.P +Additional options may be set in the compile context via the +.\" HREF +\fBpcre2_set_compile_extra_options\fP +.\" +function. +.P +If either of \fIerrorcode\fP or \fIerroroffset\fP is NULL, the function returns +NULL immediately. Otherwise, the yield of this function is a pointer to a +private data structure that contains the compiled pattern, or NULL if an error +was detected. In the error case, a text error message can be obtained by +passing the value returned via the \fIerrorcode\fP argument to the +\fBpcre2_get_error_message()\fP function. The offset (in code units) where the +error was encountered is returned via the \fIerroroffset\fP argument. +.P +If there is no error, the value passed via \fIerrorcode\fP returns the message +"no error" if passed to \fBpcre2_get_error_message()\fP, and the value passed +via \fIerroroffset\fP is zero. +.P +There is a complete description of the PCRE2 native API, with more detail on +each option, in the +.\" HREF +\fBpcre2api\fP +.\" +page, and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_compile_context_copy.3 b/miniconda3/share/man/man3/pcre2_compile_context_copy.3 new file mode 100644 index 0000000000000000000000000000000000000000..94a0c6ea49a5ea31f4ab9f5886e0dab67dbba011 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_compile_context_copy.3 @@ -0,0 +1,29 @@ +.TH PCRE2_COMPILE_CONTEXT_COPY 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_compile_context *pcre2_compile_context_copy( +.B " pcre2_compile_context *\fIccontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function makes a new copy of a compile context, using the memory +allocation function that was used for the original context. The result is NULL +if the memory cannot be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_compile_context_create.3 b/miniconda3/share/man/man3/pcre2_compile_context_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..9dcdaa390696a5e0afca239dc333319fb7adaa0f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_compile_context_create.3 @@ -0,0 +1,30 @@ +.TH PCRE2_COMPILE_CONTEXT_CREATE 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_compile_context *pcre2_compile_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function creates and initializes a new compile context. If its argument is +NULL, \fBmalloc()\fP is used to get the necessary memory; otherwise the memory +allocation function within the general context is used. The result is NULL if +the memory could not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_compile_context_free.3 b/miniconda3/share/man/man3/pcre2_compile_context_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..c9dd2606089e8bb3cf876efa68499b4eb983bec4 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_compile_context_free.3 @@ -0,0 +1,29 @@ +.TH PCRE2_COMPILE_CONTEXT_FREE 3 "28 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_compile_context_free(pcre2_compile_context *\fIccontext\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees the memory occupied by a compile context, using the memory +freeing function from the general context with which it was created, or +\fBfree()\fP if that was not set. If the argument is NULL, the function returns +immediately without doing anything. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_config.3 b/miniconda3/share/man/man3/pcre2_config.3 new file mode 100644 index 0000000000000000000000000000000000000000..37c1597ebe74142e5061ebbc6fd77ca50d5505f5 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_config.3 @@ -0,0 +1,76 @@ +.TH PCRE2_CONFIG 3 "16 September 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B int pcre2_config(uint32_t \fIwhat\fP, void *\fIwhere\fP); +. +.SH DESCRIPTION +.rs +.sp +This function makes it possible for a client program to find out which optional +features are available in the version of the PCRE2 library it is using. The +arguments are as follows: +.sp + \fIwhat\fP A code specifying what information is required + \fIwhere\fP Points to where to put the information +.sp +If \fIwhere\fP is NULL, the function returns the amount of memory needed for +the requested information. When the information is a string, the value is in +code units; for other types of data it is in bytes. +.P +If \fBwhere\fP is not NULL, for PCRE2_CONFIG_JITTARGET, +PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a +buffer that is large enough to hold the string. For all other codes it must +point to a uint32_t integer variable. The available codes are: +.sp + PCRE2_CONFIG_BSR Indicates what \eR matches by default: + PCRE2_BSR_UNICODE + PCRE2_BSR_ANYCRLF + PCRE2_CONFIG_COMPILED_WIDTHS Which of 8/16/32 support was compiled + PCRE2_CONFIG_DEPTHLIMIT Default backtracking depth limit + PCRE2_CONFIG_HEAPLIMIT Default heap memory limit +.\" JOIN + PCRE2_CONFIG_JIT Availability of just-in-time compiler + support (1=yes 0=no) +.\" JOIN + PCRE2_CONFIG_JITTARGET Information (a string) about the target + architecture for the JIT compiler + PCRE2_CONFIG_LINKSIZE Configured internal link size (2, 3, 4) + PCRE2_CONFIG_MATCHLIMIT Default internal resource limit + PCRE2_CONFIG_NEVER_BACKSLASH_C Whether or not \eC is disabled + PCRE2_CONFIG_NEWLINE Code for the default newline sequence: + PCRE2_NEWLINE_CR + PCRE2_NEWLINE_LF + PCRE2_NEWLINE_CRLF + PCRE2_NEWLINE_ANY + PCRE2_NEWLINE_ANYCRLF + PCRE2_NEWLINE_NUL + PCRE2_CONFIG_PARENSLIMIT Default parentheses nesting limit + PCRE2_CONFIG_RECURSIONLIMIT Obsolete: use PCRE2_CONFIG_DEPTHLIMIT + PCRE2_CONFIG_STACKRECURSE Obsolete: always returns 0 +.\" JOIN + PCRE2_CONFIG_UNICODE Availability of Unicode support (1=yes + 0=no) + PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string) + PCRE2_CONFIG_VERSION The PCRE2 version (a string) +.sp +The function yields a non-negative value on success or the negative value +PCRE2_ERROR_BADOPTION otherwise. This is also the result for the +PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is +requested, the function returns the number of code units used, including the +terminating zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_convert_context_copy.3 b/miniconda3/share/man/man3/pcre2_convert_context_copy.3 new file mode 100644 index 0000000000000000000000000000000000000000..5f91691f54cd161026665de2f976c3d1ab51d2e7 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_convert_context_copy.3 @@ -0,0 +1,26 @@ +.TH PCRE2_CONVERT_CONTEXT_COPY 3 "12 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_convert_context *pcre2_convert_context_copy( +.B " pcre2_convert_context *\fIcvcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It makes a new copy of a convert context, using the memory allocation function +that was used for the original context. The result is NULL if the memory cannot +be obtained. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_convert_context_create.3 b/miniconda3/share/man/man3/pcre2_convert_context_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..73ccff48b3c83ddfd9e34de6a50219b0c434f83a --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_convert_context_create.3 @@ -0,0 +1,27 @@ +.TH PCRE2_CONVERT_CONTEXT_CREATE 3 "12 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_convert_context *pcre2_convert_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It creates and initializes a new convert context. If its argument is +NULL, \fBmalloc()\fP is used to get the necessary memory; otherwise the memory +allocation function within the general context is used. The result is NULL if +the memory could not be obtained. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_convert_context_free.3 b/miniconda3/share/man/man3/pcre2_convert_context_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..6ae3541fdc0af9b631130cc0430c7a3ea2098d36 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_convert_context_free.3 @@ -0,0 +1,26 @@ +.TH PCRE2_CONVERT_CONTEXT_FREE 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_convert_context_free(pcre2_convert_context *\fIcvcontext\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It frees the memory occupied by a convert context, using the memory +freeing function from the general context with which it was created, or +\fBfree()\fP if that was not set. If the argument is NULL, the function returns +immediately without doing anything. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_converted_pattern_free.3 b/miniconda3/share/man/man3/pcre2_converted_pattern_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..d0c60ca6a372b5d84e71807cd4335b1bfce885bb --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_converted_pattern_free.3 @@ -0,0 +1,26 @@ +.TH PCRE2_CONVERTED_PATTERN_FREE 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_converted_pattern_free(PCRE2_UCHAR *\fIconverted_pattern\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It frees the memory occupied by a converted pattern that was obtained by +calling \fBpcre2_pattern_convert()\fP with arguments that caused it to place +the converted pattern into newly obtained heap memory. If the argument is NULL, +the function returns immediately without doing anything. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_dfa_match.3 b/miniconda3/share/man/man3/pcre2_dfa_match.3 new file mode 100644 index 0000000000000000000000000000000000000000..299a7f8a1a99ec5bbb49db31a2f917063f8cf629 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_dfa_match.3 @@ -0,0 +1,86 @@ +.TH PCRE2_DFA_MATCH 3 "31 August 2021" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_dfa_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP," +.B " int *\fIworkspace\fP, PCRE2_SIZE \fIwscount\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function matches a compiled regular expression against a given subject +string, using an alternative matching algorithm that scans the subject string +just once (except when processing lookaround assertions). This function is +\fInot\fP Perl-compatible (the Perl-compatible matching function is +\fBpcre2_match()\fP). The arguments for this function are: +.sp + \fIcode\fP Points to the compiled pattern + \fIsubject\fP Points to the subject string + \fIlength\fP Length of the subject string + \fIstartoffset\fP Offset in the subject at which to start matching + \fIoptions\fP Option bits + \fImatch_data\fP Points to a match data block, for results + \fImcontext\fP Points to a match context, or is NULL + \fIworkspace\fP Points to a vector of ints used as working space + \fIwscount\fP Number of elements in the vector +.sp +The size of output vector needed to contain all the results depends on the +number of simultaneous matches, not on the number of parentheses in the +pattern. Using \fBpcre2_match_data_create_from_pattern()\fP to create the match +data block is therefore not advisable when using this function. +.P +A match context is needed only if you want to set up a callout function or +specify the heap limit or the match or the recursion depth limits. The +\fIlength\fP and \fIstartoffset\fP values are code units, not characters. The +options are: +.sp + PCRE2_ANCHORED Match only at the first position + PCRE2_COPY_MATCHED_SUBJECT + On success, make a private subject copy + PCRE2_ENDANCHORED Pattern can match only at end of subject + PCRE2_NOTBOL Subject is not the beginning of a line + PCRE2_NOTEOL Subject is not the end of a line + PCRE2_NOTEMPTY An empty string is not a valid match +.\" JOIN + PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject + is not a valid match +.\" JOIN + PCRE2_NO_UTF_CHECK Do not check the subject for UTF + validity (only relevant if PCRE2_UTF + was set at compile time) +.\" JOIN + PCRE2_PARTIAL_HARD Return PCRE2_ERROR_PARTIAL for a partial + match even if there is a full match +.\" JOIN + PCRE2_PARTIAL_SOFT Return PCRE2_ERROR_PARTIAL for a partial + match if no full matches are found + PCRE2_DFA_RESTART Restart after a partial match + PCRE2_DFA_SHORTEST Return only the shortest match +.sp +There are restrictions on what may appear in a pattern when using this matching +function. Details are given in the +.\" HREF +\fBpcre2matching\fP +.\" +documentation. For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_general_context_copy.3 b/miniconda3/share/man/man3/pcre2_general_context_copy.3 new file mode 100644 index 0000000000000000000000000000000000000000..a852018f83175b5740e1c5a180f992bae3ab6f6b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_general_context_copy.3 @@ -0,0 +1,30 @@ +.TH PCRE2_GENERAL_CONTEXT_COPY 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_general_context *pcre2_general_context_copy( +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function makes a new copy of a general context, using the memory +allocation functions in the context, if set, to get the necessary memory. +Otherwise \fBmalloc()\fP is used. The result is NULL if the memory cannot be +obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_general_context_create.3 b/miniconda3/share/man/man3/pcre2_general_context_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..445ca38ac2d4574fd3e3b1d39833a47a61107f61 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_general_context_create.3 @@ -0,0 +1,32 @@ +.TH PCRE2_GENERAL_CONTEXT_CREATE 3 "23 January 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_general_context *pcre2_general_context_create( +.B " void *(*\fIprivate_malloc\fP)(size_t, void *)," +.B " void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function creates and initializes a general context. The arguments define +custom memory management functions and a data value that is passed to them when +they are called. The \fBprivate_malloc()\fP function is used to get memory for +the context. If either of the first two arguments is NULL, the system memory +management function is used. The result is NULL if no memory could be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_general_context_free.3 b/miniconda3/share/man/man3/pcre2_general_context_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..83cd557165c4d351c6c3fbc7679e1ff4ff814b15 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_general_context_free.3 @@ -0,0 +1,28 @@ +.TH PCRE2_GENERAL_CONTEXT_FREE 3 "28 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_general_context_free(pcre2_general_context *\fIgcontext\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees the memory occupied by a general context, using the memory +freeing function within the context, if set. If the argument is NULL, the +function returns immediately without doing anything. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_error_message.3 b/miniconda3/share/man/man3/pcre2_get_error_message.3 new file mode 100644 index 0000000000000000000000000000000000000000..d86a671cc67f19578912f8f0434949c5dfe54b2f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_error_message.3 @@ -0,0 +1,39 @@ +.TH PCRE2_GET_ERROR_MESSAGE 3 "24 March 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_get_error_message(int \fIerrorcode\fP, PCRE2_UCHAR *\fIbuffer\fP, +.B " PCRE2_SIZE \fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function provides a textual error message for each PCRE2 error code. +Compilation errors are positive numbers; UTF formatting errors and matching +errors are negative numbers. The arguments are: +.sp + \fIerrorcode\fP an error code (positive or negative) + \fIbuffer\fP where to put the message + \fIbufflen\fP the length of the buffer (code units) +.sp +The function returns the length of the message in code units, excluding the +trailing zero, or the negative error code PCRE2_ERROR_NOMEMORY if the buffer is +too small. In this case, the returned message is truncated (but still with a +trailing zero). If \fIerrorcode\fP does not contain a recognized error code +number, the negative value PCRE2_ERROR_BADDATA is returned. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_mark.3 b/miniconda3/share/man/man3/pcre2_get_mark.3 new file mode 100644 index 0000000000000000000000000000000000000000..fd0725ccdf53456a697cd9e8583e67f8bad07d49 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_mark.3 @@ -0,0 +1,34 @@ +.TH PCRE2_GET_MARK 3 "13 January 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B PCRE2_SPTR pcre2_get_mark(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +After a call of \fBpcre2_match()\fP that was passed the match block that is +this function's argument, this function returns a pointer to the last (*MARK), +(*PRUNE), or (*THEN) name that was encountered during the matching process. The +name is zero-terminated, and is within the compiled pattern. The length of the +name is in the preceding code unit. If no name is available, NULL is returned. +.P +After a successful match, the name that is returned is the last one on the +matching path. After a failed match or a partial match, the last encountered +name is returned. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_match_data_heapframes_size.3 b/miniconda3/share/man/man3/pcre2_get_match_data_heapframes_size.3 new file mode 100644 index 0000000000000000000000000000000000000000..64a07f995641d11241a1dfd44c3db0fd8fb06be6 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_match_data_heapframes_size.3 @@ -0,0 +1,28 @@ +.TH PCRE2_GET_MATCH_DATA_HEAPFRAMES_SIZE 3 "18 January 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B PCRE2_SIZE pcre2_get_match_data_heapframes_size( +.B " pcre2_match_data *\fImatch_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the size, in bytes, of the heapframes data block that is +owned by its argument. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_match_data_size.3 b/miniconda3/share/man/man3/pcre2_get_match_data_size.3 new file mode 100644 index 0000000000000000000000000000000000000000..e5ba40252f09c46dee53775a7390013276bd977a --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_match_data_size.3 @@ -0,0 +1,27 @@ +.TH PCRE2_GET_MATCH_DATA_SIZE 3 "17 October 2019" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B PCRE2_SIZE pcre2_get_match_data_size(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the size, in bytes, of the match data block that is its +argument. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_ovector_count.3 b/miniconda3/share/man/man3/pcre2_get_ovector_count.3 new file mode 100644 index 0000000000000000000000000000000000000000..c41ed7f6f666a36037ae5d58f9713a8c92c6853d --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_ovector_count.3 @@ -0,0 +1,27 @@ +.TH PCRE2_GET_OVECTOR_COUNT 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B uint32_t pcre2_get_ovector_count(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the number of pairs of offsets in the ovector that forms +part of the given match data block. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_ovector_pointer.3 b/miniconda3/share/man/man3/pcre2_get_ovector_pointer.3 new file mode 100644 index 0000000000000000000000000000000000000000..9cf5e991a466e6a0b2d36f531525bc2c585bd502 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_ovector_pointer.3 @@ -0,0 +1,28 @@ +.TH PCRE2_GET_OVECTOR_POINTER 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B PCRE2_SIZE *pcre2_get_ovector_pointer(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns a pointer to the vector of offsets that forms part of the +given match data block. The number of pairs can be found by calling +\fBpcre2_get_ovector_count()\fP. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_get_startchar.3 b/miniconda3/share/man/man3/pcre2_get_startchar.3 new file mode 100644 index 0000000000000000000000000000000000000000..7c99df487b979cbbd92fd8bf2cf919fc7a7a4db1 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_get_startchar.3 @@ -0,0 +1,32 @@ +.TH PCRE2_GET_STARTCHAR 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +After a successful call of \fBpcre2_match()\fP that was passed the match block +that is this function's argument, this function returns the code unit offset of +the character at which the successful match started. For a non-partial match, +this can be different to the value of \fIovector[0]\fP if the pattern contains +the \eK escape sequence. After a partial match, however, this value is always +the same as \fIovector[0]\fP because \eK does not affect the result of a +partial match. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_compile.3 b/miniconda3/share/man/man3/pcre2_jit_compile.3 new file mode 100644 index 0000000000000000000000000000000000000000..53cea8b1ff730a0aae35efa33e724c3eeb9c0cce --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_compile.3 @@ -0,0 +1,61 @@ +.TH PCRE2_JIT_COMPILE 3 "22 August 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_jit_compile(pcre2_code *\fIcode\fP, uint32_t \fIoptions\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function requests JIT compilation, which, if the just-in-time compiler is +available, further processes a compiled pattern into machine code that executes +much faster than the \fBpcre2_match()\fP interpretive matching function. Full +details are given in the +.\" HREF +\fBpcre2jit\fP +.\" +documentation. +.P +The availability of JIT support can be tested by calling +\fBpcre2_compile_jit()\fP with a single option PCRE2_JIT_TEST_ALLOC (the +code argument is ignored, so a NULL value is accepted). Such a call +returns zero if JIT is available and has a working allocator. Otherwise +it returns PCRE2_ERROR_NOMEMORY if JIT is available but cannot allocate +executable memory, or PCRE2_ERROR_JIT_UNSUPPORTED if JIT support is not +compiled. +.P +Otherwise, the first argument must be a pointer that was returned by a +successful call to \fBpcre2_compile()\fP, and the second must contain one or +more of the following bits: +.sp + PCRE2_JIT_COMPLETE compile code for full matching + PCRE2_JIT_PARTIAL_SOFT compile code for soft partial matching + PCRE2_JIT_PARTIAL_HARD compile code for hard partial matching +.sp +There is also an obsolete option called PCRE2_JIT_INVALID_UTF, which has been +superseded by the \fBpcre2_compile()\fP option PCRE2_MATCH_INVALID_UTF. The old +option is deprecated and may be removed in the future. +.P +The yield of the function when called with any of the three options above is 0 +for success, or a negative error code otherwise. In particular, +PCRE2_ERROR_JIT_BADOPTION is returned if JIT is not supported or if an unknown +bit is set in \fIoptions\fP. The function can also return PCRE2_ERROR_NOMEMORY +if JIT is unable to allocate executable memory for the compiler, even if it was +because of a system security restriction. In a few cases, the function may +return with PCRE2_ERROR_JIT_UNSUPPORTED for unsupported features. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_free_unused_memory.3 b/miniconda3/share/man/man3/pcre2_jit_free_unused_memory.3 new file mode 100644 index 0000000000000000000000000000000000000000..3eb23db2ed256f0032f560815f015026b3ccc8f8 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_free_unused_memory.3 @@ -0,0 +1,31 @@ +.TH PCRE2_JIT_FREE_UNUSED_MEMORY 3 "24 April 2020" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_jit_free_unused_memory(pcre2_general_context *\fIgcontext\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees unused JIT executable memory. The argument is a general +context, for custom memory management, or NULL for standard memory management. +JIT memory allocation retains some memory in order to improve future JIT +compilation speed. In low memory conditions, +\fBpcre2_jit_free_unused_memory()\fP can be used to cause this memory to be +freed. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_match.3 b/miniconda3/share/man/man3/pcre2_jit_match.3 new file mode 100644 index 0000000000000000000000000000000000000000..60e3a631157dfd22116d28bb740e5cce9dea6534 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_match.3 @@ -0,0 +1,58 @@ +.TH PCRE2_JIT_MATCH 3 "20 January 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_jit_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function matches a compiled regular expression that has been successfully +processed by the JIT compiler against a given subject string, using a matching +algorithm that is similar to Perl's. It is a "fast path" interface to JIT, and +it bypasses some of the sanity checks that \fBpcre2_match()\fP applies. +.P +In UTF mode, the subject string is not checked for UTF validity. Unless +PCRE2_MATCH_INVALID_UTF was set when the pattern was compiled, passing an +invalid UTF string results in undefined behaviour. Your program may crash or +loop or give wrong results. In the absence of PCRE2_MATCH_INVALID_UTF you +should only call \fBpcre2_jit_match()\fP in UTF mode if you are sure the +subject is valid. +.P +The arguments for \fBpcre2_jit_match()\fP are exactly the same as for +.\" HREF +\fBpcre2_match()\fP, +.\" +except that the subject string must be specified with a length; +PCRE2_ZERO_TERMINATED is not supported. +.P +The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, +PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Unsupported +options are ignored. +.P +The return values are the same as for \fBpcre2_match()\fP plus +PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is requested +that was not compiled. For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the JIT API in the +.\" HREF +\fBpcre2jit\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_stack_assign.3 b/miniconda3/share/man/man3/pcre2_jit_stack_assign.3 new file mode 100644 index 0000000000000000000000000000000000000000..f3a0a0448caf0b1d84ad484ae1242564af61f6b3 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_stack_assign.3 @@ -0,0 +1,59 @@ +.TH PCRE2_JIT_STACK_ASSIGN 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_jit_stack_assign(pcre2_match_context *\fImcontext\fP, +.B " pcre2_jit_callback \fIcallback_function\fP, void *\fIcallback_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function provides control over the memory used by JIT as a run-time stack +when \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP is called with a pattern +that has been successfully processed by the JIT compiler. The information that +determines which stack is used is put into a match context that is subsequently +passed to a matching function. The arguments of this function are: +.sp + mcontext a pointer to a match context + callback a callback function + callback_data a JIT stack or a value to be passed to the callback +.P +If \fImcontext\fP is NULL, the function returns immediately, without doing +anything. +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is NULL, an internal 32KiB +block on the machine stack is used. +.P +If \fIcallback\fP is NULL and \fIcallback_data\fP is not NULL, +\fIcallback_data\fP must be a valid JIT stack, the result of calling +\fBpcre2_jit_stack_create()\fP. +.P +If \fIcallback\fP not NULL, it is called with \fIcallback_data\fP as an +argument at the start of matching, in order to set up a JIT stack. If the +result is NULL, the internal 32KiB stack is used; otherwise the return value +must be a valid JIT stack, the result of calling +\fBpcre2_jit_stack_create()\fP. +.P +You may safely use the same JIT stack for multiple patterns, as long as they +are all matched in the same thread. In a multithread application, each thread +must use its own JIT stack. For more details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_stack_create.3 b/miniconda3/share/man/man3/pcre2_jit_stack_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..3ad2adc59af7893f28061daa7a1688e1ca19a92e --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_stack_create.3 @@ -0,0 +1,40 @@ +.TH PCRE2_JIT_STACK_CREATE 3 "23 January 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_jit_stack *pcre2_jit_stack_create(size_t \fIstartsize\fP, +.B " size_t \fImaxsize\fP, pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is used to create a stack for use by the code compiled by the JIT +compiler. The first two arguments are a starting size for the stack, and a +maximum size to which it is allowed to grow. The final argument is a general +context, for memory allocation functions, or NULL for standard memory +allocation. The result can be passed to the JIT run-time code by calling +\fBpcre2_jit_stack_assign()\fP to associate the stack with a compiled pattern, +which can then be processed by \fBpcre2_match()\fP or \fBpcre2_jit_match()\fP. +A maximum stack size of 512KiB to 1MiB should be more than enough for any +pattern. If the stack couldn't be allocated or the values passed were not +reasonable, NULL will be returned. For more details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_jit_stack_free.3 b/miniconda3/share/man/man3/pcre2_jit_stack_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..8f1d5a4882469a50e6e3d3df8c909dac8270354f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_jit_stack_free.3 @@ -0,0 +1,32 @@ +.TH PCRE2_JIT_STACK_FREE 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_jit_stack_free(pcre2_jit_stack *\fIjit_stack\fP); +. +.SH DESCRIPTION +.rs +.sp +This function is used to free a JIT stack that was created by +\fBpcre2_jit_stack_create()\fP when it is no longer needed. If the argument is +NULL, the function returns immediately without doing anything. For more +details, see the +.\" HREF +\fBpcre2jit\fP +.\" +page. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_maketables.3 b/miniconda3/share/man/man3/pcre2_maketables.3 new file mode 100644 index 0000000000000000000000000000000000000000..d859b312c29eae9b1eeaa07b0cfcef399fe2bb90 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_maketables.3 @@ -0,0 +1,36 @@ +.TH PCRE2_MAKETABLES 3 "28 July 2019" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B const uint8_t *pcre2_maketables(pcre2_general_context *\fIgcontext\fP); +. +.SH DESCRIPTION +.rs +.sp +This function builds a set of character tables for character code points that +are less than 256. These can be passed to \fBpcre2_compile()\fP in a compile +context in order to override the internal, built-in tables (which were either +defaulted or made by \fBpcre2_maketables()\fP when PCRE2 was compiled). See the +.\" HREF +\fBpcre2_set_character_tables()\fP +.\" +page. You might want to do this if you are using a non-standard locale. +.P +If the argument is NULL, \fBmalloc()\fP is used to get memory for the tables. +Otherwise it must point to a general context, which can supply pointers to a +custom memory manager. The function yields a pointer to the tables. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_maketables_free.3 b/miniconda3/share/man/man3/pcre2_maketables_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..44a8db733fa18e0a6b29b989460cbbe5d564a10b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_maketables_free.3 @@ -0,0 +1,31 @@ +.TH PCRE2_MAKETABLES_FREE 3 "03 September 2019" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_maketables_free(pcre2_general_context *\fIgcontext\fP, +.B " const uint8_t *\fItables\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function discards a set of character tables that were created by a call +to +.\" HREF +\fBpcre2_maketables()\fP. +.\" +.P +The \fIgcontext\fP parameter should match what was used in that call to +account for any custom allocators that might be in use; if it is NULL +the system \fBfree()\fP is used. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match.3 b/miniconda3/share/man/man3/pcre2_match.3 new file mode 100644 index 0000000000000000000000000000000000000000..50cd1f23836fee2096e26ed3856e24c4a0b5e376 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match.3 @@ -0,0 +1,86 @@ +.TH PCRE2_MATCH 3 "27 January 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function matches a compiled regular expression against a given subject +string, using a matching algorithm that is similar to Perl's. It returns +offsets to what it has matched and to captured substrings via the +\fBmatch_data\fP block, which can be processed by functions with names that +start with \fBpcre2_get_ovector_...()\fP or \fBpcre2_substring_...()\fP. The +return from \fBpcre2_match()\fP is one more than the highest numbered capturing +pair that has been set (for example, 1 if there are no captures), zero if the +vector of offsets is too small, or a negative error code for no match and other +errors. The function arguments are: +.sp + \fIcode\fP Points to the compiled pattern + \fIsubject\fP Points to the subject string + \fIlength\fP Length of the subject string + \fIstartoffset\fP Offset in the subject at which to start matching + \fIoptions\fP Option bits + \fImatch_data\fP Points to a match data block, for results + \fImcontext\fP Points to a match context, or is NULL +.sp +A match context is needed only if you want to: +.sp + Set up a callout function + Set a matching offset limit + Change the heap memory limit + Change the backtracking match limit + Change the backtracking depth limit + Set custom memory management specifically for the match +.sp +The \fIlength\fP and \fIstartoffset\fP values are code units, not characters. +The length may be given as PCRE2_ZERO_TERMINATED for a subject that is +terminated by a binary zero code unit. The options are: +.sp + PCRE2_ANCHORED Match only at the first position + PCRE2_COPY_MATCHED_SUBJECT + On success, make a private subject copy + PCRE2_DISABLE_RECURSELOOP_CHECK + Only useful in rare cases; use with care + PCRE2_ENDANCHORED Pattern can match only at end of subject + PCRE2_NOTBOL Subject string is not the beginning of a line + PCRE2_NOTEOL Subject string is not the end of a line + PCRE2_NOTEMPTY An empty string is not a valid match +.\" JOIN + PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject + is not a valid match + PCRE2_NO_JIT Do not use JIT matching +.\" JOIN + PCRE2_NO_UTF_CHECK Do not check the subject for UTF + validity (only relevant if PCRE2_UTF + was set at compile time) +.\" JOIN + PCRE2_PARTIAL_HARD Return PCRE2_ERROR_PARTIAL for a partial + match even if there is a full match +.\" JOIN + PCRE2_PARTIAL_SOFT Return PCRE2_ERROR_PARTIAL for a partial + match if no full matches are found +.sp +For details of partial matching, see the +.\" HREF +\fBpcre2partial\fP +.\" +page. There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_context_copy.3 b/miniconda3/share/man/man3/pcre2_match_context_copy.3 new file mode 100644 index 0000000000000000000000000000000000000000..88614b15506559d659a048e1ce3ac74a000d2caa --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_context_copy.3 @@ -0,0 +1,29 @@ +.TH PCRE2_MATCH_CONTEXT_COPY 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_match_context *pcre2_match_context_copy( +.B " pcre2_match_context *\fImcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function makes a new copy of a match context, using the memory +allocation function that was used for the original context. The result is NULL +if the memory cannot be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_context_create.3 b/miniconda3/share/man/man3/pcre2_match_context_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..b20c7021a98c6a51931da27daab1e381300fe7aa --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_context_create.3 @@ -0,0 +1,30 @@ +.TH PCRE2_MATCH_CONTEXT_CREATE 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_match_context *pcre2_match_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function creates and initializes a new match context. If its argument is +NULL, \fBmalloc()\fP is used to get the necessary memory; otherwise the memory +allocation function within the general context is used. The result is NULL if +the memory could not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_context_free.3 b/miniconda3/share/man/man3/pcre2_match_context_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..83c66a384c54ad611a5b0206611214d8dfd1f04b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_context_free.3 @@ -0,0 +1,29 @@ +.TH PCRE2_MATCH_CONTEXT_FREE 3 "28 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_match_context_free(pcre2_match_context *\fImcontext\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees the memory occupied by a match context, using the memory +freeing function from the general context with which it was created, or +\fBfree()\fP if that was not set. If the argument is NULL, the function returns +immediately without doing anything. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_data_create.3 b/miniconda3/share/man/man3/pcre2_match_data_create.3 new file mode 100644 index 0000000000000000000000000000000000000000..59c9de87b884f0394fb9c2024ec8a763dadaf8e9 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_data_create.3 @@ -0,0 +1,37 @@ +.TH PCRE2_MATCH_DATA_CREATE 3 "28 August 2021" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_match_data *pcre2_match_data_create(uint32_t \fIovecsize\fP, +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function creates a new match data block, which is used for holding the +result of a match. The first argument specifies the number of pairs of offsets +that are required. These form the "output vector" (ovector) within the match +data block, and are used to identify the matched string and any captured +substrings when matching with \fBpcre2_match()\fP, or a number of different +matches at the same point when used with \fBpcre2_dfa_match()\fP. There is +always one pair of offsets; if \fBovecsize\fP is zero, it is treated as one. +.P +The second argument points to a general context, for custom memory management, +or is NULL for system memory management. The result of the function is NULL if +the memory for the block could not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_data_create_from_pattern.3 b/miniconda3/share/man/man3/pcre2_match_data_create_from_pattern.3 new file mode 100644 index 0000000000000000000000000000000000000000..ec9a62f378e81a5f08c7f389f2cce080ea9cfe7e --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_data_create_from_pattern.3 @@ -0,0 +1,40 @@ +.TH PCRE2_MATCH_DATA_CREATE_FROM_PATTERN 3 "19 August 2022" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B pcre2_match_data *pcre2_match_data_create_from_pattern( +.B " const pcre2_code *\fIcode\fP, pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function creates a new match data block for holding the result of a match. +The first argument points to a compiled pattern. The number of capturing +parentheses within the pattern is used to compute the number of pairs of +offsets that are required in the match data block. These form the "output +vector" (ovector) within the match data block, and are used to identify the +matched string and any captured substrings when matching with +\fBpcre2_match()\fP. If you are using \fBpcre2_dfa_match()\fP, which uses the +output vector in a different way, you should use \fBpcre2_match_data_create()\fP +instead of this function. +.P +The second argument points to a general context, for custom memory management, +or is NULL to use the same memory allocator as was used for the compiled +pattern. The result of the function is NULL if the memory for the block could +not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_match_data_free.3 b/miniconda3/share/man/man3/pcre2_match_data_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..855ddce19ac861f8ba8d92e2f04f4eed6cce3981 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_match_data_free.3 @@ -0,0 +1,35 @@ +.TH PCRE2_MATCH_DATA_FREE 3 "16 August 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_match_data_free(pcre2_match_data *\fImatch_data\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +If \fImatch_data\fP is NULL, this function does nothing. Otherwise, +\fImatch_data\fP must point to a match data block, which this function frees, +using the memory freeing function from the general context or compiled pattern +with which it was created, or \fBfree()\fP if that was not set. If the match +data block was previously passed to \fBpcre2_match()\fP, it will have an +attached heapframe vector; this is also freed. +.P +If the PCRE2_COPY_MATCHED_SUBJECT was used for a successful match using this +match data block, the copy of the subject that was referenced within the block +is also freed. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_pattern_convert.3 b/miniconda3/share/man/man3/pcre2_pattern_convert.3 new file mode 100644 index 0000000000000000000000000000000000000000..f3266f28ae080a5f611d00611df523ee44c899d0 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_pattern_convert.3 @@ -0,0 +1,55 @@ +.TH PCRE2_PATTERN_CONVERT 3 "12 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_pattern_convert(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, PCRE2_UCHAR **\fIbuffer\fP," +.B " PCRE2_SIZE *\fIblength\fP, pcre2_convert_context *\fIcvcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It converts a foreign pattern (for example, a glob) into a PCRE2 regular +expression pattern. Its arguments are: +.sp + \fIpattern\fP The foreign pattern + \fIlength\fP The length of the input pattern or PCRE2_ZERO_TERMINATED + \fIoptions\fP Option bits + \fIbuffer\fP Pointer to pointer to output buffer, or NULL + \fIblength\fP Pointer to output length field + \fIcvcontext\fP Pointer to a convert context or NULL +.sp +The length of the converted pattern (excluding the terminating zero) is +returned via \fIblength\fP. If \fIbuffer\fP is NULL, the function just returns +the output length. If \fIbuffer\fP points to a NULL pointer, heap memory is +obtained for the converted pattern, using the allocator in the context if +present (or else \fBmalloc()\fP), and the field pointed to by \fIbuffer\fP is +updated. If \fIbuffer\fP points to a non-NULL field, that must point to a +buffer whose size is in the variable pointed to by \fIblength\fP. This value is +updated. +.P +The option bits are: +.sp + PCRE2_CONVERT_UTF Input is UTF + PCRE2_CONVERT_NO_UTF_CHECK Do not check UTF validity + PCRE2_CONVERT_POSIX_BASIC Convert POSIX basic pattern + PCRE2_CONVERT_POSIX_EXTENDED Convert POSIX extended pattern + PCRE2_CONVERT_GLOB ) Convert + PCRE2_CONVERT_GLOB_NO_WILD_SEPARATOR ) various types + PCRE2_CONVERT_GLOB_NO_STARSTAR ) of glob +.sp +The return value from \fBpcre2_pattern_convert()\fP is zero on success or a +non-zero PCRE2 error code. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_pattern_info.3 b/miniconda3/share/man/man3/pcre2_pattern_info.3 new file mode 100644 index 0000000000000000000000000000000000000000..05e133e0b13a444b8873015cbfaad861becb23a2 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_pattern_info.3 @@ -0,0 +1,108 @@ +.TH PCRE2_PATTERN_INFO 3 "14 February 2019" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_pattern_info(const pcre2_code *\fIcode\fP, uint32_t \fIwhat\fP, +.B " void *\fIwhere\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns information about a compiled pattern. Its arguments are: +.sp + \fIcode\fP Pointer to a compiled regular expression pattern + \fIwhat\fP What information is required + \fIwhere\fP Where to put the information +.sp +The recognized values for the \fIwhat\fP argument, and the information they +request are as follows: +.sp + PCRE2_INFO_ALLOPTIONS Final options after compiling + PCRE2_INFO_ARGOPTIONS Options passed to \fBpcre2_compile()\fP + PCRE2_INFO_BACKREFMAX Number of highest backreference + PCRE2_INFO_BSR What \eR matches: + PCRE2_BSR_UNICODE: Unicode line endings + PCRE2_BSR_ANYCRLF: CR, LF, or CRLF only + PCRE2_INFO_CAPTURECOUNT Number of capturing subpatterns +.\" JOIN + PCRE2_INFO_DEPTHLIMIT Backtracking depth limit if set, + otherwise PCRE2_ERROR_UNSET + PCRE2_INFO_EXTRAOPTIONS Extra options that were passed in the + compile context + PCRE2_INFO_FIRSTBITMAP Bitmap of first code units, or NULL + PCRE2_INFO_FIRSTCODETYPE Type of start-of-match information + 0 nothing set + 1 first code unit is set + 2 start of string or after newline + PCRE2_INFO_FIRSTCODEUNIT First code unit when type is 1 + PCRE2_INFO_FRAMESIZE Size of backtracking frame + PCRE2_INFO_HASBACKSLASHC Return 1 if pattern contains \eC +.\" JOIN + PCRE2_INFO_HASCRORLF Return 1 if explicit CR or LF matches + exist in the pattern +.\" JOIN + PCRE2_INFO_HEAPLIMIT Heap memory limit if set, + otherwise PCRE2_ERROR_UNSET + PCRE2_INFO_JCHANGED Return 1 if (?J) or (?-J) was used + PCRE2_INFO_JITSIZE Size of JIT compiled code, or 0 + PCRE2_INFO_LASTCODETYPE Type of must-be-present information + 0 nothing set + 1 code unit is set + PCRE2_INFO_LASTCODEUNIT Last code unit when type is 1 +.\" JOIN + PCRE2_INFO_MATCHEMPTY 1 if the pattern can match an + empty string, 0 otherwise +.\" JOIN + PCRE2_INFO_MATCHLIMIT Match limit if set, + otherwise PCRE2_ERROR_UNSET +.\" JOIN + PCRE2_INFO_MAXLOOKBEHIND Length (in characters) of the longest + lookbehind assertion + PCRE2_INFO_MINLENGTH Lower bound length of matching strings + PCRE2_INFO_NAMECOUNT Number of named subpatterns + PCRE2_INFO_NAMEENTRYSIZE Size of name table entries + PCRE2_INFO_NAMETABLE Pointer to name table + PCRE2_CONFIG_NEWLINE Code for the newline sequence: + PCRE2_NEWLINE_CR + PCRE2_NEWLINE_LF + PCRE2_NEWLINE_CRLF + PCRE2_NEWLINE_ANY + PCRE2_NEWLINE_ANYCRLF + PCRE2_NEWLINE_NUL + PCRE2_INFO_RECURSIONLIMIT Obsolete synonym for PCRE2_INFO_DEPTHLIMIT + PCRE2_INFO_SIZE Size of compiled pattern +.sp +If \fIwhere\fP is NULL, the function returns the amount of memory needed for +the requested information, in bytes. Otherwise, the \fIwhere\fP argument must +point to an unsigned 32-bit integer (uint32_t variable), except for the +following \fIwhat\fP values, when it must point to a variable of the type +shown: +.sp + PCRE2_INFO_FIRSTBITMAP const uint8_t * + PCRE2_INFO_JITSIZE size_t + PCRE2_INFO_NAMETABLE PCRE2_SPTR + PCRE2_INFO_SIZE size_t +.sp +The yield of the function is zero on success or: +.sp + PCRE2_ERROR_NULL the argument \fIcode\fP is NULL + PCRE2_ERROR_BADMAGIC the "magic number" was not found + PCRE2_ERROR_BADOPTION the value of \fIwhat\fP is invalid + PCRE2_ERROR_BADMODE the pattern was compiled in the wrong mode + PCRE2_ERROR_UNSET the requested information is not set +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_serialize_decode.3 b/miniconda3/share/man/man3/pcre2_serialize_decode.3 new file mode 100644 index 0000000000000000000000000000000000000000..b81cf7e473fb068d408e06947b7a19ecc33ad1fb --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_serialize_decode.3 @@ -0,0 +1,53 @@ +.TH PCRE2_SERIALIZE_DECODE 3 "22 April 2022" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int32_t pcre2_serialize_decode(pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, const uint8_t *\fIbytes\fP," +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function decodes a serialized set of compiled patterns back into a list of +individual patterns. This is possible only on a host that is running the same +version of PCRE2, with the same code unit width, and the host must also have +the same endianness, pointer width and PCRE2_SIZE type. The arguments for +\fBpcre2_serialize_decode()\fP are: +.sp + \fIcodes\fP pointer to a vector in which to build the list + \fInumber_of_codes\fP number of slots in the vector + \fIbytes\fP the serialized byte stream + \fIgcontext\fP pointer to a general context or NULL +.sp +The \fIbytes\fP argument must point to a block of data that was originally +created by \fBpcre2_serialize_encode()\fP, though it may have been saved on +disc or elsewhere in the meantime. If there are more codes in the serialized +data than slots in the list, only those compiled patterns that will fit are +decoded. The yield of the function is the number of decoded patterns, or one of +the following negative error codes: +.sp + PCRE2_ERROR_BADDATA \fInumber_of_codes\fP is zero or less + PCRE2_ERROR_BADMAGIC mismatch of id bytes in \fIbytes\fP + PCRE2_ERROR_BADMODE mismatch of variable unit size or PCRE version + PCRE2_ERROR_NOMEMORY memory allocation failed + PCRE2_ERROR_NULL \fIcodes\fP or \fIbytes\fP is NULL +.sp +PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled +on a system with different endianness. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the serialization functions in the +.\" HREF +\fBpcre2serialize\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_serialize_encode.3 b/miniconda3/share/man/man3/pcre2_serialize_encode.3 new file mode 100644 index 0000000000000000000000000000000000000000..9fb7aed369a64ccc5586718607eb8af2a7aeeb94 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_serialize_encode.3 @@ -0,0 +1,54 @@ +.TH PCRE2_SERIALIZE_ENCODE 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int32_t pcre2_serialize_encode(const pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, uint8_t **\fIserialized_bytes\fP," +.B " PCRE2_SIZE *\fIserialized_size\fP, pcre2_general_context *\fIgcontext\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function encodes a list of compiled patterns into a byte stream that can +be saved on disc or elsewhere. Note that this is not an abstract format like +Java or .NET. Conversion of the byte stream back into usable compiled patterns +can only happen on a host that is running the same version of PCRE2, with the +same code unit width, and the host must also have the same endianness, pointer +width and PCRE2_SIZE type. The arguments for \fBpcre2_serialize_encode()\fP +are: +.sp + \fIcodes\fP pointer to a vector containing the list + \fInumber_of_codes\fP number of slots in the vector + \fIserialized_bytes\fP set to point to the serialized byte stream + \fIserialized_size\fP set to the number of bytes in the byte stream + \fIgcontext\fP pointer to a general context or NULL +.sp +The context argument is used to obtain memory for the byte stream. When the +serialized data is no longer needed, it must be freed by calling +\fBpcre2_serialize_free()\fP. The yield of the function is the number of +serialized patterns, or one of the following negative error codes: +.sp + PCRE2_ERROR_BADDATA \fInumber_of_codes\fP is zero or less + PCRE2_ERROR_BADMAGIC mismatch of id bytes in one of the patterns + PCRE2_ERROR_MEMORY memory allocation failed + PCRE2_ERROR_MIXEDTABLES the patterns do not all use the same tables + PCRE2_ERROR_NULL an argument other than \fIgcontext\fP is NULL +.sp +PCRE2_ERROR_BADMAGIC means either that a pattern's code has been corrupted, or +that a slot in the vector does not point to a compiled pattern. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the serialization functions in the +.\" HREF +\fBpcre2serialize\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_serialize_free.3 b/miniconda3/share/man/man3/pcre2_serialize_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..c90378d74077fbbd327b6aac41f4bf3cfe8353ab --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_serialize_free.3 @@ -0,0 +1,29 @@ +.TH PCRE2_SERIALIZE_FREE 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B void pcre2_serialize_free(uint8_t *\fIbytes\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This function frees the memory that was obtained by +\fBpcre2_serialize_encode()\fP to hold a serialized byte stream. The argument +must point to such a byte stream or be NULL, in which case the function returns +without doing anything. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the serialization functions in the +.\" HREF +\fBpcre2serialize\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_serialize_get_number_of_codes.3 b/miniconda3/share/man/man3/pcre2_serialize_get_number_of_codes.3 new file mode 100644 index 0000000000000000000000000000000000000000..689771f93e4eaf49e2a19f44002e6494f76e3f90 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_serialize_get_number_of_codes.3 @@ -0,0 +1,37 @@ +.TH PCRE2_SERIALIZE_GET_NUMBER_OF_CODES 3 "13 August 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int32_t pcre2_serialize_get_number_of_codes(const uint8_t *\fIbytes\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +The \fIbytes\fP argument must point to a serialized byte stream that was +originally created by \fBpcre2_serialize_encode()\fP (though it may have been +saved on disc or elsewhere in the meantime). The function returns the number of +serialized patterns in the byte stream, or one of the following negative error +codes: +.sp + PCRE2_ERROR_BADMAGIC mismatch of id bytes in \fIbytes\fP + PCRE2_ERROR_BADMODE mismatch of variable unit size or PCRE version + PCRE2_ERROR_NULL the argument is NULL +.sp +PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled +on a system with different endianness. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the serialization functions in the +.\" HREF +\fBpcre2serialize\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_bsr.3 b/miniconda3/share/man/man3/pcre2_set_bsr.3 new file mode 100644 index 0000000000000000000000000000000000000000..6fdf798ed78fa8d2d445b0bb76a247f36dd8b94d --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_bsr.3 @@ -0,0 +1,30 @@ +.TH PCRE2_SET_BSR 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_bsr(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the convention for processing \eR within a compile context. +The second argument must be one of PCRE2_BSR_ANYCRLF or PCRE2_BSR_UNICODE. The +result is zero for success or PCRE2_ERROR_BADDATA if the second argument is +invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_callout.3 b/miniconda3/share/man/man3/pcre2_set_callout.3 new file mode 100644 index 0000000000000000000000000000000000000000..6e8334cc89d62153069691c17a9b2d6954d5a155 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_callout.3 @@ -0,0 +1,31 @@ +.TH PCRE2_SET_CALLOUT 3 "25 March 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_callout_block *)," +.B " void *\fIcallout_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the callout fields in a match context (the first argument). +The second argument specifies a callout function, and the third argument is an +opaque data item that is passed to it. The result of this function is always +zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_character_tables.3 b/miniconda3/share/man/man3/pcre2_set_character_tables.3 new file mode 100644 index 0000000000000000000000000000000000000000..252aa48947a6763667def26fb2796581a521d90d --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_character_tables.3 @@ -0,0 +1,35 @@ +.TH PCRE2_SET_CHARACTER_TABLES 3 "15 April 2020" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_character_tables(pcre2_compile_context *\fIccontext\fP, +.B " const uint8_t *\fItables\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets a pointer to custom character tables within a compile +context. The second argument must point to a set of PCRE2 character tables or +be NULL to request the default tables. The result is always zero. Character +tables can be created by calling \fBpcre2_maketables()\fP or by running the +\fBpcre2_dftables\fP maintenance command in binary mode (see the +.\" HREF +\fBpcre2build\fP +.\" +documentation). +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_compile_extra_options.3 b/miniconda3/share/man/man3/pcre2_set_compile_extra_options.3 new file mode 100644 index 0000000000000000000000000000000000000000..37e2d4c7d50ccee9c4e1d3bf0cd5bd52c6ac3a8a --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_compile_extra_options.3 @@ -0,0 +1,59 @@ +.TH PCRE2_SET_COMPILE_EXTRA_OPTIONS 3 "14 October 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_compile_extra_options(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIextra_options\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets additional option bits for \fBpcre2_compile()\fP that are +housed in a compile context. It completely replaces all the bits. The extra +options are: +.sp + PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK Allow \eK in lookarounds +.\" JOIN + PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES Allow \ex{d800} to \ex{dfff} + in UTF-8 and UTF-32 modes +.\" JOIN + PCRE2_EXTRA_ALT_BSUX Extended alternate \eu, \eU, and + \ex handling + PCRE2_EXTRA_ASCII_BSD \ed remains ASCII in UCP mode + PCRE2_EXTRA_ASCII_BSS \es remains ASCII in UCP mode + PCRE2_EXTRA_ASCII_BSW \ew remains ASCII in UCP mode +.\" JOIN + PCRE2_EXTRA_ASCII_DIGIT [:digit:] and [:xdigit:] POSIX classes + remain ASCII in UCP mode +.\" JOIN + PCRE2_EXTRA_ASCII_POSIX POSIX classes remain ASCII in + UCP mode +.\" JOIN + PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL Treat all invalid escapes as + a literal following character +.\" JOIN + PCRE2_EXTRA_CASELESS_RESTRICT Disable mixed ASCII/non-ASCII + case folding + PCRE2_EXTRA_ESCAPED_CR_IS_LF Interpret \er as \en + PCRE2_EXTRA_MATCH_LINE Pattern matches whole lines + PCRE2_EXTRA_MATCH_WORD Pattern matches "words" + PCRE2_EXTRA_NEVER_CALLOUT Disallow callouts in pattern + PCRE2_EXTRA_NO_BS0 Disallow \e0 (but not \e00 or \e000) + PCRE2_EXTRA_PYTHON_OCTAL Use Python rules for octal + PCRE2_EXTRA_TURKISH_CASING Use Turkish I case folding +.sp +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_compile_recursion_guard.3 b/miniconda3/share/man/man3/pcre2_set_compile_recursion_guard.3 new file mode 100644 index 0000000000000000000000000000000000000000..e6126cb382510aa61cc1c0aec9e1d4958ef8dd9b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_compile_recursion_guard.3 @@ -0,0 +1,34 @@ +.TH PCRE2_SET_COMPILE_RECURSION_GUARD 3 "26 November 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP, +.B " int (*\fIguard_function\fP)(uint32_t, void *), void *\fIuser_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function defines, within a compile context, a function that is called +whenever \fBpcre2_compile()\fP starts to compile a parenthesized part of a +pattern. The first argument to the function gives the current depth of +parenthesis nesting, and the second is user data that is supplied when the +function is set up. The callout function should return zero if all is well, or +non-zero to force an error. This feature is provided so that applications can +check the available system stack space, in order to avoid running out. The +result of \fBpcre2_set_compile_recursion_guard()\fP is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_depth_limit.3 b/miniconda3/share/man/man3/pcre2_set_depth_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..5ae81db03f665c3cec8d9c52a3612485b8d41415 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_depth_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_DEPTH_LIMIT 3 "25 March 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_depth_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the backtracking depth limit field in a match context. The +result is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_glob_escape.3 b/miniconda3/share/man/man3/pcre2_set_glob_escape.3 new file mode 100644 index 0000000000000000000000000000000000000000..7e52e972ee6e82fba273b0ce751047f750d359c8 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_glob_escape.3 @@ -0,0 +1,29 @@ +.TH PCRE2_SET_GLOB_ESCAPE 3 "12 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_glob_escape(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIescape_char\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It sets the escape character that is used when converting globs. The second +argument must either be zero (meaning there is no escape character) or a +punctuation character whose code point is less than 256. The default is grave +accent if running under Windows, otherwise backslash. The result of the +function is zero for success or PCRE2_ERROR_BADDATA if the second argument is +invalid. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_set_glob_separator.3 b/miniconda3/share/man/man3/pcre2_set_glob_separator.3 new file mode 100644 index 0000000000000000000000000000000000000000..36ebdb97d5adbfee1513e891842eae9b36af9b38 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_glob_separator.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_GLOB_SEPARATOR 3 "17 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_glob_separator(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIseparator_char\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is part of an experimental set of pattern conversion functions. +It sets the component separator character that is used when converting globs. +The second argument must be one of the characters forward slash, backslash, or +dot. The default is backslash when running under Windows, otherwise forward +slash. The result of the function is zero for success or PCRE2_ERROR_BADDATA if +the second argument is invalid. +.P +The pattern conversion functions are described in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. diff --git a/miniconda3/share/man/man3/pcre2_set_heap_limit.3 b/miniconda3/share/man/man3/pcre2_set_heap_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..f240309b6cf85e9eb72a2f98023780fa0ad75934 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_heap_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_HEAP_LIMIT 3 "17 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_heap_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the backtracking heap limit field in a match context. The +result is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_match_limit.3 b/miniconda3/share/man/man3/pcre2_set_match_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..c15172cef7bbe5819719800a0dd90f2179da790b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_match_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_MATCH_LIMIT 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_match_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the match limit field in a match context. The result is +always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_max_pattern_compiled_length.3 b/miniconda3/share/man/man3/pcre2_set_max_pattern_compiled_length.3 new file mode 100644 index 0000000000000000000000000000000000000000..2d1e6dd3059714b4d1c1ebc43d0d64bc1b61e44c --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_max_pattern_compiled_length.3 @@ -0,0 +1,32 @@ +.TH PCRE2_SET_MAX_PATTERN_COMPILED_LENGTH 3 "09 June 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_max_pattern_compiled_length( +.B " pcre2_compile_context *\fIccontext\fP, PCRE2_SIZE \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets, in a compile context, the maximum size (in bytes) for the +memory needed to hold the compiled version of a pattern that is using this +context. The result is always zero. If a pattern that is passed to +\fBpcre2_compile()\fP referencing this context needs more memory, an error is +generated. The default is the largest number that a PCRE2_SIZE variable can +hold, which is effectively unlimited. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_max_pattern_length.3 b/miniconda3/share/man/man3/pcre2_set_max_pattern_length.3 new file mode 100644 index 0000000000000000000000000000000000000000..7a8b3456f5bfb374a319a7b85794354d96797fd8 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_max_pattern_length.3 @@ -0,0 +1,31 @@ +.TH PCRE2_SET_MAX_PATTERN_LENGTH 3 "05 October 2016" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_max_pattern_length(pcre2_compile_context *\fIccontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets, in a compile context, the maximum text length (in code +units) of the pattern that can be compiled. The result is always zero. If a +longer pattern is passed to \fBpcre2_compile()\fP there is an immediate error +return. The default is effectively unlimited, being the largest value a +PCRE2_SIZE variable can hold. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_max_varlookbehind.3 b/miniconda3/share/man/man3/pcre2_set_max_varlookbehind.3 new file mode 100644 index 0000000000000000000000000000000000000000..ce97886fafcf672e82aa03cd298e677fb81b0166 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_max_varlookbehind.3 @@ -0,0 +1,30 @@ +.TH PCRE2_SET_NEWLINE 3 "11 August 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_max_varlookbehind(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This sets a maximum length for the number of characters matched by a +variable-length lookbehind assertion. The default is set when PCRE2 is built, +with the ultimate default being 255, the same as Perl. Lookbehind assertions +without a bounding length are not supported. The result is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_newline.3 b/miniconda3/share/man/man3/pcre2_set_newline.3 new file mode 100644 index 0000000000000000000000000000000000000000..54747b7fbc74d0e68f5d71629b2a8f13cf724d51 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_newline.3 @@ -0,0 +1,39 @@ +.TH PCRE2_SET_NEWLINE 3 "19 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_newline(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the newline convention within a compile context. This +specifies which character(s) are recognized as newlines when compiling and +matching patterns. The second argument must be one of: +.sp + PCRE2_NEWLINE_CR Carriage return only + PCRE2_NEWLINE_LF Linefeed only + PCRE2_NEWLINE_CRLF CR followed by LF only + PCRE2_NEWLINE_ANYCRLF Any of the above + PCRE2_NEWLINE_ANY Any Unicode newline sequence + PCRE2_NEWLINE_NUL The NUL character (binary zero) +.sp +The result is zero for success or PCRE2_ERROR_BADDATA if the second argument is +invalid. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_offset_limit.3 b/miniconda3/share/man/man3/pcre2_set_offset_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..b9b694ffd9ec0313a05e2b8123b79d37fee6f28a --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_offset_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_OFFSET_LIMIT 3 "22 September 2015" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_offset_limit(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the offset limit field in a match context. The result is +always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_optimize.3 b/miniconda3/share/man/man3/pcre2_set_optimize.3 new file mode 100644 index 0000000000000000000000000000000000000000..3fc4c9e43f8b3ba931dd2c507d77294c6dbeb612 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_optimize.3 @@ -0,0 +1,42 @@ +.TH PCRE2_SET_OPTIMIZE 3 "22 September 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_optimize(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIdirective\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function controls which performance optimizations will be applied +by \fBpcre2_compile()\fP. It can be called multiple times with the same compile +context; the effects are cumulative, with the effects of later calls taking +precedence over earlier ones. +.P +The result is zero for success, PCRE2_ERROR_NULL if \fIccontext\fP is NULL, +or PCRE2_ERROR_BADOPTION if \fIdirective\fP is unknown. The latter could be +useful to detect if a certain optimization is available. +.P +The list of possible values for the \fIdirective\fP parameter are: +.sp + PCRE2_OPTIMIZATION_FULL Enable all optimizations (default) + PCRE2_OPTIMIZATION_NONE Disable all optimizations + PCRE2_AUTO_POSSESS Enable auto-possessification + PCRE2_AUTO_POSSESS_OFF Disable auto-possessification + PCRE2_DOTSTAR_ANCHOR Enable implicit dotstar anchoring + PCRE2_DOTSTAR_ANCHOR_OFF Disable implicit dotstar anchoring + PCRE2_START_OPTIMIZE Enable start-up optimizations at match time + PCRE2_START_OPTIMIZE_OFF Disable start-up optimizations at match time +.sp +There is a complete description of the PCRE2 native API, including detailed +descriptions \fIdirective\fP parameter values in the +.\" HREF +\fBpcre2api\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_parens_nest_limit.3 b/miniconda3/share/man/man3/pcre2_set_parens_nest_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..ccc8542d2bc01ddcfe72f148d034d1340cb9005f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_parens_nest_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_PARENS_NEST_LIMIT 3 "25 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_parens_nest_limit(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets, in a compile context, the maximum depth of nested +parentheses in a pattern. The result is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_recursion_limit.3 b/miniconda3/share/man/man3/pcre2_set_recursion_limit.3 new file mode 100644 index 0000000000000000000000000000000000000000..eeaad17e1fb3cbc9822ebfc6f0adf324e62eaa28 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_recursion_limit.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SET_RECURSION_LIMIT 3 "19 July 2017" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_recursion_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function is obsolete and should not be used in new code. Use +\fBpcre2_set_depth_limit()\fP instead. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_recursion_memory_management.3 b/miniconda3/share/man/man3/pcre2_set_recursion_memory_management.3 new file mode 100644 index 0000000000000000000000000000000000000000..68bd7ba2e7a63f1d4e885b7f41e8e76ac2312308 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_recursion_memory_management.3 @@ -0,0 +1,30 @@ +.TH PCRE2_SET_RECURSION_MEMORY_MANAGEMENT 3 "23 January 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_recursion_memory_management( +.B " pcre2_match_context *\fImcontext\fP," +.B " void *(*\fIprivate_malloc\fP)(size_t, void *)," +.B " void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +From release 10.30 onwards, this function is obsolete and does nothing. The +result is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_substitute_callout.3 b/miniconda3/share/man/man3/pcre2_set_substitute_callout.3 new file mode 100644 index 0000000000000000000000000000000000000000..bada5a335c0175843e1f777d5539dad2092fa167 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_substitute_callout.3 @@ -0,0 +1,31 @@ +.TH PCRE2_SET_SUBSTITUTE_CALLOUT 3 "04 October 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_substitute_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_substitute_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the substitute callout fields in a match context (the first +argument). The second argument specifies a callout function, and the third +argument is an opaque data item that is passed to it. The result of this +function is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_set_substitute_case_callout.3 b/miniconda3/share/man/man3/pcre2_set_substitute_case_callout.3 new file mode 100644 index 0000000000000000000000000000000000000000..5e548905a51e94cd23d266f9ef8b3b407327e262 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_set_substitute_case_callout.3 @@ -0,0 +1,33 @@ +.TH PCRE2_SET_SUBSTITUTE_CASE_CALLOUT 3 "26 December 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_set_substitute_case_callout(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE (*\fIcallout_function\fP)(PCRE2_SPTR, PCRE2_SIZE," +.B " PCRE2_UCHAR *, PCRE2_SIZE," +.B " int, void *)," +.B " void *\fIcallout_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function sets the substitute case callout fields in a match context (the +first argument). The second argument specifies a callout function, and the third +argument is an opaque data item that is passed to it. The result of this +function is always zero. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substitute.3 b/miniconda3/share/man/man3/pcre2_substitute.3 new file mode 100644 index 0000000000000000000000000000000000000000..10ffcc8c93cc58502d7fe81af136b3c02413ca8c --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substitute.3 @@ -0,0 +1,110 @@ +.TH PCRE2_SUBSTITUTE 3 "27 November 2021" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substitute(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP, PCRE2_SPTR \fIreplacement\fP," +.B " PCRE2_SIZE \fIrlength\fP, PCRE2_UCHAR *\fIoutputbuffer\fP," +.B " PCRE2_SIZE *\fIoutlengthptr\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function matches a compiled regular expression against a given subject +string, using a matching algorithm that is similar to Perl's. It then makes a +copy of the subject, substituting a replacement string for what was matched. +Its arguments are: +.sp + \fIcode\fP Points to the compiled pattern + \fIsubject\fP Points to the subject string + \fIlength\fP Length of the subject string + \fIstartoffset\fP Offset in the subject at which to start matching + \fIoptions\fP Option bits + \fImatch_data\fP Points to a match data block, or is NULL + \fImcontext\fP Points to a match context, or is NULL + \fIreplacement\fP Points to the replacement string + \fIrlength\fP Length of the replacement string + \fIoutputbuffer\fP Points to the output buffer + \fIoutlengthptr\fP Points to the length of the output buffer +.sp +A match data block is needed only if you want to inspect the data from the +final match that is returned in that block or if PCRE2_SUBSTITUTE_MATCHED is +set. A match context is needed only if you want to: +.sp + Set up a callout function + Set a matching offset limit + Change the backtracking match limit + Change the backtracking depth limit + Set custom memory management in the match context +.sp +The \fIlength\fP, \fIstartoffset\fP and \fIrlength\fP values are code units, +not characters, as is the contents of the variable pointed at by +\fIoutlengthptr\fP. This variable must contain the length of the output buffer +when the function is called. If the function is successful, the value is +changed to the length of the new string, excluding the trailing zero that is +automatically added. +.P +The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for +zero-terminated strings. The options are: +.sp + PCRE2_ANCHORED Match only at the first position + PCRE2_ENDANCHORED Match only at end of subject +.\" JOIN + PCRE2_NOTBOL Subject is not the beginning of a + line + PCRE2_NOTEOL Subject is not the end of a line +.\" JOIN + PCRE2_NOTEMPTY An empty string is not a + valid match +.\" JOIN + PCRE2_NOTEMPTY_ATSTART An empty string at the start of + the subject is not a valid match + PCRE2_NO_JIT Do not use JIT matching +.\" JOIN + PCRE2_NO_UTF_CHECK Do not check for UTF validity in + the subject or replacement +.\" JOIN + (only relevant if PCRE2_UTF was + set at compile time) + PCRE2_SUBSTITUTE_EXTENDED Do extended replacement processing +.\" JOIN + PCRE2_SUBSTITUTE_GLOBAL Replace all occurrences in the + subject + PCRE2_SUBSTITUTE_LITERAL The replacement string is literal +.\" JOIN + PCRE2_SUBSTITUTE_MATCHED Use pre-existing match data for + first match + PCRE2_SUBSTITUTE_OVERFLOW_LENGTH If overflow, compute needed length + PCRE2_SUBSTITUTE_REPLACEMENT_ONLY Return only replacement string(s) + PCRE2_SUBSTITUTE_UNKNOWN_UNSET Treat unknown group as unset + PCRE2_SUBSTITUTE_UNSET_EMPTY Simple unset insert = empty string +.sp +If PCRE2_SUBSTITUTE_LITERAL is set, PCRE2_SUBSTITUTE_EXTENDED, +PCRE2_SUBSTITUTE_UNKNOWN_UNSET, and PCRE2_SUBSTITUTE_UNSET_EMPTY are ignored. +.P +If PCRE2_SUBSTITUTE_MATCHED is set, \fImatch_data\fP must be non-NULL; its +contents must be the result of a call to \fBpcre2_match()\fP using the same +pattern and subject. +.P +The function returns the number of substitutions, which may be zero if there +are no matches. The result may be greater than one only when +PCRE2_SUBSTITUTE_GLOBAL is set. In the event of an error, a negative error code +is returned. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_copy_byname.3 b/miniconda3/share/man/man3/pcre2_substring_copy_byname.3 new file mode 100644 index 0000000000000000000000000000000000000000..bffc429728f94b819e5c3a5f932ec0cbef230f5e --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_copy_byname.3 @@ -0,0 +1,46 @@ +.TH PCRE2_SUBSTRING_COPY_BYNAME 3 "19 December 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_copy_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR *\fIbuffer\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring, identified +by name, into a given buffer. The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fIname\fP Name of the required substring + \fIbuffer\fP Buffer to receive the string + \fIbufflen\fP Length of buffer (code units) +.sp +The \fIbufflen\fP variable is updated to contain the length of the extracted +string, excluding the trailing zero. The yield of the function is zero for +success or one of the following error numbers: +.sp + PCRE2_ERROR_NOSUBSTRING there are no groups of that name + PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group + PCRE2_ERROR_UNSET the group did not participate in the match + PCRE2_ERROR_NOMEMORY the buffer is not big enough +.sp +If there is more than one group with the given name, the first one that is set +is returned. In this situation PCRE2_ERROR_UNSET means that no group with the +given name was set. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_copy_bynumber.3 b/miniconda3/share/man/man3/pcre2_substring_copy_bynumber.3 new file mode 100644 index 0000000000000000000000000000000000000000..c1ab9f3eadf1ac10369d3a8a5d1a986762397734 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_copy_bynumber.3 @@ -0,0 +1,44 @@ +.TH PCRE2_SUBSTRING_COPY_BYNUMBER 3 "13 December 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_copy_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR *\fIbuffer\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring into a given +buffer. The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fInumber\fP Number of the required substring + \fIbuffer\fP Buffer to receive the string + \fIbufflen\fP Length of buffer +.sp +The \fIbufflen\fP variable is updated with the length of the extracted string, +excluding the terminating zero. The yield of the function is zero for success +or one of the following error numbers: +.sp + PCRE2_ERROR_NOSUBSTRING there are no groups of that number + PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group + PCRE2_ERROR_UNSET the group did not participate in the match + PCRE2_ERROR_NOMEMORY the buffer is too small +.sp +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_free.3 b/miniconda3/share/man/man3/pcre2_substring_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..340be6cc522313d41e2bd59f7f50938ef73ce25a --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_free.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SUBSTRING_FREE 3 "28 June 2018" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP); +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for freeing the memory obtained by a previous +call to \fBpcre2_substring_get_byname()\fP or +\fBpcre2_substring_get_bynumber()\fP. Its only argument is a pointer to the +string. If the argument is NULL, the function does nothing. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_get_byname.3 b/miniconda3/share/man/man3/pcre2_substring_get_byname.3 new file mode 100644 index 0000000000000000000000000000000000000000..90e3310c036b4eb8a56942acda16715892426c95 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_get_byname.3 @@ -0,0 +1,48 @@ +.TH PCRE2_SUBSTRING_GET_BYNAME 3 "19 December 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_get_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring by name into +newly acquired memory. The arguments are: +.sp + \fImatch_data\fP The match data for the match + \fIname\fP Name of the required substring + \fIbufferptr\fP Where to put the string pointer + \fIbufflen\fP Where to put the string length +.sp +The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function \fBpcre2_substring_free()\fP can be used to free it when +it is no longer needed. The yield of the function is zero for success or one of +the following error numbers: +.sp + PCRE2_ERROR_NOSUBSTRING there are no groups of that name + PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group + PCRE2_ERROR_UNSET the group did not participate in the match + PCRE2_ERROR_NOMEMORY memory could not be obtained +.sp +If there is more than one group with the given name, the first one that is set +is returned. In this situation PCRE2_ERROR_UNSET means that no group with the +given name was set. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_get_bynumber.3 b/miniconda3/share/man/man3/pcre2_substring_get_bynumber.3 new file mode 100644 index 0000000000000000000000000000000000000000..8017f2dba722b7a7674b1e0b6dd6dbfda7c7a942 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_get_bynumber.3 @@ -0,0 +1,45 @@ +.TH PCRE2_SUBSTRING_GET_BYNUMBER 3 "13 December 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_get_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring by number +into newly acquired memory. The arguments are: +.sp + \fImatch_data\fP The match data for the match + \fInumber\fP Number of the required substring + \fIbufferptr\fP Where to put the string pointer + \fIbufflen\fP Where to put the string length +.sp +The memory in which the substring is placed is obtained by calling the same +memory allocation function that was used for the match data block. The +convenience function \fBpcre2_substring_free()\fP can be used to free it when +it is no longer needed. The yield of the function is zero for success or one of +the following error numbers: +.sp + PCRE2_ERROR_NOSUBSTRING there are no groups of that number + PCRE2_ERROR_UNAVAILBLE the ovector was too small for that group + PCRE2_ERROR_UNSET the group did not participate in the match + PCRE2_ERROR_NOMEMORY memory could not be obtained +.sp +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_length_byname.3 b/miniconda3/share/man/man3/pcre2_substring_length_byname.3 new file mode 100644 index 0000000000000000000000000000000000000000..111fccd3063ed8330b4950c127b73258bcf8e263 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_length_byname.3 @@ -0,0 +1,34 @@ +.TH PCRE2_SUBSTRING_LENGTH_BYNAME 3 "21 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_length_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SIZE *\fIlength\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the length of a matched substring, identified by name. +The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fIname\fP The substring name + \fIlength\fP Where to return the length +.sp +The yield is zero on success, or an error code if the substring is not found. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_length_bynumber.3 b/miniconda3/share/man/man3/pcre2_substring_length_bynumber.3 new file mode 100644 index 0000000000000000000000000000000000000000..bc7c4c1fae941a626d9f88d220a94914bbbc9f7b --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_length_bynumber.3 @@ -0,0 +1,36 @@ +.TH PCRE2_SUBSTRING_LENGTH_BYNUMBER 3 "22 December 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_length_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_SIZE *\fIlength\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This function returns the length of a matched substring, identified by number. +The arguments are: +.sp + \fImatch_data\fP The match data block for the match + \fInumber\fP The substring number + \fIlength\fP Where to return the length, or NULL +.sp +The third argument may be NULL if all you want to know is whether or not a +substring is set. The yield is zero on success, or a negative error code +otherwise. After a partial match, only substring 0 is available. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_list_free.3 b/miniconda3/share/man/man3/pcre2_substring_list_free.3 new file mode 100644 index 0000000000000000000000000000000000000000..4e02b6909019ba89299917b1c64aec9a734e2e2f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_list_free.3 @@ -0,0 +1,28 @@ +.TH PCRE2_SUBSTRING_LIST_FREE 3 "02 December 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.B void pcre2_substring_list_free(PCRE2_UCHAR **\fIlist\fP); +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for freeing the store obtained by a previous +call to \fBpcre2substring_list_get()\fP. Its only argument is a pointer to +the list of string pointers. If the argument is NULL, the function returns +immediately, without doing anything. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_list_get.3 b/miniconda3/share/man/man3/pcre2_substring_list_get.3 new file mode 100644 index 0000000000000000000000000000000000000000..20cc72c2f66340e61f37e336bb72438c4b60713e --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_list_get.3 @@ -0,0 +1,44 @@ +.TH PCRE2_SUBSTRING_LIST_GET 3 "21 October 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_list_get(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_UCHAR ***\fIlistptr\fP, PCRE2_SIZE **\fIlengthsptr\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting all the captured substrings after +a pattern match. It builds a list of pointers to the strings, and (optionally) +a second list that contains their lengths (in code units), excluding a +terminating zero that is added to each of them. All this is done in a single +block of memory that is obtained using the same memory allocation function that +was used to get the match data block. The convenience function +\fBpcre2_substring_list_free()\fP can be used to free it when it is no longer +needed. The arguments are: +.sp + \fImatch_data\fP The match data block + \fIlistptr\fP Where to put a pointer to the list + \fIlengthsptr\fP Where to put a pointer to the lengths, or NULL +.sp +A pointer to a list of pointers is put in the variable whose address is in +\fIlistptr\fP. The list is terminated by a NULL pointer. If \fIlengthsptr\fP is +not NULL, a matching list of lengths is created, and its address is placed in +\fIlengthsptr\fP. The yield of the function is zero on success or +PCRE2_ERROR_NOMEMORY if sufficient memory could not be obtained. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_nametable_scan.3 b/miniconda3/share/man/man3/pcre2_substring_nametable_scan.3 new file mode 100644 index 0000000000000000000000000000000000000000..6a9f22ae630494af882f305897a2ce0c2e44feba --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_nametable_scan.3 @@ -0,0 +1,41 @@ +.TH PCRE2_SUBSTRING_NAMETABLE_SCAN 3 "06 February 2019" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_nametable_scan(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SPTR *\fIfirst\fP, PCRE2_SPTR *\fIlast\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds, for a compiled pattern, the first and last +entries for a given name in the table that translates capture group names into +numbers. +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose entries required + \fIfirst\fP Where to return a pointer to the first entry + \fIlast\fP Where to return a pointer to the last entry +.sp +When the name is found in the table, if \fIfirst\fP is NULL, the function +returns a group number, but if there is more than one matching entry, it is not +defined which one. Otherwise, when both pointers have been set, the yield of +the function is the length of each entry in code units. If the name is not +found, PCRE2_ERROR_NOSUBSTRING is returned. +.P +There is a complete description of the PCRE2 native API, including the format of +the table entries, in the +.\" HREF +\fBpcre2api\fP +.\" +page, and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2_substring_number_from_name.3 b/miniconda3/share/man/man3/pcre2_substring_number_from_name.3 new file mode 100644 index 0000000000000000000000000000000000000000..03b445ba45cc7d57410ecb7ef799276ba0aa9081 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2_substring_number_from_name.3 @@ -0,0 +1,38 @@ +.TH PCRE2_SUBSTRING_NUMBER_FROM_NAME 3 "03 November 2014" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_substring_number_from_name(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This convenience function finds the number of a named substring capturing +parenthesis in a compiled pattern, provided that it is a unique name. The +function arguments are: +.sp + \fIcode\fP Compiled regular expression + \fIname\fP Name whose number is required +.sp +The yield of the function is the number of the parenthesis if the name is +found, or PCRE2_ERROR_NOSUBSTRING if it is not found. When duplicate names are +allowed (PCRE2_DUPNAMES is set), if the name is not unique, +PCRE2_ERROR_NOUNIQUESUBSTRING is returned. You can obtain the list of numbers +with the same name by calling \fBpcre2_substring_nametable_scan()\fP. +.P +There is a complete description of the PCRE2 native API in the +.\" HREF +\fBpcre2api\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcre2posix\fP +.\" +page. diff --git a/miniconda3/share/man/man3/pcre2api.3 b/miniconda3/share/man/man3/pcre2api.3 new file mode 100644 index 0000000000000000000000000000000000000000..b09d7ab891364c23ac42be189bc98cf1dedc8c00 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2api.3 @@ -0,0 +1,4482 @@ +.TH PCRE2API 3 "26 December 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.sp +.B #include +.sp +PCRE2 is a new API for PCRE, starting at release 10.0. This document contains a +description of all its native functions. See the +.\" HREF +\fBpcre2\fP +.\" +document for an overview of all the PCRE2 documentation. +. +. +.SH "PCRE2 NATIVE API BASIC FUNCTIONS" +.rs +.sp +.nf +.B pcre2_code *pcre2_compile(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, int *\fIerrorcode\fP, PCRE2_SIZE *\fIerroroffset,\fP" +.B " pcre2_compile_context *\fIccontext\fP);" +.sp +.B void pcre2_code_free(pcre2_code *\fIcode\fP); +.sp +.B pcre2_match_data *pcre2_match_data_create(uint32_t \fIovecsize\fP, +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_match_data *pcre2_match_data_create_from_pattern( +.B " const pcre2_code *\fIcode\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B int pcre2_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.sp +.B int pcre2_dfa_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP," +.B " int *\fIworkspace\fP, PCRE2_SIZE \fIwscount\fP);" +.sp +.B void pcre2_match_data_free(pcre2_match_data *\fImatch_data\fP); +.fi +. +. +.SH "PCRE2 NATIVE API AUXILIARY MATCH FUNCTIONS" +.rs +.sp +.nf +.B PCRE2_SPTR pcre2_get_mark(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE pcre2_get_match_data_size(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE pcre2_get_match_data_heapframes_size( +.B " pcre2_match_data *\fImatch_data\fP);" +.sp +.B uint32_t pcre2_get_ovector_count(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE *pcre2_get_ovector_pointer(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *\fImatch_data\fP); +.fi +. +. +.SH "PCRE2 NATIVE API GENERAL CONTEXT FUNCTIONS" +.rs +.sp +.nf +.B pcre2_general_context *pcre2_general_context_create( +.B " void *(*\fIprivate_malloc\fP)(PCRE2_SIZE, void *)," +.B " void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);" +.sp +.B pcre2_general_context *pcre2_general_context_copy( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_general_context_free(pcre2_general_context *\fIgcontext\fP); +.fi +. +. +.SH "PCRE2 NATIVE API COMPILE CONTEXT FUNCTIONS" +.rs +.sp +.nf +.B pcre2_compile_context *pcre2_compile_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_compile_context *pcre2_compile_context_copy( +.B " pcre2_compile_context *\fIccontext\fP);" +.sp +.B void pcre2_compile_context_free(pcre2_compile_context *\fIccontext\fP); +.sp +.B int pcre2_set_bsr(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_character_tables(pcre2_compile_context *\fIccontext\fP, +.B " const uint8_t *\fItables\fP);" +.sp +.B int pcre2_set_compile_extra_options(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIextra_options\fP);" +.sp +.B int pcre2_set_max_pattern_length(pcre2_compile_context *\fIccontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.sp +.B int pcre2_set_max_pattern_compiled_length( +.B " pcre2_compile_context *\fIccontext\fP, PCRE2_SIZE \fIvalue\fP);" +.sp +.B int pcre2_set_max_varlookbehind(pcre2_compile_contest *\fIccontext\fP, +.B " uint32_t \fIvalue\fP); +.sp +.B int pcre2_set_newline(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_parens_nest_limit(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP, +.B " int (*\fIguard_function\fP)(uint32_t, void *), void *\fIuser_data\fP);" +.sp +.B int pcre2_set_optimize(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIdirective\fP);" +.fi +. +. +.SH "PCRE2 NATIVE API MATCH CONTEXT FUNCTIONS" +.rs +.sp +.nf +.B pcre2_match_context *pcre2_match_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_match_context *pcre2_match_context_copy( +.B " pcre2_match_context *\fImcontext\fP);" +.sp +.B void pcre2_match_context_free(pcre2_match_context *\fImcontext\fP); +.sp +.B int pcre2_set_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.sp +.B int pcre2_set_substitute_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_substitute_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.sp +.B int pcre2_set_substitute_case_callout(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE (*\fIcallout_function\fP)(PCRE2_SPTR, PCRE2_SIZE," +.B " PCRE2_UCHAR *, PCRE2_SIZE," +.B " int, void *)," +.B " void *\fIcallout_data\fP);" +.sp +.B int pcre2_set_offset_limit(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.sp +.B int pcre2_set_heap_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_match_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_depth_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +. +. +.SH "PCRE2 NATIVE API STRING EXTRACTION FUNCTIONS" +.rs +.sp +.nf +.B int pcre2_substring_copy_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR *\fIbuffer\fP, PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B int pcre2_substring_copy_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR *\fIbuffer\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP); +.sp +.B int pcre2_substring_get_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B int pcre2_substring_get_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR **\fIbufferptr\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B int pcre2_substring_length_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SIZE *\fIlength\fP);" +.sp +.B int pcre2_substring_length_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_SIZE *\fIlength\fP);" +.sp +.B int pcre2_substring_nametable_scan(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SPTR *\fIfirst\fP, PCRE2_SPTR *\fIlast\fP);" +.sp +.B int pcre2_substring_number_from_name(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP);" +.sp +.B void pcre2_substring_list_free(PCRE2_UCHAR **\fIlist\fP); +.sp +.B int pcre2_substring_list_get(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_UCHAR ***\fIlistptr\fP, PCRE2_SIZE **\fIlengthsptr\fP); +.fi +. +. +.SH "PCRE2 NATIVE API STRING SUBSTITUTION FUNCTION" +.rs +.sp +.nf +.B int pcre2_substitute(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP, PCRE2_SPTR \fIreplacementz\fP," +.B " PCRE2_SIZE \fIrlength\fP, PCRE2_UCHAR *\fIoutputbuffer\fP," +.B " PCRE2_SIZE *\fIoutlengthptr\fP);" +.fi +. +. +.SH "PCRE2 NATIVE API JIT FUNCTIONS" +.rs +.sp +.nf +.B int pcre2_jit_compile(pcre2_code *\fIcode\fP, uint32_t \fIoptions\fP); +.sp +.B int pcre2_jit_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.sp +.B void pcre2_jit_free_unused_memory(pcre2_general_context *\fIgcontext\fP); +.sp +.B pcre2_jit_stack *pcre2_jit_stack_create(size_t \fIstartsize\fP, +.B " size_t \fImaxsize\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_jit_stack_assign(pcre2_match_context *\fImcontext\fP, +.B " pcre2_jit_callback \fIcallback_function\fP, void *\fIcallback_data\fP);" +.sp +.B void pcre2_jit_stack_free(pcre2_jit_stack *\fIjit_stack\fP); +.fi +. +. +.SH "PCRE2 NATIVE API SERIALIZATION FUNCTIONS" +.rs +.sp +.nf +.B int32_t pcre2_serialize_decode(pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, const uint8_t *\fIbytes\fP," +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B int32_t pcre2_serialize_encode(const pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, uint8_t **\fIserialized_bytes\fP," +.B " PCRE2_SIZE *\fIserialized_size\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_serialize_free(uint8_t *\fIbytes\fP); +.sp +.B int32_t pcre2_serialize_get_number_of_codes(const uint8_t *\fIbytes\fP); +.fi +. +. +.SH "PCRE2 NATIVE API AUXILIARY FUNCTIONS" +.rs +.sp +.nf +.B pcre2_code *pcre2_code_copy(const pcre2_code *\fIcode\fP); +.sp +.B pcre2_code *pcre2_code_copy_with_tables(const pcre2_code *\fIcode\fP); +.sp +.B int pcre2_get_error_message(int \fIerrorcode\fP, PCRE2_UCHAR *\fIbuffer\fP, +.B " PCRE2_SIZE \fIbufflen\fP);" +.sp +.B const uint8_t *pcre2_maketables(pcre2_general_context *\fIgcontext\fP); +.sp +.B void pcre2_maketables_free(pcre2_general_context *\fIgcontext\fP, +.B " const uint8_t *\fItables\fP);" +.sp +.B int pcre2_pattern_info(const pcre2_code *\fIcode\fP, uint32_t \fIwhat\fP, +.B " void *\fIwhere\fP);" +.sp +.B int pcre2_callout_enumerate(const pcre2_code *\fIcode\fP, +.B " int (*\fIcallback\fP)(pcre2_callout_enumerate_block *, void *)," +.B " void *\fIuser_data\fP);" +.sp +.B int pcre2_config(uint32_t \fIwhat\fP, void *\fIwhere\fP); +.fi +. +. +.SH "PCRE2 NATIVE API OBSOLETE FUNCTIONS" +.rs +.sp +.nf +.B int pcre2_set_recursion_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.sp +.B int pcre2_set_recursion_memory_management( +.B " pcre2_match_context *\fImcontext\fP," +.B " void *(*\fIprivate_malloc\fP)(size_t, void *)," +.B " void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);" +.fi +.sp +These functions became obsolete at release 10.30 and are retained only for +backward compatibility. They should not be used in new code. The first is +replaced by \fBpcre2_set_depth_limit()\fP; the second is no longer needed and +has no effect (it always returns zero). +. +. +.SH "PCRE2 EXPERIMENTAL PATTERN CONVERSION FUNCTIONS" +.rs +.sp +.nf +.B pcre2_convert_context *pcre2_convert_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_convert_context *pcre2_convert_context_copy( +.B " pcre2_convert_context *\fIcvcontext\fP);" +.sp +.B void pcre2_convert_context_free(pcre2_convert_context *\fIcvcontext\fP); +.sp +.B int pcre2_set_glob_escape(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIescape_char\fP);" +.sp +.B int pcre2_set_glob_separator(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIseparator_char\fP);" +.sp +.B int pcre2_pattern_convert(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, PCRE2_UCHAR **\fIbuffer\fP," +.B " PCRE2_SIZE *\fIblength\fP, pcre2_convert_context *\fIcvcontext\fP);" +.sp +.B void pcre2_converted_pattern_free(PCRE2_UCHAR *\fIconverted_pattern\fP); +.fi +.sp +These functions provide a way of converting non-PCRE2 patterns into +patterns that can be processed by \fBpcre2_compile()\fP. This facility is +experimental and may be changed in future releases. At present, "globs" and +POSIX basic and extended patterns can be converted. Details are given in the +.\" HREF +\fBpcre2convert\fP +.\" +documentation. +. +. +.SH "PCRE2 8-BIT, 16-BIT, AND 32-BIT LIBRARIES" +.rs +.sp +There are three PCRE2 libraries, supporting 8-bit, 16-bit, and 32-bit code +units, respectively. However, there is just one header file, \fBpcre2.h\fP. +This contains the function prototypes and other definitions for all three +libraries. One, two, or all three can be installed simultaneously. On Unix-like +systems the libraries are called \fBlibpcre2-8\fP, \fBlibpcre2-16\fP, and +\fBlibpcre2-32\fP, and they can also co-exist with the original PCRE libraries. +Every PCRE2 function comes in three different forms, one for each library, for +example: +.sp + \fBpcre2_compile_8()\fP + \fBpcre2_compile_16()\fP + \fBpcre2_compile_32()\fP +.sp +There are also three different sets of data types: +.sp + \fBPCRE2_UCHAR8, PCRE2_UCHAR16, PCRE2_UCHAR32\fP + \fBPCRE2_SPTR8, PCRE2_SPTR16, PCRE2_SPTR32\fP +.sp +The UCHAR types define unsigned code units of the appropriate widths. +For example, PCRE2_UCHAR16 is usually defined as `uint16_t'. +The SPTR types are pointers to constants of the equivalent UCHAR types, +that is, they are pointers to vectors of unsigned code units. +.P +Character strings are passed to a PCRE2 library as sequences of unsigned +integers in code units of the appropriate width. The length of a string may +be given as a number of code units, or the string may be specified as +zero-terminated. +.P +Many applications use only one code unit width. For their convenience, macros +are defined whose names are the generic forms such as \fBpcre2_compile()\fP and +PCRE2_SPTR. These macros use the value of the macro PCRE2_CODE_UNIT_WIDTH to +generate the appropriate width-specific function and macro names. +PCRE2_CODE_UNIT_WIDTH is not defined by default. An application must define it +to be 8, 16, or 32 before including \fBpcre2.h\fP in order to make use of the +generic names. +.P +Applications that use more than one code unit width can be linked with more +than one PCRE2 library, but must define PCRE2_CODE_UNIT_WIDTH to be 0 before +including \fBpcre2.h\fP, and then use the real function names. Any code that is +to be included in an environment where the value of PCRE2_CODE_UNIT_WIDTH is +unknown should also use the real function names. (Unfortunately, it is not +possible in C code to save and restore the value of a macro.) +.P +If PCRE2_CODE_UNIT_WIDTH is not defined before including \fBpcre2.h\fP, a +compiler error occurs. +.P +When using multiple libraries in an application, you must take care when +processing any particular pattern to use only functions from a single library. +For example, if you want to run a match using a pattern that was compiled with +\fBpcre2_compile_16()\fP, you must do so with \fBpcre2_match_16()\fP, not +\fBpcre2_match_8()\fP or \fBpcre2_match_32()\fP. +.P +In the function summaries above, and in the rest of this document and other +PCRE2 documents, functions and data types are described using their generic +names, without the _8, _16, or _32 suffix. +. +. +.SH "PCRE2 API OVERVIEW" +.rs +.sp +PCRE2 has its own native API, which is described in this document. There are +also some wrapper functions for the 8-bit library that correspond to the +POSIX regular expression API, but they do not give access to all the +functionality of PCRE2 and they are not thread-safe. They are described in the +.\" HREF +\fBpcre2posix\fP +.\" +documentation. Both these APIs define a set of C function calls. +.P +The native API C data types, function prototypes, option values, and error +codes are defined in the header file \fBpcre2.h\fP, which also contains +definitions of PCRE2_MAJOR and PCRE2_MINOR, the major and minor release numbers +for the library. Applications can use these to include support for different +releases of PCRE2. +.P +In a Windows environment, if you want to statically link an application program +against a non-dll PCRE2 library, you must define PCRE2_STATIC before including +\fBpcre2.h\fP. +.P +The functions \fBpcre2_compile()\fP and \fBpcre2_match()\fP are used for +compiling and matching regular expressions in a Perl-compatible manner. A +sample program that demonstrates the simplest way of using them is provided in +the file called \fIpcre2demo.c\fP in the PCRE2 source distribution. A listing +of this program is given in the +.\" HREF +\fBpcre2demo\fP +.\" +documentation, and the +.\" HREF +\fBpcre2sample\fP +.\" +documentation describes how to compile and run it. +.P +The compiling and matching functions recognize various options that are passed +as bits in an options argument. There are also some more complicated parameters +such as custom memory management functions and resource limits that are passed +in "contexts" (which are just memory blocks, described below). Simple +applications do not need to make use of contexts. +.P +Just-in-time (JIT) compiler support is an optional feature of PCRE2 that can be +built in appropriate hardware environments. It greatly speeds up the matching +performance of many patterns. Programs can request that it be used if +available by calling \fBpcre2_jit_compile()\fP after a pattern has been +successfully compiled by \fBpcre2_compile()\fP. This does nothing if JIT +support is not available. +.P +More complicated programs might need to make use of the specialist functions +\fBpcre2_jit_stack_create()\fP, \fBpcre2_jit_stack_free()\fP, and +\fBpcre2_jit_stack_assign()\fP in order to control the JIT code's memory usage. +.P +JIT matching is automatically used by \fBpcre2_match()\fP if it is available, +unless the PCRE2_NO_JIT option is set. There is also a direct interface for JIT +matching, which gives improved performance at the expense of less sanity +checking. The JIT-specific functions are discussed in the +.\" HREF +\fBpcre2jit\fP +.\" +documentation. +.P +A second matching function, \fBpcre2_dfa_match()\fP, which is not +Perl-compatible, is also provided. This uses a different algorithm for the +matching. The alternative algorithm finds all possible matches (at a given +point in the subject), and scans the subject just once (unless there are +lookaround assertions). However, this algorithm does not return captured +substrings. A description of the two matching algorithms and their advantages +and disadvantages is given in the +.\" HREF +\fBpcre2matching\fP +.\" +documentation. There is no JIT support for \fBpcre2_dfa_match()\fP. +.P +In addition to the main compiling and matching functions, there are convenience +functions for extracting captured substrings from a subject string that has +been matched by \fBpcre2_match()\fP. They are: +.sp + \fBpcre2_substring_copy_byname()\fP + \fBpcre2_substring_copy_bynumber()\fP + \fBpcre2_substring_get_byname()\fP + \fBpcre2_substring_get_bynumber()\fP + \fBpcre2_substring_list_get()\fP + \fBpcre2_substring_length_byname()\fP + \fBpcre2_substring_length_bynumber()\fP + \fBpcre2_substring_nametable_scan()\fP + \fBpcre2_substring_number_from_name()\fP +.sp +\fBpcre2_substring_free()\fP and \fBpcre2_substring_list_free()\fP are also +provided, to free memory used for extracted strings. If either of these +functions is called with a NULL argument, the function returns immediately +without doing anything. +.P +The function \fBpcre2_substitute()\fP can be called to match a pattern and +return a copy of the subject string with substitutions for parts that were +matched. +.P +Functions whose names begin with \fBpcre2_serialize_\fP are used for saving +compiled patterns on disc or elsewhere, and reloading them later. +.P +Finally, there are functions for finding out information about a compiled +pattern (\fBpcre2_pattern_info()\fP) and about the configuration with which +PCRE2 was built (\fBpcre2_config()\fP). +.P +Functions with names ending with \fB_free()\fP are used for freeing memory +blocks of various sorts. In all cases, if one of these functions is called with +a NULL argument, it does nothing. +. +. +.SH "STRING LENGTHS AND OFFSETS" +.rs +.sp +The PCRE2 API uses string lengths and offsets into strings of code units in +several places. These values are always of type PCRE2_SIZE, which is an +unsigned integer type, currently always defined as \fIsize_t\fP. The largest +value that can be stored in such a type (that is ~(PCRE2_SIZE)0) is reserved +as a special indicator for zero-terminated strings and unset offsets. +Therefore, the longest string that can be handled is one less than this +maximum. Note that string lengths are always given in code units. Only in the +8-bit library is such a length the same as the number of bytes in the string. +. +. +.\" HTML +.SH NEWLINES +.rs +.sp +PCRE2 supports five different conventions for indicating line breaks in +strings: a single CR (carriage return) character, a single LF (linefeed) +character, the two-character sequence CRLF, any of the three preceding, or any +Unicode newline sequence. The Unicode newline sequences are the three just +mentioned, plus the single characters VT (vertical tab, U+000B), FF (form feed, +U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS +(paragraph separator, U+2029). +.P +Each of the first three conventions is used by at least one operating system as +its standard newline sequence. When PCRE2 is built, a default can be specified. +If it is not, the default is set to LF, which is the Unix standard. However, +the newline convention can be changed by an application when calling +\fBpcre2_compile()\fP, or it can be specified by special text at the start of +the pattern itself; this overrides any other settings. See the +.\" HREF +\fBpcre2pattern\fP +.\" +page for details of the special character sequences. +.P +In the PCRE2 documentation the word "newline" is used to mean "the character or +pair of characters that indicate a line break". The choice of newline +convention affects the handling of the dot, circumflex, and dollar +metacharacters, the handling of #-comments in /x mode, and, when CRLF is a +recognized line ending sequence, the match position advancement for a +non-anchored pattern. There is more detail about this in the +.\" HTML +.\" +section on \fBpcre2_match()\fP options +.\" +below. +.P +The choice of newline convention does not affect the interpretation of +the \en or \er escape sequences, nor does it affect what \eR matches; this has +its own separate convention. +. +. +.SH MULTITHREADING +.rs +.sp +In a multithreaded application it is important to keep thread-specific data +separate from data that can be shared between threads. The PCRE2 library code +itself is thread-safe: it contains no static or global variables. The API is +designed to be fairly simple for non-threaded applications while at the same +time ensuring that multithreaded applications can use it. +.P +There are several different blocks of data that are used to pass information +between the application and the PCRE2 libraries. +. +. +.SS "The compiled pattern" +.rs +.sp +A pointer to the compiled form of a pattern is returned to the user when +\fBpcre2_compile()\fP is successful. The data in the compiled pattern is fixed, +and does not change when the pattern is matched. Therefore, it is thread-safe, +that is, the same compiled pattern can be used by more than one thread +simultaneously. For example, an application can compile all its patterns at the +start, before forking off multiple threads that use them. However, if the +just-in-time (JIT) optimization feature is being used, it needs separate memory +stack areas for each thread. See the +.\" HREF +\fBpcre2jit\fP +.\" +documentation for more details. +.P +In a more complicated situation, where patterns are compiled only when they are +first needed, but are still shared between threads, pointers to compiled +patterns must be protected from simultaneous writing by multiple threads. This +is somewhat tricky to do correctly. If you know that writing to a pointer is +atomic in your environment, you can use logic like this: +.sp + Get a read-only (shared) lock (mutex) for pointer + if (pointer == NULL) + { + Get a write (unique) lock for pointer + if (pointer == NULL) pointer = pcre2_compile(... + } + Release the lock + Use pointer in pcre2_match() +.sp +Of course, testing for compilation errors should also be included in the code. +.P +The reason for checking the pointer a second time is as follows: Several +threads may have acquired the shared lock and tested the pointer for being +NULL, but only one of them will be given the write lock, with the rest kept +waiting. The winning thread will compile the pattern and store the result. +After this thread releases the write lock, another thread will get it, and if +it does not retest pointer for being NULL, will recompile the pattern and +overwrite the pointer, creating a memory leak and possibly causing other +issues. +.P +In an environment where writing to a pointer may not be atomic, the above logic +is not sufficient. The thread that is doing the compiling may be descheduled +after writing only part of the pointer, which could cause other threads to use +an invalid value. Instead of checking the pointer itself, a separate "pointer +is valid" flag (that can be updated atomically) must be used: +.sp + Get a read-only (shared) lock (mutex) for pointer + if (!pointer_is_valid) + { + Get a write (unique) lock for pointer + if (!pointer_is_valid) + { + pointer = pcre2_compile(... + pointer_is_valid = TRUE + } + } + Release the lock + Use pointer in pcre2_match() +.sp +If JIT is being used, but the JIT compilation is not being done immediately +(perhaps waiting to see if the pattern is used often enough), similar logic is +required. JIT compilation updates a value within the compiled code block, so a +thread must gain unique write access to the pointer before calling +\fBpcre2_jit_compile()\fP. Alternatively, \fBpcre2_code_copy()\fP or +\fBpcre2_code_copy_with_tables()\fP can be used to obtain a private copy of the +compiled code before calling the JIT compiler. +. +. +.SS "Context blocks" +.rs +.sp +The next main section below introduces the idea of "contexts" in which PCRE2 +functions are called. A context is nothing more than a collection of parameters +that control the way PCRE2 operates. Grouping a number of parameters together +in a context is a convenient way of passing them to a PCRE2 function without +using lots of arguments. The parameters that are stored in contexts are in some +sense "advanced features" of the API. Many straightforward applications will +not need to use contexts. +.P +In a multithreaded application, if the parameters in a context are values that +are never changed, the same context can be used by all the threads. However, if +any thread needs to change any value in a context, it must make its own +thread-specific copy. +. +. +.SS "Match blocks" +.rs +.sp +The matching functions need a block of memory for storing the results of a +match. This includes details of what was matched, as well as additional +information such as the name of a (*MARK) setting. Each thread must provide its +own copy of this memory. +. +. +.SH "PCRE2 CONTEXTS" +.rs +.sp +Some PCRE2 functions have a lot of parameters, many of which are used only by +specialist applications, for example, those that use custom memory management +or non-standard character tables. To keep function argument lists at a +reasonable size, and at the same time to keep the API extensible, "uncommon" +parameters are passed to certain functions in a \fBcontext\fP instead of +directly. A context is just a block of memory that holds the parameter values. +Applications that do not need to adjust any of the context parameters can pass +NULL when a context pointer is required. +.P +There are three different types of context: a general context that is relevant +for several PCRE2 operations, a compile-time context, and a match-time context. +. +. +.SS "The general context" +.rs +.sp +At present, this context just contains pointers to (and data for) external +memory management functions that are called from several places in the PCRE2 +library. The context is named `general' rather than specifically `memory' +because in future other fields may be added. If you do not want to supply your +own custom memory management functions, you do not need to bother with a +general context. A general context is created by: +.sp +.nf +.B pcre2_general_context *pcre2_general_context_create( +.B " void *(*\fIprivate_malloc\fP)(PCRE2_SIZE, void *)," +.B " void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);" +.fi +.sp +The two function pointers specify custom memory management functions, whose +prototypes are: +.sp + \fBvoid *private_malloc(PCRE2_SIZE, void *);\fP + \fBvoid private_free(void *, void *);\fP +.sp +Whenever code in PCRE2 calls these functions, the final argument is the value +of \fImemory_data\fP. Either of the first two arguments of the creation +function may be NULL, in which case the system memory management functions +\fImalloc()\fP and \fIfree()\fP are used. (This is not currently useful, as +there are no other fields in a general context, but in future there might be.) +The \fIprivate_malloc()\fP function is used (if supplied) to obtain memory for +storing the context, and all three values are saved as part of the context. +.P +Whenever PCRE2 creates a data block of any kind, the block contains a pointer +to the \fIfree()\fP function that matches the \fImalloc()\fP function that was +used. When the time comes to free the block, this function is called. +.P +A general context can be copied by calling: +.sp +.nf +.B pcre2_general_context *pcre2_general_context_copy( +.B " pcre2_general_context *\fIgcontext\fP);" +.fi +.sp +The memory used for a general context should be freed by calling: +.sp +.nf +.B void pcre2_general_context_free(pcre2_general_context *\fIgcontext\fP); +.fi +.sp +If this function is passed a NULL argument, it returns immediately without +doing anything. +. +. +.\" HTML +.SS "The compile context" +.rs +.sp +A compile context is required if you want to provide an external function for +stack checking during compilation or to change the default values of any of the +following compile-time parameters: +.sp + What \eR matches (Unicode newlines or CR, LF, CRLF only) + PCRE2's character tables + The newline character sequence + The compile time nested parentheses limit + The maximum length of the pattern string + The extra options bits (none set by default) + Which performance optimizations the compiler should apply +.sp +A compile context is also required if you are using custom memory management. +If none of these apply, just pass NULL as the context argument of +\fIpcre2_compile()\fP. +.P +A compile context is created, copied, and freed by the following functions: +.sp +.nf +.B pcre2_compile_context *pcre2_compile_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_compile_context *pcre2_compile_context_copy( +.B " pcre2_compile_context *\fIccontext\fP);" +.sp +.B void pcre2_compile_context_free(pcre2_compile_context *\fIccontext\fP); +.fi +.sp +A compile context is created with default values for its parameters. These can +be changed by calling the following functions, which return 0 on success, or +PCRE2_ERROR_BADDATA if invalid data is detected. +.sp +.nf +.B int pcre2_set_bsr(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +The value must be PCRE2_BSR_ANYCRLF, to specify that \eR matches only CR, LF, +or CRLF, or PCRE2_BSR_UNICODE, to specify that \eR matches any Unicode line +ending sequence. The value is used by the JIT compiler and by the two +interpreted matching functions, \fIpcre2_match()\fP and +\fIpcre2_dfa_match()\fP. +.sp +.nf +.B int pcre2_set_character_tables(pcre2_compile_context *\fIccontext\fP, +.B " const uint8_t *\fItables\fP);" +.fi +.sp +The value must be the result of a call to \fBpcre2_maketables()\fP, whose only +argument is a general context. This function builds a set of character tables +in the current locale. +.sp +.nf +.B int pcre2_set_compile_extra_options(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIextra_options\fP);" +.fi +.sp +As PCRE2 has developed, almost all the 32 option bits that are available in +the \fIoptions\fP argument of \fBpcre2_compile()\fP have been used up. To avoid +running out, the compile context contains a set of extra option bits which are +used for some newer, assumed rarer, options. This function sets those bits. It +always sets all the bits (either on or off). It does not modify any existing +setting. The available options are defined in the section entitled "Extra +compile options" +.\" HTML +.\" +below. +.\" +.sp +.nf +.B int pcre2_set_max_pattern_length(pcre2_compile_context *\fIccontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.fi +.sp +This sets a maximum length, in code units, for any pattern string that is +compiled with this context. If the pattern is longer, an error is generated. +This facility is provided so that applications that accept patterns from +external sources can limit their size. The default is the largest number that a +PCRE2_SIZE variable can hold, which is effectively unlimited. +.sp +.nf +.B int pcre2_set_max_pattern_compiled_length( +.B " pcre2_compile_context *\fIccontext\fP, PCRE2_SIZE \fIvalue\fP);" +.fi +.sp +This sets a maximum size, in bytes, for the memory needed to hold the compiled +version of a pattern that is compiled with this context. If the pattern needs +more memory, an error is generated. This facility is provided so that +applications that accept patterns from external sources can limit the amount of +memory they use. The default is the largest number that a PCRE2_SIZE variable +can hold, which is effectively unlimited. +.sp +.nf +.B int pcre2_set_max_varlookbehind(pcre2_compile_contest *\fIccontext\fP, +.B " uint32_t \fIvalue\fP); +.fi +.sp +This sets a maximum length for the number of characters matched by a +variable-length lookbehind assertion. The default is set when PCRE2 is built, +with the ultimate default being 255, the same as Perl. Lookbehind assertions +without a bounding length are not supported. +.sp +.nf +.B int pcre2_set_newline(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +This specifies which characters or character sequences are to be recognized as +newlines. The value must be one of PCRE2_NEWLINE_CR (carriage return only), +PCRE2_NEWLINE_LF (linefeed only), PCRE2_NEWLINE_CRLF (the two-character +sequence CR followed by LF), PCRE2_NEWLINE_ANYCRLF (any of the above), +PCRE2_NEWLINE_ANY (any Unicode newline sequence), or PCRE2_NEWLINE_NUL (the +NUL character, that is a binary zero). +.P +A pattern can override the value set in the compile context by starting with a +sequence such as (*CRLF). See the +.\" HREF +\fBpcre2pattern\fP +.\" +page for details. +.P +When a pattern is compiled with the PCRE2_EXTENDED or PCRE2_EXTENDED_MORE +option, the newline convention affects the recognition of the end of internal +comments starting with #. The value is saved with the compiled pattern for +subsequent use by the JIT compiler and by the two interpreted matching +functions, \fIpcre2_match()\fP and \fIpcre2_dfa_match()\fP. +.sp +.nf +.B int pcre2_set_parens_nest_limit(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +This parameter adjusts the limit, set when PCRE2 is built (default 250), on the +depth of parenthesis nesting in a pattern. This limit stops rogue patterns +using up too much system stack when being compiled. The limit applies to +parentheses of all kinds, not just capturing parentheses. +.sp +.nf +.B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP, +.B " int (*\fIguard_function\fP)(uint32_t, void *), void *\fIuser_data\fP);" +.fi +.sp +There is at least one application that runs PCRE2 in threads with very limited +system stack, where running out of stack is to be avoided at all costs. The +parenthesis limit above cannot take account of how much stack is actually +available during compilation. For a finer control, you can supply a function +that is called whenever \fBpcre2_compile()\fP starts to compile a parenthesized +part of a pattern. This function can check the actual stack size (or anything +else that it wants to, of course). +.P +The first argument to the callout function gives the current depth of +nesting, and the second is user data that is set up by the last argument of +\fBpcre2_set_compile_recursion_guard()\fP. The callout function should return +zero if all is well, or non-zero to force an error. +.sp +.nf +.B int pcre2_set_optimize(pcre2_compile_context *\fIccontext\fP, +.B " uint32_t \fIdirective\fP);" +.fi +.sp +PCRE2 can apply various performance optimizations during compilation, in order +to make matching faster. For example, the compiler might convert some regex +constructs into an equivalent construct which \fBpcre2_match()\fP can execute +faster. By default, all available optimizations are enabled. However, in rare +cases, one might wish to disable specific optimizations. For example, if it is +known that some optimizations cannot benefit a certain regex, it might be +desirable to disable them, in order to speed up compilation. +.P +The permitted values of \fIdirective\fP are as follows: +.sp + PCRE2_OPTIMIZATION_FULL +.sp +Enable all optional performance optimizations. This is the default value. +.sp + PCRE2_OPTIMIZATION_NONE +.sp +Disable all optional performance optimizations. +.sp + PCRE2_AUTO_POSSESS + PCRE2_AUTO_POSSESS_OFF +.sp +Enable/disable "auto-possessification" of variable quantifiers such as * and +. +This optimization, for example, turns a+b into a++b in order to avoid +backtracks into a+ that can never be successful. However, if callouts are in +use, auto-possessification means that some callouts are never taken. You can +disable this optimization if you want the matching functions to do a full, +unoptimized search and run all the callouts. +.sp + PCRE2_DOTSTAR_ANCHOR + PCRE2_DOTSTAR_ANCHOR_OFF +.sp +Enable/disable an optimization that is applied when .* is the first significant +item in a top-level branch of a pattern, and all the other branches also start +with .* or with \eA or \eG or ^. Such a pattern is automatically anchored if +PCRE2_DOTALL is set for all the .* items and PCRE2_MULTILINE is not set for any +^ items. Otherwise, the fact that any match must start either at the start of +the subject or following a newline is remembered. Like other optimizations, +this can cause callouts to be skipped. +.P +Dotstar anchor optimization is automatically disabled for .* if it is inside an +atomic group or a capture group that is the subject of a backreference, or if +the pattern contains (*PRUNE) or (*SKIP). +.sp + PCRE2_START_OPTIMIZE + PCRE2_START_OPTIMIZE_OFF +.sp +Enable/disable optimizations which cause matching functions to scan the subject +string for specific code unit values before attempting a match. For example, if +it is known that an unanchored match must start with a specific value, the +matching code searches the subject for that value, and fails immediately if it +cannot find it, without actually running the main matching function. This means +that a special item such as (*COMMIT) at the start of a pattern is not +considered until after a suitable starting point for the match has been found. +Also, when callouts or (*MARK) items are in use, these "start-up" optimizations +can cause them to be skipped if the pattern is never actually used. The start-up +optimizations are in effect a pre-scan of the subject that takes place before +the pattern is run. +.P +Disabling start-up optimizations ensures that in cases where the result is "no +match", the callouts do occur, and that items such as (*COMMIT) and (*MARK) are +considered at every possible starting position in the subject string. +.P +Disabling start-up optimizations may change the outcome of a matching operation. +Consider the pattern +.sp + (*COMMIT)ABC +.sp +When this is compiled, PCRE2 records the fact that a match must start with the +character "A". Suppose the subject string is "DEFABC". The start-up +optimization scans along the subject, finds "A" and runs the first match +attempt from there. The (*COMMIT) item means that the pattern must match the +current starting position, which in this case, it does. However, if the same +match is run without start-up optimizations, the initial scan along the subject +string does not happen. The first match attempt is run starting from "D" and +when this fails, (*COMMIT) prevents any further matches being tried, so the +overall result is "no match". +.P +Another start-up optimization makes use of a minimum length for a matching +subject, which is recorded when possible. Consider the pattern +.sp + (*MARK:1)B(*MARK:2)(X|Y) +.sp +The minimum length for a match is two characters. If the subject is "XXBB", the +"starting character" optimization skips "XX", then tries to match "BB", which +is long enough. In the process, (*MARK:2) is encountered and remembered. When +the match attempt fails, the next "B" is found, but there is only one character +left, so there are no more attempts, and "no match" is returned with the "last +mark seen" set to "2". Without start-up optimizations, however, matches are +tried at every possible starting position, including at the end of the subject, +where (*MARK:1) is encountered, but there is no "B", so the "last mark seen" +that is returned is "1". In this case, the optimizations do not affect the +overall match result, which is still "no match", but they do affect the +auxiliary information that is returned. +. +. +.\" HTML +.SS "The match context" +.rs +.sp +A match context is required if you want to: +.sp + Set up a callout function + Set an offset limit for matching an unanchored pattern + Change the limit on the amount of heap used when matching + Change the backtracking match limit + Change the backtracking depth limit + Set custom memory management specifically for the match +.sp +If none of these apply, just pass NULL as the context argument of +\fBpcre2_match()\fP, \fBpcre2_dfa_match()\fP, or \fBpcre2_jit_match()\fP. +.P +A match context is created, copied, and freed by the following functions: +.sp +.nf +.B pcre2_match_context *pcre2_match_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_match_context *pcre2_match_context_copy( +.B " pcre2_match_context *\fImcontext\fP);" +.sp +.B void pcre2_match_context_free(pcre2_match_context *\fImcontext\fP); +.fi +.sp +A match context is created with default values for its parameters. These can +be changed by calling the following functions, which return 0 on success, or +PCRE2_ERROR_BADDATA if invalid data is detected. +.sp +.nf +.B int pcre2_set_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.fi +.sp +This sets up a callout function for PCRE2 to call at specified points +during a matching operation. Details are given in the +.\" HREF +\fBpcre2callout\fP +.\" +documentation. +.sp +.nf +.B int pcre2_set_substitute_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_substitute_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.fi +.sp +This sets up a callout function for PCRE2 to call after each substitution +made by \fBpcre2_substitute()\fP. Details are given in the section entitled +"Creating a new string with substitutions" +.\" HTML +.\" +below. +.\" +.sp +.nf +.B int pcre2_set_substitute_case_callout(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE (*\fIcallout_function\fP)(PCRE2_SPTR, PCRE2_SIZE," +.B " PCRE2_UCHAR *, PCRE2_SIZE," +.B " int, void *)," +.B " void *\fIcallout_data\fP);" +.fi +.sp +This sets up a callout function for PCRE2 to call when performing case +transformations inside \fBpcre2_substitute()\fP. Details are given in the +section entitled "Creating a new string with substitutions" +.\" HTML +.\" +below. +.\" +.sp +.nf +.B int pcre2_set_offset_limit(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE \fIvalue\fP);" +.fi +.sp +The \fIoffset_limit\fP parameter limits how far an unanchored search can +advance in the subject string. The default value is PCRE2_UNSET. The +\fBpcre2_match()\fP and \fBpcre2_dfa_match()\fP functions return +PCRE2_ERROR_NOMATCH if a match with a starting point before or at the given +offset is not found. The \fBpcre2_substitute()\fP function makes no more +substitutions. +.P +For example, if the pattern /abc/ is matched against "123abc" with an offset +limit less than 3, the result is PCRE2_ERROR_NOMATCH. A match can never be +found if the \fIstartoffset\fP argument of \fBpcre2_match()\fP, +\fBpcre2_dfa_match()\fP, or \fBpcre2_substitute()\fP is greater than the offset +limit set in the match context. +.P +When using this facility, you must set the PCRE2_USE_OFFSET_LIMIT option when +calling \fBpcre2_compile()\fP so that when JIT is in use, different code can be +compiled. If a match is started with a non-default match limit when +PCRE2_USE_OFFSET_LIMIT is not set, an error is generated. +.P +The offset limit facility can be used to track progress when searching large +subject strings or to limit the extent of global substitutions. See also the +PCRE2_FIRSTLINE option, which requires a match to start before or at the first +newline that follows the start of matching in the subject. If this is set with +an offset limit, a match must occur in the first line and also within the +offset limit. In other words, whichever limit comes first is used. +.sp +.nf +.B int pcre2_set_heap_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +The \fIheap_limit\fP parameter specifies, in units of kibibytes (1024 bytes), +the maximum amount of heap memory that \fBpcre2_match()\fP may use to hold +backtracking information when running an interpretive match. This limit also +applies to \fBpcre2_dfa_match()\fP, which may use the heap when processing +patterns with a lot of nested pattern recursion or lookarounds or atomic +groups. This limit does not apply to matching with the JIT optimization, which +has its own memory control arrangements (see the +.\" HREF +\fBpcre2jit\fP +.\" +documentation for more details). If the limit is reached, the negative error +code PCRE2_ERROR_HEAPLIMIT is returned. The default limit can be set when PCRE2 +is built; if it is not, the default is set very large and is essentially +unlimited. +.P +A value for the heap limit may also be supplied by an item at the start of a +pattern of the form +.sp + (*LIMIT_HEAP=ddd) +.sp +where ddd is a decimal number. However, such a setting is ignored unless ddd is +less than the limit set by the caller of \fBpcre2_match()\fP or, if no such +limit is set, less than the default. +.P +The \fBpcre2_match()\fP function always needs some heap memory, so setting a +value of zero guarantees a "heap limit exceeded" error. Details of how +\fBpcre2_match()\fP uses the heap are given in the +.\" HREF +\fBpcre2perform\fP +.\" +documentation. +.P +For \fBpcre2_dfa_match()\fP, a vector on the system stack is used when +processing pattern recursions, lookarounds, or atomic groups, and only if this +is not big enough is heap memory used. In this case, setting a value of zero +disables the use of the heap. +.sp +.nf +.B int pcre2_set_match_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +The \fImatch_limit\fP parameter provides a means of preventing PCRE2 from using +up too many computing resources when processing patterns that are not going to +match, but which have a very large number of possibilities in their search +trees. The classic example is a pattern that uses nested unlimited repeats. +.P +There is an internal counter in \fBpcre2_match()\fP that is incremented each +time round its main matching loop. If this value reaches the match limit, +\fBpcre2_match()\fP returns the negative value PCRE2_ERROR_MATCHLIMIT. This has +the effect of limiting the amount of backtracking that can take place. For +patterns that are not anchored, the count restarts from zero for each position +in the subject string. This limit also applies to \fBpcre2_dfa_match()\fP, +though the counting is done in a different way. +.P +When \fBpcre2_match()\fP is called with a pattern that was successfully +processed by \fBpcre2_jit_compile()\fP, the way in which matching is executed +is entirely different. However, there is still the possibility of runaway +matching that goes on for a very long time, and so the \fImatch_limit\fP value +is also used in this case (but in a different way) to limit how long the +matching can continue. +.P +The default value for the limit can be set when PCRE2 is built; the default is +10 million, which handles all but the most extreme cases. A value for the match +limit may also be supplied by an item at the start of a pattern of the form +.sp + (*LIMIT_MATCH=ddd) +.sp +where ddd is a decimal number. However, such a setting is ignored unless ddd is +less than the limit set by the caller of \fBpcre2_match()\fP or +\fBpcre2_dfa_match()\fP or, if no such limit is set, less than the default. +.sp +.nf +.B int pcre2_set_depth_limit(pcre2_match_context *\fImcontext\fP, +.B " uint32_t \fIvalue\fP);" +.fi +.sp +This parameter limits the depth of nested backtracking in \fBpcre2_match()\fP. +Each time a nested backtracking point is passed, a new memory frame is used +to remember the state of matching at that point. Thus, this parameter +indirectly limits the amount of memory that is used in a match. However, +because the size of each memory frame depends on the number of capturing +parentheses, the actual memory limit varies from pattern to pattern. This limit +was more useful in versions before 10.30, where function recursion was used for +backtracking. +.P +The depth limit is not relevant, and is ignored, when matching is done using +JIT compiled code. However, it is supported by \fBpcre2_dfa_match()\fP, which +uses it to limit the depth of nested internal recursive function calls that +implement atomic groups, lookaround assertions, and pattern recursions. This +limits, indirectly, the amount of system stack that is used. It was more useful +in versions before 10.32, when stack memory was used for local workspace +vectors for recursive function calls. From version 10.32, only local variables +are allocated on the stack and as each call uses only a few hundred bytes, even +a small stack can support quite a lot of recursion. +.P +If the depth of internal recursive function calls is great enough, local +workspace vectors are allocated on the heap from version 10.32 onwards, so the +depth limit also indirectly limits the amount of heap memory that is used. A +recursive pattern such as /(.(?2))((?1)|)/, when matched to a very long string +using \fBpcre2_dfa_match()\fP, can use a great deal of memory. However, it is +probably better to limit heap usage directly by calling +\fBpcre2_set_heap_limit()\fP. +.P +The default value for the depth limit can be set when PCRE2 is built; if it is +not, the default is set to the same value as the default for the match limit. +If the limit is exceeded, \fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP +returns PCRE2_ERROR_DEPTHLIMIT. A value for the depth limit may also be +supplied by an item at the start of a pattern of the form +.sp + (*LIMIT_DEPTH=ddd) +.sp +where ddd is a decimal number. However, such a setting is ignored unless ddd is +less than the limit set by the caller of \fBpcre2_match()\fP or +\fBpcre2_dfa_match()\fP or, if no such limit is set, less than the default. +. +. +.SH "CHECKING BUILD-TIME OPTIONS" +.rs +.sp +.B int pcre2_config(uint32_t \fIwhat\fP, void *\fIwhere\fP); +.P +The function \fBpcre2_config()\fP makes it possible for a PCRE2 client to find +the value of certain configuration parameters and to discover which optional +features have been compiled into the PCRE2 library. The +.\" HREF +\fBpcre2build\fP +.\" +documentation has more details about these features. +.P +The first argument for \fBpcre2_config()\fP specifies which information is +required. The second argument is a pointer to memory into which the information +is placed. If NULL is passed, the function returns the amount of memory that is +needed for the requested information. For calls that return numerical values, +the value is in bytes; when requesting these values, \fIwhere\fP should point +to appropriately aligned memory. For calls that return strings, the required +length is given in code units, not counting the terminating zero. +.P +When requesting information, the returned value from \fBpcre2_config()\fP is +non-negative on success, or the negative error code PCRE2_ERROR_BADOPTION if +the value in the first argument is not recognized. The following information is +available: +.sp + PCRE2_CONFIG_BSR +.sp +The output is a uint32_t integer whose value indicates what character +sequences the \eR escape sequence matches by default. A value of +PCRE2_BSR_UNICODE means that \eR matches any Unicode line ending sequence; a +value of PCRE2_BSR_ANYCRLF means that \eR matches only CR, LF, or CRLF. The +default can be overridden when a pattern is compiled. +.sp + PCRE2_CONFIG_COMPILED_WIDTHS +.sp +The output is a uint32_t integer whose lower bits indicate which code unit +widths were selected when PCRE2 was built. The 1-bit indicates 8-bit support, +and the 2-bit and 4-bit indicate 16-bit and 32-bit support, respectively. +.sp + PCRE2_CONFIG_DEPTHLIMIT +.sp +The output is a uint32_t integer that gives the default limit for the depth of +nested backtracking in \fBpcre2_match()\fP or the depth of nested recursions, +lookarounds, and atomic groups in \fBpcre2_dfa_match()\fP. Further details are +given with \fBpcre2_set_depth_limit()\fP above. +.sp + PCRE2_CONFIG_HEAPLIMIT +.sp +The output is a uint32_t integer that gives, in kibibytes, the default limit +for the amount of heap memory used by \fBpcre2_match()\fP or +\fBpcre2_dfa_match()\fP. Further details are given with +\fBpcre2_set_heap_limit()\fP above. +.sp + PCRE2_CONFIG_JIT +.sp +The output is a uint32_t integer that is set to one if support for just-in-time +compiling is included in the library; otherwise it is set to zero. Note that +having the support in the library does not guarantee that JIT will be used for +any given match, and neither does it guarantee that JIT will actually be able +to function, because it may not be able to allocate executable memory in some +environments. There is a special call to \fBpcre2_jit_compile()\fP that can be +used to check this. See the +.\" HREF +\fBpcre2jit\fP +.\" +documentation for more details. +.sp + PCRE2_CONFIG_JITTARGET +.sp +The \fIwhere\fP argument should point to a buffer that is at least 48 code +units long. (The exact length required can be found by calling +\fBpcre2_config()\fP with \fBwhere\fP set to NULL.) The buffer is filled with a +string that contains the name of the architecture for which the JIT compiler is +configured, for example "x86 32bit (little endian + unaligned)". If JIT support +is not available, PCRE2_ERROR_BADOPTION is returned, otherwise the number of +code units used is returned. This is the length of the string, plus one unit +for the terminating zero. +.sp + PCRE2_CONFIG_LINKSIZE +.sp +The output is a uint32_t integer that contains the number of bytes used for +internal linkage in compiled regular expressions. When PCRE2 is configured, the +value can be set to 2, 3, or 4, with the default being 2. This is the value +that is returned by \fBpcre2_config()\fP. However, when the 16-bit library is +compiled, a value of 3 is rounded up to 4, and when the 32-bit library is +compiled, internal linkages always use 4 bytes, so the configured value is not +relevant. +.P +The default value of 2 for the 8-bit and 16-bit libraries is sufficient for all +but the most massive patterns, since it allows the size of the compiled pattern +to be up to 65535 code units. Larger values allow larger regular expressions to +be compiled by those two libraries, but at the expense of slower matching. +.sp + PCRE2_CONFIG_MATCHLIMIT +.sp +The output is a uint32_t integer that gives the default match limit for +\fBpcre2_match()\fP. Further details are given with +\fBpcre2_set_match_limit()\fP above. +.sp + PCRE2_CONFIG_NEWLINE +.sp +The output is a uint32_t integer whose value specifies the default character +sequence that is recognized as meaning "newline". The values are: +.sp + PCRE2_NEWLINE_CR Carriage return (CR) + PCRE2_NEWLINE_LF Linefeed (LF) + PCRE2_NEWLINE_CRLF Carriage return, linefeed (CRLF) + PCRE2_NEWLINE_ANY Any Unicode line ending + PCRE2_NEWLINE_ANYCRLF Any of CR, LF, or CRLF + PCRE2_NEWLINE_NUL The NUL character (binary zero) +.sp +The default should normally correspond to the standard sequence for your +operating system. +.sp + PCRE2_CONFIG_NEVER_BACKSLASH_C +.sp +The output is a uint32_t integer that is set to one if the use of \eC was +permanently disabled when PCRE2 was built; otherwise it is set to zero. +.sp + PCRE2_CONFIG_PARENSLIMIT +.sp +The output is a uint32_t integer that gives the maximum depth of nesting +of parentheses (of any kind) in a pattern. This limit is imposed to cap the +amount of system stack used when a pattern is compiled. It is specified when +PCRE2 is built; the default is 250. This limit does not take into account the +stack that may already be used by the calling application. For finer control +over compilation stack usage, see \fBpcre2_set_compile_recursion_guard()\fP. +.sp + PCRE2_CONFIG_STACKRECURSE +.sp +This parameter is obsolete and should not be used in new code. The output is a +uint32_t integer that is always set to zero. +.sp + PCRE2_CONFIG_TABLES_LENGTH +.sp +The output is a uint32_t integer that gives the length of PCRE2's character +processing tables in bytes. For details of these tables see the +.\" HTML +.\" +section on locale support +.\" +below. +.sp + PCRE2_CONFIG_UNICODE_VERSION +.sp +The \fIwhere\fP argument should point to a buffer that is at least 24 code +units long. (The exact length required can be found by calling +\fBpcre2_config()\fP with \fBwhere\fP set to NULL.) If PCRE2 has been compiled +without Unicode support, the buffer is filled with the text "Unicode not +supported". Otherwise, the Unicode version string (for example, "8.0.0") is +inserted. The number of code units used is returned. This is the length of the +string plus one unit for the terminating zero. +.sp + PCRE2_CONFIG_UNICODE +.sp +The output is a uint32_t integer that is set to one if Unicode support is +available; otherwise it is set to zero. Unicode support implies UTF support. +.sp + PCRE2_CONFIG_VERSION +.sp +The \fIwhere\fP argument should point to a buffer that is at least 24 code +units long. (The exact length required can be found by calling +\fBpcre2_config()\fP with \fBwhere\fP set to NULL.) The buffer is filled with +the PCRE2 version string, zero-terminated. The number of code units used is +returned. This is the length of the string plus one unit for the terminating +zero. +. +. +.\" HTML +.SH "COMPILING A PATTERN" +.rs +.sp +.nf +.B pcre2_code *pcre2_compile(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, int *\fIerrorcode\fP, PCRE2_SIZE *\fIerroroffset,\fP" +.B " pcre2_compile_context *\fIccontext\fP);" +.sp +.B void pcre2_code_free(pcre2_code *\fIcode\fP); +.sp +.B pcre2_code *pcre2_code_copy(const pcre2_code *\fIcode\fP); +.sp +.B pcre2_code *pcre2_code_copy_with_tables(const pcre2_code *\fIcode\fP); +.fi +.P +The \fBpcre2_compile()\fP function compiles a pattern into an internal form. +The pattern is defined by a pointer to a string of code units and a length in +code units. If the pattern is zero-terminated, the length can be specified as +PCRE2_ZERO_TERMINATED. A NULL pattern pointer with a length of zero is treated +as an empty string (NULL with a non-zero length causes an error return). The +function returns a pointer to a block of memory that contains the compiled +pattern and related data, or NULL if an error occurred. +.P +If the compile context argument \fIccontext\fP is NULL, memory for the compiled +pattern is obtained by calling \fBmalloc()\fP. Otherwise, it is obtained from +the same memory function that was used for the compile context. The caller must +free the memory by calling \fBpcre2_code_free()\fP when it is no longer needed. +If \fBpcre2_code_free()\fP is called with a NULL argument, it returns +immediately, without doing anything. +.P +The function \fBpcre2_code_copy()\fP makes a copy of the compiled code in new +memory, using the same memory allocator as was used for the original. However, +if the code has been processed by the JIT compiler (see +.\" HTML +.\" +below), +.\" +the JIT information cannot be copied (because it is position-dependent). +The new copy can initially be used only for non-JIT matching, though it can be +passed to \fBpcre2_jit_compile()\fP if required. If \fBpcre2_code_copy()\fP is +called with a NULL argument, it returns NULL. +.P +The \fBpcre2_code_copy()\fP function provides a way for individual threads in a +multithreaded application to acquire a private copy of shared compiled code. +However, it does not make a copy of the character tables used by the compiled +pattern; the new pattern code points to the same tables as the original code. +(See +.\" HTML +.\" +"Locale Support" +.\" +below for details of these character tables.) In many applications the same +tables are used throughout, so this behaviour is appropriate. Nevertheless, +there are occasions when a copy of a compiled pattern and the relevant tables +are needed. The \fBpcre2_code_copy_with_tables()\fP provides this facility. +Copies of both the code and the tables are made, with the new code pointing to +the new tables. The memory for the new tables is automatically freed when +\fBpcre2_code_free()\fP is called for the new copy of the compiled code. If +\fBpcre2_code_copy_with_tables()\fP is called with a NULL argument, it returns +NULL. +.P +NOTE: When one of the matching functions is called, pointers to the compiled +pattern and the subject string are set in the match data block so that they can +be referenced by the substring extraction functions after a successful match. +After running a match, you must not free a compiled pattern or a subject string +until after all operations on the +.\" HTML +.\" +match data block +.\" +have taken place, unless, in the case of the subject string, you have used the +PCRE2_COPY_MATCHED_SUBJECT option, which is described in the section entitled +"Option bits for \fBpcre2_match()\fP" +.\" HTML +.\" +below. +.\" +.P +The \fIoptions\fP argument for \fBpcre2_compile()\fP contains various bit +settings that affect the compilation. It should be zero if none of them are +required. The available options are described below. Some of them (in +particular, those that are compatible with Perl, but some others as well) can +also be set and unset from within the pattern (see the detailed description in +the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation). +.P +For those options that can be different in different parts of the pattern, the +contents of the \fIoptions\fP argument specifies their settings at the start of +compilation. The PCRE2_ANCHORED, PCRE2_ENDANCHORED, and PCRE2_NO_UTF_CHECK +options can be set at the time of matching as well as at compile time. +.P +Some additional options and less frequently required compile-time parameters +(for example, the newline setting) can be provided in a compile context (as +described +.\" HTML +.\" +above). +.\" +.P +If \fIerrorcode\fP or \fIerroroffset\fP is NULL, \fBpcre2_compile()\fP returns +NULL immediately. Otherwise, the variables to which these point are set to an +error code and an offset (number of code units) within the pattern, +respectively, when \fBpcre2_compile()\fP returns NULL because a compilation +error has occurred. +.P +There are over 100 positive error codes that \fBpcre2_compile()\fP may return +if it finds an error in the pattern. There are also some negative error codes +that are used for invalid UTF strings when validity checking is in force. These +are the same as given by \fBpcre2_match()\fP and \fBpcre2_dfa_match()\fP, and +are described in the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. There is no separate documentation for the positive error codes, +because the textual error messages that are obtained by calling the +\fBpcre2_get_error_message()\fP function (see "Obtaining a textual error +message" +.\" HTML +.\" +below) +.\" +should be self-explanatory. Macro names starting with PCRE2_ERROR_ are defined +for both positive and negative error codes in \fBpcre2.h\fP. When compilation +is successful \fIerrorcode\fP is set to a value that returns the message "no +error" if passed to \fBpcre2_get_error_message()\fP. +.P +The value returned in \fIerroroffset\fP is an indication of where in the +pattern an error occurred. When there is no error, zero is returned. A non-zero +value is not necessarily the furthest point in the pattern that was read. For +example, after the error "lookbehind assertion is not fixed length", the error +offset points to the start of the failing assertion. For an invalid UTF-8 or +UTF-16 string, the offset is that of the first code unit of the failing +character. +.P +Some errors are not detected until the whole pattern has been scanned; in these +cases, the offset passed back is the length of the pattern. Note that the +offset is in code units, not characters, even in a UTF mode. It may sometimes +point into the middle of a UTF-8 or UTF-16 character. +.P +This code fragment shows a typical straightforward call to +\fBpcre2_compile()\fP: +.sp + pcre2_code *re; + PCRE2_SIZE erroffset; + int errorcode; + re = pcre2_compile( + "^A.*Z", /* the pattern */ + PCRE2_ZERO_TERMINATED, /* the pattern is zero-terminated */ + 0, /* default options */ + &errorcode, /* for error code */ + &erroffset, /* for error offset */ + NULL); /* no compile context */ +.sp +. +. +.SS "Main compile options" +.rs +.sp +The following names for option bits are defined in the \fBpcre2.h\fP header +file: +.sp + PCRE2_ANCHORED +.sp +If this bit is set, the pattern is forced to be "anchored", that is, it is +constrained to match only at the first matching point in the string that is +being searched (the "subject string"). This effect can also be achieved by +appropriate constructs in the pattern itself, which is the only way to do it in +Perl. +.sp + PCRE2_ALLOW_EMPTY_CLASS +.sp +By default, for compatibility with Perl, a closing square bracket that +immediately follows an opening one is treated as a data character for the +class. When PCRE2_ALLOW_EMPTY_CLASS is set, it terminates the class, which +therefore contains no characters and so can never match. +.sp + PCRE2_ALT_BSUX +.sp +This option request alternative handling of three escape sequences, which +makes PCRE2's behaviour more like ECMAscript (aka JavaScript). When it is set: +.P +(1) \eU matches an upper case "U" character; by default \eU causes a compile +time error (Perl uses \eU to upper case subsequent characters). +.P +(2) \eu matches a lower case "u" character unless it is followed by four +hexadecimal digits, in which case the hexadecimal number defines the code point +to match. By default, \eu causes a compile time error (Perl uses it to upper +case the following character). +.P +(3) \ex matches a lower case "x" character unless it is followed by two +hexadecimal digits, in which case the hexadecimal number defines the code point +to match. By default, as in Perl, a hexadecimal number is always expected after +\ex, but it may have zero, one, or two digits (so, for example, \exz matches a +binary zero character followed by z). +.P +ECMAscript 6 added additional functionality to \eu. This can be accessed using +the PCRE2_EXTRA_ALT_BSUX extra option (see "Extra compile options" +.\" HTML +.\" +below). +.\" +Note that this alternative escape handling applies only to patterns. Neither of +these options affects the processing of replacement strings passed to +\fBpcre2_substitute()\fP. +.sp + PCRE2_ALT_CIRCUMFLEX +.sp +In multiline mode (when PCRE2_MULTILINE is set), the circumflex metacharacter +matches at the start of the subject (unless PCRE2_NOTBOL is set), and also +after any internal newline. However, it does not match after a newline at the +end of the subject, for compatibility with Perl. If you want a multiline +circumflex also to match after a terminating newline, you must set +PCRE2_ALT_CIRCUMFLEX. +.sp + PCRE2_ALT_EXTENDED_CLASS +.sp +Alters the parsing of character classes to follow the extended syntax +described by Unicode UTS#18. The PCRE2_ALT_EXTENDED_CLASS option has no impact +on the behaviour of the Perl-specific "(?[...])" syntax for extended classes, +but instead enables the alternative syntax of extended class behaviour inside +ordinary "[...]" character classes. See the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation for details of the character classes supported. +.sp + PCRE2_ALT_VERBNAMES +.sp +By default, for compatibility with Perl, the name in any verb sequence such as +(*MARK:NAME) is any sequence of characters that does not include a closing +parenthesis. The name is not processed in any way, and it is not possible to +include a closing parenthesis in the name. However, if the PCRE2_ALT_VERBNAMES +option is set, normal backslash processing is applied to verb names and only an +unescaped closing parenthesis terminates the name. A closing parenthesis can be +included in a name either as \e) or between \eQ and \eE. If the PCRE2_EXTENDED +or PCRE2_EXTENDED_MORE option is set with PCRE2_ALT_VERBNAMES, unescaped +whitespace in verb names is skipped and #-comments are recognized, exactly as +in the rest of the pattern. +.sp + PCRE2_AUTO_CALLOUT +.sp +If this bit is set, \fBpcre2_compile()\fP automatically inserts callout items, +all with number 255, before each pattern item, except immediately before or +after an explicit callout in the pattern. For discussion of the callout +facility, see the +.\" HREF +\fBpcre2callout\fP +.\" +documentation. +.sp + PCRE2_CASELESS +.sp +If this bit is set, letters in the pattern match both upper and lower case +letters in the subject. It is equivalent to Perl's /i option, and it can be +changed within a pattern by a (?i) option setting. If either PCRE2_UTF or +PCRE2_UCP is set, Unicode properties are used for all characters with more than +one other case, and for all characters whose code points are greater than +U+007F. +.P +Note that there are two ASCII characters, K and S, that, in addition to +their lower case ASCII equivalents, are case-equivalent with U+212A (Kelvin +sign) and U+017F (long S) respectively. If you do not want this case +equivalence, you can suppress it by setting PCRE2_EXTRA_CASELESS_RESTRICT. +.P +One language family, Turkish and Azeri, has its own case-insensitivity rules, +which can be selected by setting PCRE2_EXTRA_TURKISH_CASING. This alters the +behaviour of the 'i', 'I', U+0130 (capital I with dot above), and U+0131 +(small dotless i) characters. +.P +For lower valued characters with only one other case, a lookup table is used +for speed. When neither PCRE2_UTF nor PCRE2_UCP is set, a lookup table is used +for all code points less than 256, and higher code points (available only in +16-bit or 32-bit mode) are treated as not having another case. +.P +From release 10.45 PCRE2_CASELESS also affects what some of the letter-related +Unicode property escapes (\ep and \eP) match. The properties Lu (upper case +letter), Ll (lower case letter), and Lt (title case letter) are all treated as +LC (cased letter) when PCRE2_CASELESS is set. +.sp + PCRE2_DOLLAR_ENDONLY +.sp +If this bit is set, a dollar metacharacter in the pattern matches only at the +end of the subject string. Without this option, a dollar also matches +immediately before a newline at the end of the string (but not before any other +newlines). The PCRE2_DOLLAR_ENDONLY option is ignored if PCRE2_MULTILINE is +set. There is no equivalent to this option in Perl, and no way to set it within +a pattern. +.sp + PCRE2_DOTALL +.sp +If this bit is set, a dot metacharacter in the pattern matches any character, +including one that indicates a newline. However, it only ever matches one +character, even if newlines are coded as CRLF. Without this option, a dot does +not match when the current position in the subject is at a newline. This option +is equivalent to Perl's /s option, and it can be changed within a pattern by a +(?s) option setting. A negative class such as [^a] always matches newline +characters, and the \eN escape sequence always matches a non-newline character, +independent of the setting of PCRE2_DOTALL. +.sp + PCRE2_DUPNAMES +.sp +If this bit is set, names used to identify capture groups need not be unique. +This can be helpful for certain types of pattern when it is known that only one +instance of the named group can ever be matched. There are more details of +named capture groups below; see also the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. +.sp + PCRE2_ENDANCHORED +.sp +If this bit is set, the end of any pattern match must be right at the end of +the string being searched (the "subject string"). If the pattern match +succeeds by reaching (*ACCEPT), but does not reach the end of the subject, the +match fails at the current starting point. For unanchored patterns, a new match +is then tried at the next starting point. However, if the match succeeds by +reaching the end of the pattern, but not the end of the subject, backtracking +occurs and an alternative match may be found. Consider these two patterns: +.sp + .(*ACCEPT)|.. + .|.. +.sp +If matched against "abc" with PCRE2_ENDANCHORED set, the first matches "c" +whereas the second matches "bc". The effect of PCRE2_ENDANCHORED can also be +achieved by appropriate constructs in the pattern itself, which is the only way +to do it in Perl. +.P +For DFA matching with \fBpcre2_dfa_match()\fP, PCRE2_ENDANCHORED applies only +to the first (that is, the longest) matched string. Other parallel matches, +which are necessarily substrings of the first one, must obviously end before +the end of the subject. +.sp + PCRE2_EXTENDED +.sp +If this bit is set, most white space characters in the pattern are totally +ignored except when escaped, inside a character class, or inside a \eQ...\eE +sequence. However, white space is not allowed within sequences such as (?> that +introduce various parenthesized groups, nor within numerical quantifiers such +as {1,3}. Ignorable white space is permitted between an item and a following +quantifier and between a quantifier and a following + that indicates +possessiveness. PCRE2_EXTENDED is equivalent to Perl's /x option, and it can be +changed within a pattern by a (?x) option setting. +.P +When PCRE2 is compiled without Unicode support, PCRE2_EXTENDED recognizes as +white space only those characters with code points less than 256 that are +flagged as white space in its low-character table. The table is normally +created by +.\" HREF +\fBpcre2_maketables()\fP, +.\" +which uses the \fBisspace()\fP function to identify space characters. In most +ASCII environments, the relevant characters are those with code points 0x0009 +(tab), 0x000A (linefeed), 0x000B (vertical tab), 0x000C (formfeed), 0x000D +(carriage return), and 0x0020 (space). +.P +When PCRE2 is compiled with Unicode support, in addition to these characters, +five more Unicode "Pattern White Space" characters are recognized by +PCRE2_EXTENDED. These are U+0085 (next line), U+200E (left-to-right mark), +U+200F (right-to-left mark), U+2028 (line separator), and U+2029 (paragraph +separator). This set of characters is the same as recognized by Perl's /x +option. Note that the horizontal and vertical space characters that are matched +by the \eh and \ev escapes in patterns are a much bigger set. +.P +As well as ignoring most white space, PCRE2_EXTENDED also causes characters +between an unescaped # outside a character class and the next newline, +inclusive, to be ignored, which makes it possible to include comments inside +complicated patterns. Note that the end of this type of comment is a literal +newline sequence in the pattern; escape sequences that happen to represent a +newline do not count. +.P +Which characters are interpreted as newlines can be specified by a setting in +the compile context that is passed to \fBpcre2_compile()\fP or by a special +sequence at the start of the pattern, as described in the section entitled +.\" HTML +.\" +"Newline conventions" +.\" +in the \fBpcre2pattern\fP documentation. A default is defined when PCRE2 is +built. +.sp + PCRE2_EXTENDED_MORE +.sp +This option has the effect of PCRE2_EXTENDED, but, in addition, unescaped space +and horizontal tab characters are ignored inside a character class. Note: only +these two characters are ignored, not the full set of pattern white space +characters that are ignored outside a character class. PCRE2_EXTENDED_MORE is +equivalent to Perl's /xx option, and it can be changed within a pattern by a +(?xx) option setting. +.sp + PCRE2_FIRSTLINE +.sp +If this option is set, the start of an unanchored pattern match must be before +or at the first newline in the subject string following the start of matching, +though the matched text may continue over the newline. If \fIstartoffset\fP is +non-zero, the limiting newline is not necessarily the first newline in the +subject. For example, if the subject string is "abc\enxyz" (where \en +represents a single-character newline) a pattern match for "yz" succeeds with +PCRE2_FIRSTLINE if \fIstartoffset\fP is greater than 3. See also +PCRE2_USE_OFFSET_LIMIT, which provides a more general limiting facility. If +PCRE2_FIRSTLINE is set with an offset limit, a match must occur in the first +line and also within the offset limit. In other words, whichever limit comes +first is used. This option has no effect for anchored patterns. +.sp + PCRE2_LITERAL +.sp +If this option is set, all meta-characters in the pattern are disabled, and it +is treated as a literal string. Matching literal strings with a regular +expression engine is not the most efficient way of doing it. If you are doing a +lot of literal matching and are worried about efficiency, you should consider +using other approaches. The only other main options that are allowed with +PCRE2_LITERAL are: PCRE2_ANCHORED, PCRE2_ENDANCHORED, PCRE2_AUTO_CALLOUT, +PCRE2_CASELESS, PCRE2_FIRSTLINE, PCRE2_MATCH_INVALID_UTF, +PCRE2_NO_START_OPTIMIZE, PCRE2_NO_UTF_CHECK, PCRE2_UTF, and +PCRE2_USE_OFFSET_LIMIT. The extra options PCRE2_EXTRA_MATCH_LINE and +PCRE2_EXTRA_MATCH_WORD are also supported. Any other options cause an error. +.sp + PCRE2_MATCH_INVALID_UTF +.sp +This option forces PCRE2_UTF (see below) and also enables support for matching +by \fBpcre2_match()\fP in subject strings that contain invalid UTF sequences. +Note, however, that the 16-bit and 32-bit PCRE2 libraries process strings as +sequences of uint16_t or uint32_t code points. They cannot find valid UTF +sequences within an arbitrary string of bytes unless such sequences are +suitably aligned. This facility is not supported for DFA matching. For details, +see the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. +.sp + PCRE2_MATCH_UNSET_BACKREF +.sp +If this option is set, a backreference to an unset capture group matches an +empty string (by default this causes the current matching alternative to fail). +A pattern such as (\e1)(a) succeeds when this option is set (assuming it can +find an "a" in the subject), whereas it fails by default, for Perl +compatibility. Setting this option makes PCRE2 behave more like ECMAscript (aka +JavaScript). +.sp + PCRE2_MULTILINE +.sp +By default, for the purposes of matching "start of line" and "end of line", +PCRE2 treats the subject string as consisting of a single line of characters, +even if it actually contains newlines. The "start of line" metacharacter (^) +matches only at the start of the string, and the "end of line" metacharacter +($) matches only at the end of the string, or before a terminating newline +(except when PCRE2_DOLLAR_ENDONLY is set). Note, however, that unless +PCRE2_DOTALL is set, the "any character" metacharacter (.) does not match at a +newline. This behaviour (for ^, $, and dot) is the same as Perl. +.P +When PCRE2_MULTILINE it is set, the "start of line" and "end of line" +constructs match immediately following or immediately before internal newlines +in the subject string, respectively, as well as at the very start and end. This +is equivalent to Perl's /m option, and it can be changed within a pattern by a +(?m) option setting. Note that the "start of line" metacharacter does not match +after a newline at the end of the subject, for compatibility with Perl. +However, you can change this by setting the PCRE2_ALT_CIRCUMFLEX option. If +there are no newlines in a subject string, or no occurrences of ^ or $ in a +pattern, setting PCRE2_MULTILINE has no effect. +.sp + PCRE2_NEVER_BACKSLASH_C +.sp +This option locks out the use of \eC in the pattern that is being compiled. +This escape can cause unpredictable behaviour in UTF-8 or UTF-16 modes, because +it may leave the current matching point in the middle of a multi-code-unit +character. This option may be useful in applications that process patterns from +external sources. Note that there is also a build-time option that permanently +locks out the use of \eC. +.sp + PCRE2_NEVER_UCP +.sp +This option locks out the use of Unicode properties for handling \eB, \eb, \eD, +\ed, \eS, \es, \eW, \ew, and some of the POSIX character classes, as described +for the PCRE2_UCP option below. In particular, it prevents the creator of the +pattern from enabling this facility by starting the pattern with (*UCP). This +option may be useful in applications that process patterns from external +sources. The option combination PCRE2_UCP and PCRE2_NEVER_UCP causes an error. +.sp + PCRE2_NEVER_UTF +.sp +This option locks out interpretation of the pattern as UTF-8, UTF-16, or +UTF-32, depending on which library is in use. In particular, it prevents the +creator of the pattern from switching to UTF interpretation by starting the +pattern with (*UTF). This option may be useful in applications that process +patterns from external sources. The combination of PCRE2_UTF and +PCRE2_NEVER_UTF causes an error. +.sp + PCRE2_NO_AUTO_CAPTURE +.sp +If this option is set, it disables the use of numbered capturing parentheses in +the pattern. Any opening parenthesis that is not followed by ? behaves as if it +were followed by ?: but named parentheses can still be used for capturing (and +they acquire numbers in the usual way). This is the same as Perl's /n option. +Note that, when this option is set, references to capture groups +(backreferences or recursion/subroutine calls) may only refer to named groups, +though the reference can be by name or by number. +.sp + PCRE2_NO_AUTO_POSSESS +.sp +If this (deprecated) option is set, it disables "auto-possessification", which +is an optimization that, for example, turns a+b into a++b in order to avoid +backtracks into a+ that can never be successful. However, if callouts are in +use, auto-possessification means that some callouts are never taken. You can +set this option if you want the matching functions to do a full unoptimized +search and run all the callouts, but it is mainly provided for testing +purposes. +.P +If a compile context is available, it is recommended to use +\fBpcre2_set_optimize()\fP with the \fIdirective\fP PCRE2_AUTO_POSSESS_OFF rather +than the compile option PCRE2_NO_AUTO_POSSESS. Note that PCRE2_NO_AUTO_POSSESS +takes precedence over the \fBpcre2_set_optimize()\fP optimization directives +PCRE2_AUTO_POSSESS and PCRE2_AUTO_POSSESS_OFF. +.sp + PCRE2_NO_DOTSTAR_ANCHOR +.sp +If this (deprecated) option is set, it disables an optimization that is applied +when .* is the first significant item in a top-level branch of a pattern, and +all the other branches also start with .* or with \eA or \eG or ^. The +optimization is automatically disabled for .* if it is inside an atomic group +or a capture group that is the subject of a backreference, or if the pattern +contains (*PRUNE) or (*SKIP). When the optimization is not disabled, such a +pattern is automatically anchored if PCRE2_DOTALL is set for all the .* items +and PCRE2_MULTILINE is not set for any ^ items. Otherwise, the fact that any +match must start either at the start of the subject or following a newline is +remembered. Like other optimizations, this can cause callouts to be skipped. +(If a compile context is available, it is recommended to use +\fBpcre2_set_optimize()\fP with the \fIdirective\fP PCRE2_DOTSTAR_ANCHOR_OFF +instead.) +.sp + PCRE2_NO_START_OPTIMIZE +.sp +This is an option whose main effect is at matching time. It does not change +what \fBpcre2_compile()\fP generates, but it does affect the output of the JIT +compiler. Setting this option is equivalent to calling \fBpcre2_set_optimize()\fP +with the \fIdirective\fP parameter set to PCRE2_START_OPTIMIZE_OFF. +.P +There are a number of optimizations that may occur at the start of a match, in +order to speed up the process. For example, if it is known that an unanchored +match must start with a specific code unit value, the matching code searches +the subject for that value, and fails immediately if it cannot find it, without +actually running the main matching function. The start-up optimizations are +in effect a pre-scan of the subject that takes place before the pattern is run. +.P +Disabling the start-up optimizations may cause performance to suffer. However, +this may be desirable for patterns which contain callouts or items such as +(*COMMIT) and (*MARK). See the above description of PCRE2_START_OPTIMIZE_OFF +for further details. +.sp + PCRE2_NO_UTF_CHECK +.sp +When PCRE2_UTF is set, the validity of the pattern as a UTF string is +automatically checked. There are discussions about the validity of +.\" HTML +.\" +UTF-8 strings, +.\" +.\" HTML +.\" +UTF-16 strings, +.\" +and +.\" HTML +.\" +UTF-32 strings +.\" +in the +.\" HREF +\fBpcre2unicode\fP +.\" +document. If an invalid UTF sequence is found, \fBpcre2_compile()\fP returns a +negative error code. +.P +If you know that your pattern is a valid UTF string, and you want to skip this +check for performance reasons, you can set the PCRE2_NO_UTF_CHECK option. When +it is set, the effect of passing an invalid UTF string as a pattern is +undefined. It may cause your program to crash or loop. +.P +Note that this option can also be passed to \fBpcre2_match()\fP and +\fBpcre2_dfa_match()\fP, to suppress UTF validity checking of the subject +string. +.P +Note also that setting PCRE2_NO_UTF_CHECK at compile time does not disable the +error that is given if an escape sequence for an invalid Unicode code point is +encountered in the pattern. In particular, the so-called "surrogate" code +points (0xd800 to 0xdfff) are invalid. If you want to allow escape sequences +such as \ex{d800} you can set the PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES extra +option, as described in the section entitled "Extra compile options" +.\" HTML +.\" +below. +.\" +However, this is possible only in UTF-8 and UTF-32 modes, because these values +are not representable in UTF-16. +.sp + PCRE2_UCP +.sp +This option has two effects. Firstly, it change the way PCRE2 processes \eB, +\eb, \eD, \ed, \eS, \es, \eW, \ew, and some of the POSIX character classes. By +default, only ASCII characters are recognized, but if PCRE2_UCP is set, Unicode +properties are used to classify characters. There are some PCRE2_EXTRA +options (see below) that add finer control to this behaviour. More details are +given in the section on +.\" HTML +.\" +generic character types +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +page. +.P +The second effect of PCRE2_UCP is to force the use of Unicode properties for +upper/lower casing operations, even when PCRE2_UTF is not set. This makes it +possible to process strings in the 16-bit UCS-2 code. This option is available +only if PCRE2 has been compiled with Unicode support (which is the default). +.P +The PCRE2_EXTRA_CASELESS_RESTRICT option (see above) restricts caseless +matching such that ASCII characters match only ASCII characters and non-ASCII +characters match only non-ASCII characters. The PCRE2_EXTRA_TURKISH_CASING option +(see above) alters the matching of the 'i' characters to follow their behaviour +in Turkish and Azeri languages. For further details on +PCRE2_EXTRA_CASELESS_RESTRICT and PCRE2_EXTRA_TURKISH_CASING, see the +.\" HREF +\fBpcre2unicode\fP +.\" +page. +.sp + PCRE2_UNGREEDY +.sp +This option inverts the "greediness" of the quantifiers so that they are not +greedy by default, but become greedy if followed by "?". It is not compatible +with Perl. It can also be set by a (?U) option setting within the pattern. +.sp + PCRE2_USE_OFFSET_LIMIT +.sp +This option must be set for \fBpcre2_compile()\fP if +\fBpcre2_set_offset_limit()\fP is going to be used to set a non-default offset +limit in a match context for matches that use this pattern. An error is +generated if an offset limit is set without this option. For more details, see +the description of \fBpcre2_set_offset_limit()\fP in the +.\" HTML +.\" +section +.\" +that describes match contexts. See also the PCRE2_FIRSTLINE +option above. +.sp + PCRE2_UTF +.sp +This option causes PCRE2 to regard both the pattern and the subject strings +that are subsequently processed as strings of UTF characters instead of +single-code-unit strings. It is available when PCRE2 is built to include +Unicode support (which is the default). If Unicode support is not available, +the use of this option provokes an error. Details of how PCRE2_UTF changes the +behaviour of PCRE2 are given in the +.\" HREF +\fBpcre2unicode\fP +.\" +page. In particular, note that it changes the way PCRE2_CASELESS works. +. +. +.\" HTML +.SS "Extra compile options" +.rs +.sp +The option bits that can be set in a compile context by calling the +\fBpcre2_set_compile_extra_options()\fP function are as follows: +.sp + PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK +.sp +Since release 10.38 PCRE2 has forbidden the use of \eK within lookaround +assertions, following Perl's lead. This option is provided to re-enable the +previous behaviour (act in positive lookarounds, ignore in negative ones) in +case anybody is relying on it. +.sp + PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES +.sp +This option applies when compiling a pattern in UTF-8 or UTF-32 mode. It is +forbidden in UTF-16 mode, and ignored in non-UTF modes. Unicode "surrogate" +code points in the range 0xd800 to 0xdfff are used in pairs in UTF-16 to encode +code points with values in the range 0x10000 to 0x10ffff. The surrogates cannot +therefore be represented in UTF-16. They can be represented in UTF-8 and +UTF-32, but are defined as invalid code points, and cause errors if encountered +in a UTF-8 or UTF-32 string that is being checked for validity by PCRE2. +.P +These values also cause errors if encountered in escape sequences such as +\ex{d912} within a pattern. However, it seems that some applications, when +using PCRE2 to check for unwanted characters in UTF-8 strings, explicitly test +for the surrogates using escape sequences. The PCRE2_NO_UTF_CHECK option does +not disable the error that occurs, because it applies only to the testing of +input strings for UTF validity. +.P +If the extra option PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES is set, surrogate code +point values in UTF-8 and UTF-32 patterns no longer provoke errors and are +incorporated in the compiled pattern. However, they can only match subject +characters if the matching function is called with PCRE2_NO_UTF_CHECK set. +.sp + PCRE2_EXTRA_ALT_BSUX +.sp +The original option PCRE2_ALT_BSUX causes PCRE2 to process \eU, \eu, and \ex in +the way that ECMAscript (aka JavaScript) does. Additional functionality was +defined by ECMAscript 6; setting PCRE2_EXTRA_ALT_BSUX has the effect of +PCRE2_ALT_BSUX, but in addition it recognizes \eu{hhh..} as a hexadecimal +character code, where hhh.. is any number of hexadecimal digits. +.sp + PCRE2_EXTRA_ASCII_BSD +.sp +This option forces \ed to match only ASCII digits, even when PCRE2_UCP is set. +It can be changed within a pattern by means of the (?aD) option setting. +.sp + PCRE2_EXTRA_ASCII_BSS +.sp +This option forces \es to match only ASCII space characters, even when +PCRE2_UCP is set. It can be changed within a pattern by means of the (?aS) +option setting. +.sp + PCRE2_EXTRA_ASCII_BSW +.sp +This option forces \ew to match only ASCII word characters, even when PCRE2_UCP +is set. It can be changed within a pattern by means of the (?aW) option +setting. +.sp + PCRE2_EXTRA_ASCII_DIGIT +.sp +This option forces the POSIX character classes [:digit:] and [:xdigit:] to +match only ASCII digits, even when PCRE2_UCP is set. It can be changed within +a pattern by means of the (?aT) option setting. +.sp + PCRE2_EXTRA_ASCII_POSIX +.sp +This option forces all the POSIX character classes, including [:digit:] and +[:xdigit:], to match only ASCII characters, even when PCRE2_UCP is set. It can +be changed within a pattern by means of the (?aP) option setting, but note that +this also sets PCRE2_EXTRA_ASCII_DIGIT in order to ensure that (?-aP) unsets +all ASCII restrictions for POSIX classes. +.sp + PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL +.sp +This is a dangerous option. Use with care. By default, an unrecognized escape +such as \ej or a malformed one such as \ex{2z} causes a compile-time error when +detected by \fBpcre2_compile()\fP. Perl is somewhat inconsistent in handling +such items: for example, \ej is treated as a literal "j", and non-hexadecimal +digits in \ex{} are just ignored, though warnings are given in both cases if +Perl's warning switch is enabled. However, a malformed octal number after \eo{ +always causes an error in Perl. +.P +If the PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL extra option is passed to +\fBpcre2_compile()\fP, all unrecognized or malformed escape sequences are +treated as single-character escapes. For example, \ej is a literal "j" and +\ex{2z} is treated as the literal string "x{2z}". Setting this option means +that typos in patterns may go undetected and have unexpected results. Also note +that a sequence such as [\eN{] is interpreted as a malformed attempt at +[\eN{...}] and so is treated as [N{] whereas [\eN] gives an error because an +unqualified \eN is a valid escape sequence but is not supported in a character +class. To reiterate: this is a dangerous option. Use with great care. +.sp + PCRE2_EXTRA_CASELESS_RESTRICT +.sp +When either PCRE2_UCP or PCRE2_UTF is set, caseless matching follows Unicode +rules, which allow for more than two cases per character. There are two +case-equivalent character sets that contain both ASCII and non-ASCII +characters. The ASCII letter S is case-equivalent to U+017f (long S) and the +ASCII letter K is case-equivalent to U+212a (Kelvin sign). This option disables +recognition of case-equivalences that cross the ASCII/non-ASCII boundary. In a +caseless match, both characters must either be ASCII or non-ASCII. The option +can be changed within a pattern by the (*CASELESS_RESTRICT) or (?r) option +settings. +.sp + PCRE2_EXTRA_ESCAPED_CR_IS_LF +.sp +There are some legacy applications where the escape sequence \er in a pattern +is expected to match a newline. If this option is set, \er in a pattern is +converted to \en so that it matches a LF (linefeed) instead of a CR (carriage +return) character. The option does not affect a literal CR in the pattern, nor +does it affect CR specified as an explicit code point such as \ex{0D}. +.sp + PCRE2_EXTRA_MATCH_LINE +.sp +This option is provided for use by the \fB-x\fP option of \fBpcre2grep\fP. It +causes the pattern only to match complete lines. This is achieved by +automatically inserting the code for "^(?:" at the start of the compiled +pattern and ")$" at the end. Thus, when PCRE2_MULTILINE is set, the matched +line may be in the middle of the subject string. This option can be used with +PCRE2_LITERAL. +.sp + PCRE2_EXTRA_MATCH_WORD +.sp +This option is provided for use by the \fB-w\fP option of \fBpcre2grep\fP. It +causes the pattern only to match strings that have a word boundary at the start +and the end. This is achieved by automatically inserting the code for "\eb(?:" +at the start of the compiled pattern and ")\eb" at the end. The option may be +used with PCRE2_LITERAL. However, it is ignored if PCRE2_EXTRA_MATCH_LINE is +also set. +.sp + PCRE2_EXTRA_NO_BS0 +.sp +If this option is set (note that its final character is the digit 0) it locks +out the use of the sequence \e0 unless at least one more octal digit follows. +.sp + PCRE2_EXTRA_PYTHON_OCTAL +.sp +If this option is set, PCRE2 follows Python's rules for interpreting octal +escape sequences. The rules for handling sequences such as \e14, which could +be an octal number or a back reference are different. Details are given in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. +.sp + PCRE2_EXTRA_NEVER_CALLOUT +.sp +If this option is set, PCRE2 treats callouts in the pattern as a syntax error, +returning PCRE2_ERROR_CALLOUT_CALLER_DISABLED. This is useful if the application +knows that a callout will not be provided to \fBpcre2_match()\fP, so that +callouts in the pattern are not silently ignored. +.sp + PCRE2_EXTRA_TURKISH_CASING +.sp +This option alters case-equivalence of the 'i' letters to follow the +alphabet used by Turkish and Azeri languages. The option can be changed within +a pattern by the (*TURKISH_CASING) start-of-pattern setting. Either the UTF or +UCP options must be set. In the 8-bit library, UTF must be set. This option +cannot be combined with PCRE2_EXTRA_CASELESS_RESTRICT. +. +. +.\" HTML +.SH "JUST-IN-TIME (JIT) COMPILATION" +.rs +.sp +.nf +.B int pcre2_jit_compile(pcre2_code *\fIcode\fP, uint32_t \fIoptions\fP); +.sp +.B int pcre2_jit_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.sp +.B void pcre2_jit_free_unused_memory(pcre2_general_context *\fIgcontext\fP); +.sp +.B pcre2_jit_stack *pcre2_jit_stack_create(size_t \fIstartsize\fP, +.B " size_t \fImaxsize\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_jit_stack_assign(pcre2_match_context *\fImcontext\fP, +.B " pcre2_jit_callback \fIcallback_function\fP, void *\fIcallback_data\fP);" +.sp +.B void pcre2_jit_stack_free(pcre2_jit_stack *\fIjit_stack\fP); +.fi +.P +These functions provide support for JIT compilation, which, if the just-in-time +compiler is available, further processes a compiled pattern into machine code +that executes much faster than the \fBpcre2_match()\fP interpretive matching +function. Full details are given in the +.\" HREF +\fBpcre2jit\fP +.\" +documentation. +.P +JIT compilation is a heavyweight optimization. It can take some time for +patterns to be analyzed, and for one-off matches and simple patterns the +benefit of faster execution might be offset by a much slower compilation time. +Most (but not all) patterns can be optimized by the JIT compiler. +. +. +.\" HTML +.SH "LOCALE SUPPORT" +.rs +.sp +.nf +.B const uint8_t *pcre2_maketables(pcre2_general_context *\fIgcontext\fP); +.sp +.B void pcre2_maketables_free(pcre2_general_context *\fIgcontext\fP, +.B " const uint8_t *\fItables\fP);" +.fi +.P +PCRE2 handles caseless matching, and determines whether characters are letters, +digits, or whatever, by reference to a set of tables, indexed by character code +point. However, this applies only to characters whose code points are less than +256. By default, higher-valued code points never match escapes such as \ew or +\ed. +.P +When PCRE2 is built with Unicode support (the default), certain Unicode +character properties can be tested with \ep and \eP, or, alternatively, the +PCRE2_UCP option can be set when a pattern is compiled; this causes \ew and +friends to use Unicode property support instead of the built-in tables. +PCRE2_UCP also causes upper/lower casing operations on characters with code +points greater than 127 to use Unicode properties. These effects apply even +when PCRE2_UTF is not set. There are, however, some PCRE2_EXTRA options (see +above) that can be used to modify or suppress them. +.P +The use of locales with Unicode is discouraged. If you are handling characters +with code points greater than 127, you should either use Unicode support, or +use locales, but not try to mix the two. +.P +PCRE2 contains a built-in set of character tables that are used by default. +These are sufficient for many applications. Normally, the internal tables +recognize only ASCII characters. However, when PCRE2 is built, it is possible +to cause the internal tables to be rebuilt in the default "C" locale of the +local system, which may cause them to be different. +.P +The built-in tables can be overridden by tables supplied by the application +that calls PCRE2. These may be created in a different locale from the default. +As more and more applications change to using Unicode, the need for this locale +support is expected to die away. +.P +External tables are built by calling the \fBpcre2_maketables()\fP function, in +the relevant locale. The only argument to this function is a general context, +which can be used to pass a custom memory allocator. If the argument is NULL, +the system \fBmalloc()\fP is used. The result can be passed to +\fBpcre2_compile()\fP as often as necessary, by creating a compile context and +calling \fBpcre2_set_character_tables()\fP to set the tables pointer therein. +.P +For example, to build and use tables that are appropriate for the French locale +(where accented characters with values greater than 127 are treated as +letters), the following code could be used: +.sp + setlocale(LC_CTYPE, "fr_FR"); + tables = pcre2_maketables(NULL); + ccontext = pcre2_compile_context_create(NULL); + pcre2_set_character_tables(ccontext, tables); + re = pcre2_compile(..., ccontext); +.sp +The locale name "fr_FR" is used on Linux and other Unix-like systems; if you +are using Windows, the name for the French locale is "french". +.P +The pointer that is passed (via the compile context) to \fBpcre2_compile()\fP +is saved with the compiled pattern, and the same tables are used by the +matching functions. Thus, for any single pattern, compilation and matching both +happen in the same locale, but different patterns can be processed in different +locales. +.P +It is the caller's responsibility to ensure that the memory containing the +tables remains available while they are still in use. When they are no longer +needed, you can discard them using \fBpcre2_maketables_free()\fP, which should +pass as its first parameter the same global context that was used to create the +tables. +. +. +.SS "Saving locale tables" +.rs +.sp +The tables described above are just a sequence of binary bytes, which makes +them independent of hardware characteristics such as endianness or whether the +processor is 32-bit or 64-bit. A copy of the result of \fBpcre2_maketables()\fP +can therefore be saved in a file or elsewhere and re-used later, even in a +different program or on another computer. The size of the tables (number of +bytes) must be obtained by calling \fBpcre2_config()\fP with the +PCRE2_CONFIG_TABLES_LENGTH option because \fBpcre2_maketables()\fP does not +return this value. Note that the \fBpcre2_dftables\fP program, which is part of +the PCRE2 build system, can be used stand-alone to create a file that contains +a set of binary tables. See the +.\" HTML +.\" +\fBpcre2build\fP +.\" +documentation for details. +. +. +.\" HTML +.SH "INFORMATION ABOUT A COMPILED PATTERN" +.rs +.sp +.nf +.B int pcre2_pattern_info(const pcre2 *\fIcode\fP, uint32_t \fIwhat\fP, void *\fIwhere\fP); +.fi +.P +The \fBpcre2_pattern_info()\fP function returns general information about a +compiled pattern. For information about callouts, see the +.\" HTML +.\" +next section. +.\" +The first argument for \fBpcre2_pattern_info()\fP is a pointer to the compiled +pattern. The second argument specifies which piece of information is required, +and the third argument is a pointer to a variable to receive the data. If the +third argument is NULL, the first argument is ignored, and the function returns +the size in bytes of the variable that is required for the information +requested. Otherwise, the yield of the function is zero for success, or one of +the following negative numbers: +.sp + PCRE2_ERROR_NULL the argument \fIcode\fP was NULL + PCRE2_ERROR_BADMAGIC the "magic number" was not found + PCRE2_ERROR_BADOPTION the value of \fIwhat\fP was invalid + PCRE2_ERROR_UNSET the requested field is not set +.sp +The "magic number" is placed at the start of each compiled pattern as a simple +check against passing an arbitrary memory pointer. Here is a typical call of +\fBpcre2_pattern_info()\fP, to obtain the length of the compiled pattern: +.sp + int rc; + size_t length; + rc = pcre2_pattern_info( + re, /* result of pcre2_compile() */ + PCRE2_INFO_SIZE, /* what is required */ + &length); /* where to put the data */ +.sp +The possible values for the second argument are defined in \fBpcre2.h\fP, and +are as follows: +.sp + PCRE2_INFO_ALLOPTIONS + PCRE2_INFO_ARGOPTIONS + PCRE2_INFO_EXTRAOPTIONS +.sp +Return copies of the pattern's options. The third argument should point to a +\fBuint32_t\fP variable. PCRE2_INFO_ARGOPTIONS returns exactly the options that +were passed to \fBpcre2_compile()\fP, whereas PCRE2_INFO_ALLOPTIONS returns +the compile options as modified by any top-level (*XXX) option settings such as +(*UTF) at the start of the pattern itself. PCRE2_INFO_EXTRAOPTIONS returns the +extra options that were set in the compile context by calling the +pcre2_set_compile_extra_options() function. +.P +For example, if the pattern /(*UTF)abc/ is compiled with the PCRE2_EXTENDED +option, the result for PCRE2_INFO_ALLOPTIONS is PCRE2_EXTENDED and PCRE2_UTF. +Option settings such as (?i) that can change within a pattern do not affect the +result of PCRE2_INFO_ALLOPTIONS, even if they appear right at the start of the +pattern. (This was different in some earlier releases.) +.P +A pattern compiled without PCRE2_ANCHORED is automatically anchored by PCRE2 if +the first significant item in every top-level branch is one of the following: +.sp + ^ unless PCRE2_MULTILINE is set + \eA always + \eG always + .* sometimes - see below +.sp +When .* is the first significant item, anchoring is possible only when all the +following are true: +.sp + .* is not in an atomic group +.\" JOIN + .* is not in a capture group that is the subject + of a backreference + PCRE2_DOTALL is in force for .* + Neither (*PRUNE) nor (*SKIP) appears in the pattern + PCRE2_NO_DOTSTAR_ANCHOR is not set + Dotstar anchoring has not been disabled with PCRE2_DOTSTAR_ANCHOR_OFF +.sp +For patterns that are auto-anchored, the PCRE2_ANCHORED bit is set in the +options returned for PCRE2_INFO_ALLOPTIONS. +.sp + PCRE2_INFO_BACKREFMAX +.sp +Return the number of the highest backreference in the pattern. The third +argument should point to a \fBuint32_t\fP variable. Named capture groups +acquire numbers as well as names, and these count towards the highest +backreference. Backreferences such as \e4 or \eg{12} match the captured +characters of the given group, but in addition, the check that a capture +group is set in a conditional group such as (?(3)a|b) is also a backreference. +Zero is returned if there are no backreferences. +.sp + PCRE2_INFO_BSR +.sp +The output is a uint32_t integer whose value indicates what character sequences +the \eR escape sequence matches. A value of PCRE2_BSR_UNICODE means that \eR +matches any Unicode line ending sequence; a value of PCRE2_BSR_ANYCRLF means +that \eR matches only CR, LF, or CRLF. +.sp + PCRE2_INFO_CAPTURECOUNT +.sp +Return the highest capture group number in the pattern. In patterns where (?| +is not used, this is also the total number of capture groups. The third +argument should point to a \fBuint32_t\fP variable. +.sp + PCRE2_INFO_DEPTHLIMIT +.sp +If the pattern set a backtracking depth limit by including an item of the form +(*LIMIT_DEPTH=nnnn) at the start, the value is returned. The third argument +should point to a uint32_t integer. If no such value has been set, the call to +\fBpcre2_pattern_info()\fP returns the error PCRE2_ERROR_UNSET. Note that this +limit will only be used during matching if it is less than the limit set or +defaulted by the caller of the match function. +.sp + PCRE2_INFO_FIRSTBITMAP +.sp +In the absence of a single first code unit for a non-anchored pattern, +\fBpcre2_compile()\fP may construct a 256-bit table that defines a fixed set of +values for the first code unit in any match. For example, a pattern that starts +with [abc] results in a table with three bits set. When code unit values +greater than 255 are supported, the flag bit for 255 means "any code unit of +value 255 or above". If such a table was constructed, a pointer to it is +returned. Otherwise NULL is returned. The third argument should point to a +\fBconst uint8_t *\fP variable. +.sp + PCRE2_INFO_FIRSTCODETYPE +.sp +Return information about the first code unit of any matched string, for a +non-anchored pattern. The third argument should point to a \fBuint32_t\fP +variable. If there is a fixed first value, for example, the letter "c" from a +pattern such as (cat|cow|coyote), 1 is returned, and the value can be retrieved +using PCRE2_INFO_FIRSTCODEUNIT. If there is no fixed first value, but it is +known that a match can occur only at the start of the subject or following a +newline in the subject, 2 is returned. Otherwise, and for anchored patterns, 0 +is returned. +.sp + PCRE2_INFO_FIRSTCODEUNIT +.sp +Return the value of the first code unit of any matched string for a pattern +where PCRE2_INFO_FIRSTCODETYPE returns 1; otherwise return 0. The third +argument should point to a \fBuint32_t\fP variable. In the 8-bit library, the +value is always less than 256. In the 16-bit library the value can be up to +0xffff. In the 32-bit library in UTF-32 mode the value can be up to 0x10ffff, +and up to 0xffffffff when not using UTF-32 mode. +.sp + PCRE2_INFO_FRAMESIZE +.sp +Return the size (in bytes) of the data frames that are used to remember +backtracking positions when the pattern is processed by \fBpcre2_match()\fP +without the use of JIT. The third argument should point to a \fBsize_t\fP +variable. The frame size depends on the number of capturing parentheses in the +pattern. Each additional capture group adds two PCRE2_SIZE variables. +.sp + PCRE2_INFO_HASBACKSLASHC +.sp +Return 1 if the pattern contains any instances of \eC, otherwise 0. The third +argument should point to a \fBuint32_t\fP variable. +.sp + PCRE2_INFO_HASCRORLF +.sp +Return 1 if the pattern contains any explicit matches for CR or LF characters, +otherwise 0. The third argument should point to a \fBuint32_t\fP variable. An +explicit match is either a literal CR or LF character, or \er or \en or one of +the equivalent hexadecimal or octal escape sequences. +.sp + PCRE2_INFO_HEAPLIMIT +.sp +If the pattern set a heap memory limit by including an item of the form +(*LIMIT_HEAP=nnnn) at the start, the value is returned. The third argument +should point to a uint32_t integer. If no such value has been set, the call to +\fBpcre2_pattern_info()\fP returns the error PCRE2_ERROR_UNSET. Note that this +limit will only be used during matching if it is less than the limit set or +defaulted by the caller of the match function. +.sp + PCRE2_INFO_JCHANGED +.sp +Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise +0. The third argument should point to a \fBuint32_t\fP variable. (?J) and +(?-J) set and unset the local PCRE2_DUPNAMES option, respectively. +.sp + PCRE2_INFO_JITSIZE +.sp +If the compiled pattern was successfully processed by +\fBpcre2_jit_compile()\fP, return the size of the JIT compiled code, otherwise +return zero. The third argument should point to a \fBsize_t\fP variable. +.sp + PCRE2_INFO_LASTCODETYPE +.sp +Returns 1 if there is a rightmost literal code unit that must exist in any +matched string, other than at its start. The third argument should point to a +\fBuint32_t\fP variable. If there is no such value, 0 is returned. When 1 is +returned, the code unit value itself can be retrieved using +PCRE2_INFO_LASTCODEUNIT. For anchored patterns, a last literal value is +recorded only if it follows something of variable length. For example, for the +pattern /^a\ed+z\ed+/ the returned value is 1 (with "z" returned from +PCRE2_INFO_LASTCODEUNIT), but for /^a\edz\ed/ the returned value is 0. +.sp + PCRE2_INFO_LASTCODEUNIT +.sp +Return the value of the rightmost literal code unit that must exist in any +matched string, other than at its start, for a pattern where +PCRE2_INFO_LASTCODETYPE returns 1. Otherwise, return 0. The third argument +should point to a \fBuint32_t\fP variable. +.sp + PCRE2_INFO_MATCHEMPTY +.sp +Return 1 if the pattern might match an empty string, otherwise 0. The third +argument should point to a \fBuint32_t\fP variable. When a pattern contains +recursive subroutine calls it is not always possible to determine whether or +not it can match an empty string. PCRE2 takes a cautious approach and returns 1 +in such cases. +.sp + PCRE2_INFO_MATCHLIMIT +.sp +If the pattern set a match limit by including an item of the form +(*LIMIT_MATCH=nnnn) at the start, the value is returned. The third argument +should point to a uint32_t integer. If no such value has been set, the call to +\fBpcre2_pattern_info()\fP returns the error PCRE2_ERROR_UNSET. Note that this +limit will only be used during matching if it is less than the limit set or +defaulted by the caller of the match function. +.sp + PCRE2_INFO_MAXLOOKBEHIND +.sp +A lookbehind assertion moves back a certain number of characters (not code +units) when it starts to process each of its branches. This request returns the +largest of these backward moves. The third argument should point to a uint32_t +integer. The simple assertions \eb and \eB require a one-character lookbehind +and cause PCRE2_INFO_MAXLOOKBEHIND to return 1 in the absence of anything +longer. \eA also registers a one-character lookbehind, though it does not +actually inspect the previous character. +.P +Note that this information is useful for multi-segment matching only +if the pattern contains no nested lookbehinds. For example, the pattern +(?<=a(?<=ba)c) returns a maximum lookbehind of 2, but when it is processed, the +first lookbehind moves back by two characters, matches one character, then the +nested lookbehind also moves back by two characters. This puts the matching +point three characters earlier than it was at the start. +PCRE2_INFO_MAXLOOKBEHIND is really only useful as a debugging tool. See the +.\" HREF +\fBpcre2partial\fP +.\" +documentation for a discussion of multi-segment matching. +.sp + PCRE2_INFO_MINLENGTH +.sp +If a minimum length for matching subject strings was computed, its value is +returned. Otherwise the returned value is 0. This value is not computed when +PCRE2_NO_START_OPTIMIZE is set. The value is a number of characters, which in +UTF mode may be different from the number of code units. The third argument +should point to a \fBuint32_t\fP variable. The value is a lower bound to the +length of any matching string. There may not be any strings of that length that +do actually match, but every string that does match is at least that long. +.sp + PCRE2_INFO_NAMECOUNT + PCRE2_INFO_NAMEENTRYSIZE + PCRE2_INFO_NAMETABLE +.sp +PCRE2 supports the use of named as well as numbered capturing parentheses. The +names are just an additional way of identifying the parentheses, which still +acquire numbers. Several convenience functions such as +\fBpcre2_substring_get_byname()\fP are provided for extracting captured +substrings by name. It is also possible to extract the data directly, by first +converting the name to a number in order to access the correct pointers in the +output vector (described with \fBpcre2_match()\fP below). To do the conversion, +you need to use the name-to-number map, which is described by these three +values. +.P +The map consists of a number of fixed-size entries. PCRE2_INFO_NAMECOUNT gives +the number of entries, and PCRE2_INFO_NAMEENTRYSIZE gives the size of each +entry in code units; both of these return a \fBuint32_t\fP value. The entry +size depends on the length of the longest name. +.P +PCRE2_INFO_NAMETABLE returns a pointer to the first entry of the table. This is +a PCRE2_SPTR pointer to a block of code units. In the 8-bit library, the first +two bytes of each entry are the number of the capturing parenthesis, most +significant byte first. In the 16-bit library, the pointer points to 16-bit +code units, the first of which contains the parenthesis number. In the 32-bit +library, the pointer points to 32-bit code units, the first of which contains +the parenthesis number. The rest of the entry is the corresponding name, zero +terminated. +.P +The names are in alphabetical order. If (?| is used to create multiple capture +groups with the same number, as described in the +.\" HTML +.\" +section on duplicate group numbers +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +page, the groups may be given the same name, but there is only one entry in the +table. Different names for groups of the same number are not permitted. +.P +Duplicate names for capture groups with different numbers are permitted, but +only if PCRE2_DUPNAMES is set. They appear in the table in the order in which +they were found in the pattern. In the absence of (?| this is the order of +increasing number; when (?| is used this is not necessarily the case because +later capture groups may have lower numbers. +.P +As a simple example of the name/number table, consider the following pattern +after compilation by the 8-bit library (assume PCRE2_EXTENDED is set, so white +space - including newlines - is ignored): +.sp +.\" JOIN + (? (?(\ed\ed)?\ed\ed) - + (?\ed\ed) - (?\ed\ed) ) +.sp +There are four named capture groups, so the table has four entries, and each +entry in the table is eight bytes long. The table is as follows, with +non-printing bytes shows in hexadecimal, and undefined bytes shown as ??: +.sp + 00 01 d a t e 00 ?? + 00 05 d a y 00 ?? ?? + 00 04 m o n t h 00 + 00 02 y e a r 00 ?? +.sp +When writing code to extract data from named capture groups using the +name-to-number map, remember that the length of the entries is likely to be +different for each compiled pattern. +.sp + PCRE2_INFO_NEWLINE +.sp +The output is one of the following \fBuint32_t\fP values: +.sp + PCRE2_NEWLINE_CR Carriage return (CR) + PCRE2_NEWLINE_LF Linefeed (LF) + PCRE2_NEWLINE_CRLF Carriage return, linefeed (CRLF) + PCRE2_NEWLINE_ANY Any Unicode line ending + PCRE2_NEWLINE_ANYCRLF Any of CR, LF, or CRLF + PCRE2_NEWLINE_NUL The NUL character (binary zero) +.sp +This identifies the character sequence that will be recognized as meaning +"newline" while matching. +.sp + PCRE2_INFO_SIZE +.sp +Return the size of the compiled pattern in bytes (for all three libraries). The +third argument should point to a \fBsize_t\fP variable. This value includes the +size of the general data block that precedes the code units of the compiled +pattern itself. The value that is used when \fBpcre2_compile()\fP is getting +memory in which to place the compiled pattern may be slightly larger than the +value returned by this option, because there are cases where the code that +calculates the size has to over-estimate. Processing a pattern with the JIT +compiler does not alter the value returned by this option. +. +. +.\" HTML +.SH "INFORMATION ABOUT A PATTERN'S CALLOUTS" +.rs +.sp +.nf +.B int pcre2_callout_enumerate(const pcre2_code *\fIcode\fP, +.B " int (*\fIcallback\fP)(pcre2_callout_enumerate_block *, void *)," +.B " void *\fIuser_data\fP);" +.fi +.sp +A script language that supports the use of string arguments in callouts might +like to scan all the callouts in a pattern before running the match. This can +be done by calling \fBpcre2_callout_enumerate()\fP. The first argument is a +pointer to a compiled pattern, the second points to a callback function, and +the third is arbitrary user data. The callback function is called for every +callout in the pattern in the order in which they appear. Its first argument is +a pointer to a callout enumeration block, and its second argument is the +\fIuser_data\fP value that was passed to \fBpcre2_callout_enumerate()\fP. The +contents of the callout enumeration block are described in the +.\" HREF +\fBpcre2callout\fP +.\" +documentation, which also gives further details about callouts. +. +. +.SH "SERIALIZATION AND PRECOMPILING" +.rs +.sp +It is possible to save compiled patterns on disc or elsewhere, and reload them +later, subject to a number of restrictions. The host on which the patterns are +reloaded must be running the same version of PCRE2, with the same code unit +width, and must also have the same endianness, pointer width, and PCRE2_SIZE +type. Before compiled patterns can be saved, they must be converted to a +"serialized" form, which in the case of PCRE2 is really just a bytecode dump. +The functions whose names begin with \fBpcre2_serialize_\fP are used for +converting to and from the serialized form. They are described in the +.\" HREF +\fBpcre2serialize\fP +.\" +documentation. Note that PCRE2 serialization does not convert compiled patterns +to an abstract format like Java or .NET serialization. +. +. +.\" HTML +.SH "THE MATCH DATA BLOCK" +.rs +.sp +.nf +.B pcre2_match_data *pcre2_match_data_create(uint32_t \fIovecsize\fP, +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_match_data *pcre2_match_data_create_from_pattern( +.B " const pcre2_code *\fIcode\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_match_data_free(pcre2_match_data *\fImatch_data\fP); +.fi +.P +Information about a successful or unsuccessful match is placed in a match +data block, which is an opaque structure that is accessed by function calls. In +particular, the match data block contains a vector of offsets into the subject +string that define the matched parts of the subject. This is known as the +\fIovector\fP. +.P +Before calling \fBpcre2_match()\fP, \fBpcre2_dfa_match()\fP, or +\fBpcre2_jit_match()\fP you must create a match data block by calling one of +the creation functions above. For \fBpcre2_match_data_create()\fP, the first +argument is the number of pairs of offsets in the \fIovector\fP. +.P +When using \fBpcre2_match()\fP, one pair of offsets is required to identify the +string that matched the whole pattern, with an additional pair for each +captured substring. For example, a value of 4 creates enough space to record +the matched portion of the subject plus three captured substrings. +.P +When using \fBpcre2_dfa_match()\fP there may be multiple matched substrings of +different lengths at the same point in the subject. The ovector should be made +large enough to hold as many as are expected. +.P +A minimum of at least 1 pair is imposed by \fBpcre2_match_data_create()\fP, so +it is always possible to return the overall matched string in the case of +\fBpcre2_match()\fP or the longest match in the case of +\fBpcre2_dfa_match()\fP. The maximum number of pairs is 65535; if the first +argument of \fBpcre2_match_data_create()\fP is greater than this, 65535 is +used. +.P +The second argument of \fBpcre2_match_data_create()\fP is a pointer to a +general context, which can specify custom memory management for obtaining the +memory for the match data block. If you are not using custom memory management, +pass NULL, which causes \fBmalloc()\fP to be used. +.P +For \fBpcre2_match_data_create_from_pattern()\fP, the first argument is a +pointer to a compiled pattern. The ovector is created to be exactly the right +size to hold all the substrings a pattern might capture when matched using +\fBpcre2_match()\fP. You should not use this call when matching with +\fBpcre2_dfa_match()\fP. The second argument is again a pointer to a general +context, but in this case if NULL is passed, the memory is obtained using the +same allocator that was used for the compiled pattern (custom or default). +.P +A match data block can be used many times, with the same or different compiled +patterns. You can extract information from a match data block after a match +operation has finished, using functions that are described in the sections on +.\" HTML +.\" +matched strings +.\" +and +.\" HTML +.\" +other match data +.\" +below. +.P +When a call of \fBpcre2_match()\fP fails, valid data is available in the match +block only when the error is PCRE2_ERROR_NOMATCH, PCRE2_ERROR_PARTIAL, or one +of the error codes for an invalid UTF string. Exactly what is available depends +on the error, and is detailed below. +.P +When one of the matching functions is called, pointers to the compiled pattern +and the subject string are set in the match data block so that they can be +referenced by the extraction functions after a successful match. After running +a match, you must not free a compiled pattern or a subject string until after +all operations on the match data block (for that match) have taken place, +unless, in the case of the subject string, you have used the +PCRE2_COPY_MATCHED_SUBJECT option, which is described in the section entitled +"Option bits for \fBpcre2_match()\fP" +.\" HTML +.\" +below. +.\" +.P +When a match data block itself is no longer needed, it should be freed by +calling \fBpcre2_match_data_free()\fP. If this function is called with a NULL +argument, it returns immediately, without doing anything. +. +. +.SH "MEMORY USE FOR MATCH DATA BLOCKS" +.rs +.sp +.nf +.B PCRE2_SIZE pcre2_get_match_data_size(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE pcre2_get_match_data_heapframes_size( +.B " pcre2_match_data *\fImatch_data\fP);" +.fi +.P +The size of a match data block depends on the size of the ovector that it +contains. The function \fBpcre2_get_match_data_size()\fP returns the size, in +bytes, of the block that is its argument. +.P +When \fBpcre2_match()\fP runs interpretively (that is, without using JIT), it +makes use of a vector of data frames for remembering backtracking positions. +The size of each individual frame depends on the number of capturing +parentheses in the pattern and can be obtained by calling +\fBpcre2_pattern_info()\fP with the PCRE2_INFO_FRAMESIZE option (see the +section entitled "Information about a compiled pattern" +.\" HTML +.\" +above). +.\" +.P +Heap memory is used for the frames vector; if the initial memory block turns +out to be too small during matching, it is automatically expanded. When +\fBpcre2_match()\fP returns, the memory is not freed, but remains attached to +the match data block, for use by any subsequent matches that use the same +block. It is automatically freed when the match data block itself is freed. +.P +You can find the current size of the frames vector that a match data block owns +by calling \fBpcre2_get_match_data_heapframes_size()\fP. For a newly created +match data block the size will be zero. Some types of match may require a lot +of frames and thus a large vector; applications that run in environments where +memory is constrained can check this and free the match data block if the heap +frames vector has become too big. +. +. +.SH "MATCHING A PATTERN: THE TRADITIONAL FUNCTION" +.rs +.sp +.nf +.B int pcre2_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP);" +.fi +.P +The function \fBpcre2_match()\fP is called to match a subject string against a +compiled pattern, which is passed in the \fIcode\fP argument. You can call +\fBpcre2_match()\fP with the same \fIcode\fP argument as many times as you +like, in order to find multiple matches in the subject string or to match +different subject strings with the same pattern. +.P +This function is the main matching facility of the library, and it operates in +a Perl-like manner. For specialist use there is also an alternative matching +function, which is described +.\" HTML +.\" +below +.\" +in the section about the \fBpcre2_dfa_match()\fP function. +.P +Here is an example of a simple call to \fBpcre2_match()\fP: +.sp + pcre2_match_data *md = pcre2_match_data_create(4, NULL); + int rc = pcre2_match( + re, /* result of pcre2_compile() */ + "some string", /* the subject string */ + 11, /* the length of the subject string */ + 0, /* start at offset 0 in the subject */ + 0, /* default options */ + md, /* the match data block */ + NULL); /* a match context; NULL means use defaults */ +.sp +If the subject string is zero-terminated, the length can be given as +PCRE2_ZERO_TERMINATED. A match context must be provided if certain less common +matching parameters are to be changed. For details, see the section on +.\" HTML +.\" +the match context +.\" +above. +. +. +.SS "The string to be matched by \fBpcre2_match()\fP" +.rs +.sp +The subject string is passed to \fBpcre2_match()\fP as a pointer in +\fIsubject\fP, a length in \fIlength\fP, and a starting offset in +\fIstartoffset\fP. The length and offset are in code units, not characters. +That is, they are in bytes for the 8-bit library, 16-bit code units for the +16-bit library, and 32-bit code units for the 32-bit library, whether or not +UTF processing is enabled. As a special case, if \fIsubject\fP is NULL and +\fIlength\fP is zero, the subject is assumed to be an empty string. If +\fIlength\fP is non-zero, an error occurs if \fIsubject\fP is NULL. +.P +If \fIstartoffset\fP is greater than the length of the subject, +\fBpcre2_match()\fP returns PCRE2_ERROR_BADOFFSET. When the starting offset is +zero, the search for a match starts at the beginning of the subject, and this +is by far the most common case. In UTF-8 or UTF-16 mode, the starting offset +must point to the start of a character, or to the end of the subject (in UTF-32 +mode, one code unit equals one character, so all offsets are valid). Like the +pattern string, the subject may contain binary zeros. +.P +A non-zero starting offset is useful when searching for another match in the +same subject by calling \fBpcre2_match()\fP again after a previous success. +Setting \fIstartoffset\fP differs from passing over a shortened string and +setting PCRE2_NOTBOL in the case of a pattern that begins with any kind of +lookbehind. For example, consider the pattern +.sp + \eBiss\eB +.sp +which finds occurrences of "iss" in the middle of words. (\eB matches only if +the current position in the subject is not a word boundary.) When applied to +the string "Mississippi" the first call to \fBpcre2_match()\fP finds the first +occurrence. If \fBpcre2_match()\fP is called again with just the remainder of +the subject, namely "issippi", it does not match, because \eB is always false +at the start of the subject, which is deemed to be a word boundary. However, if +\fBpcre2_match()\fP is passed the entire string again, but with +\fIstartoffset\fP set to 4, it finds the second occurrence of "iss" because it +is able to look behind the starting point to discover that it is preceded by a +letter. +.P +Finding all the matches in a subject is tricky when the pattern can match an +empty string. It is possible to emulate Perl's /g behaviour by first trying the +match again at the same offset, with the PCRE2_NOTEMPTY_ATSTART and +PCRE2_ANCHORED options, and then if that fails, advancing the starting offset +and trying an ordinary match again. There is some code that demonstrates how to +do this in the +.\" HREF +\fBpcre2demo\fP +.\" +sample program. In the most general case, you have to check to see if the +newline convention recognizes CRLF as a newline, and if so, and the current +character is CR followed by LF, advance the starting offset by two characters +instead of one. +.P +If a non-zero starting offset is passed when the pattern is anchored, a single +attempt to match at the given offset is made. This can only succeed if the +pattern does not require the match to be at the start of the subject. In other +words, the anchoring must be the result of setting the PCRE2_ANCHORED option or +the use of .* with PCRE2_DOTALL, not by starting the pattern with ^ or \eA. +. +. +.\" HTML +.SS "Option bits for \fBpcre2_match()\fP" +.rs +.sp +The unused bits of the \fIoptions\fP argument for \fBpcre2_match()\fP must be +zero. The only bits that may be set are PCRE2_ANCHORED, +PCRE2_COPY_MATCHED_SUBJECT, PCRE2_DISABLE_RECURSELOOP_CHECK, PCRE2_ENDANCHORED, +PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, +PCRE2_NO_JIT, PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. +Their action is described below. +.P +Setting PCRE2_ANCHORED or PCRE2_ENDANCHORED at match time is not supported by +the just-in-time (JIT) compiler. If it is set, JIT matching is disabled and the +interpretive code in \fBpcre2_match()\fP is run. +PCRE2_DISABLE_RECURSELOOP_CHECK is ignored by JIT, but apart from PCRE2_NO_JIT +(obviously), the remaining options are supported for JIT matching. +.sp + PCRE2_ANCHORED +.sp +The PCRE2_ANCHORED option limits \fBpcre2_match()\fP to matching at the first +matching position. If a pattern was compiled with PCRE2_ANCHORED, or turned out +to be anchored by virtue of its contents, it cannot be made unachored at +matching time. Note that setting the option at match time disables JIT +matching. +.sp + PCRE2_COPY_MATCHED_SUBJECT +.sp +By default, a pointer to the subject is remembered in the match data block so +that, after a successful match, it can be referenced by the substring +extraction functions. This means that the subject's memory must not be freed +until all such operations are complete. For some applications where the +lifetime of the subject string is not guaranteed, it may be necessary to make a +copy of the subject string, but it is wasteful to do this unless the match is +successful. After a successful match, if PCRE2_COPY_MATCHED_SUBJECT is set, the +subject is copied and the new pointer is remembered in the match data block +instead of the original subject pointer. The memory allocator that was used for +the match block itself is used. The copy is automatically freed when +\fBpcre2_match_data_free()\fP is called to free the match data block. It is also +automatically freed if the match data block is re-used for another match +operation. +.sp + PCRE2_DISABLE_RECURSELOOP_CHECK +.sp +This option is relevant only to \fBpcre2_match()\fP for interpretive matching. +It is ignored when JIT is used, and is forbidden for \fBpcre2_dfa_match()\fP. +.P +The use of recursion in patterns can lead to infinite loops. In the +interpretive matcher these would be eventually caught by the match or heap +limits, but this could take a long time and/or use a lot of memory if the +limits are large. There is therefore a check at the start of each recursion. +If the same group is still active from a previous call, and the current subject +pointer is the same as it was at the start of that group, and the furthest +inspected character of the subject has not changed, an error is generated. +.P +There are rare cases of matches that would complete, but nevertheless trigger +this error. This option disables the check. It is provided mainly for testing +when comparing JIT and interpretive behaviour. +.sp + PCRE2_ENDANCHORED +.sp +If the PCRE2_ENDANCHORED option is set, any string that \fBpcre2_match()\fP +matches must be right at the end of the subject string. Note that setting the +option at match time disables JIT matching. +.sp + PCRE2_NOTBOL +.sp +This option specifies that first character of the subject string is not the +beginning of a line, so the circumflex metacharacter should not match before +it. Setting this without having set PCRE2_MULTILINE at compile time causes +circumflex never to match. This option affects only the behaviour of the +circumflex metacharacter. It does not affect \eA. +.sp + PCRE2_NOTEOL +.sp +This option specifies that the end of the subject string is not the end of a +line, so the dollar metacharacter should not match it nor (except in multiline +mode) a newline immediately before it. Setting this without having set +PCRE2_MULTILINE at compile time causes dollar never to match. This option +affects only the behaviour of the dollar metacharacter. It does not affect \eZ +or \ez. +.sp + PCRE2_NOTEMPTY +.sp +An empty string is not considered to be a valid match if this option is set. If +there are alternatives in the pattern, they are tried. If all the alternatives +match the empty string, the entire match fails. For example, if the pattern +.sp + a?b? +.sp +is applied to a string not beginning with "a" or "b", it matches an empty +string at the start of the subject. With PCRE2_NOTEMPTY set, this match is not +valid, so \fBpcre2_match()\fP searches further into the string for occurrences +of "a" or "b". +.sp + PCRE2_NOTEMPTY_ATSTART +.sp +This is like PCRE2_NOTEMPTY, except that it locks out an empty string match +only at the first matching position, that is, at the start of the subject plus +the starting offset. An empty string match later in the subject is permitted. +If the pattern is anchored, such a match can occur only if the pattern contains +\eK. +.sp + PCRE2_NO_JIT +.sp +By default, if a pattern has been successfully processed by +\fBpcre2_jit_compile()\fP, JIT is automatically used when \fBpcre2_match()\fP +is called with options that JIT supports. Setting PCRE2_NO_JIT disables the use +of JIT; it forces matching to be done by the interpreter. +.sp + PCRE2_NO_UTF_CHECK +.sp +When PCRE2_UTF is set at compile time, the validity of the subject as a UTF +string is checked unless PCRE2_NO_UTF_CHECK is passed to \fBpcre2_match()\fP or +PCRE2_MATCH_INVALID_UTF was passed to \fBpcre2_compile()\fP. The latter special +case is discussed in detail in the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. +.P +In the default case, if a non-zero starting offset is given, the check is +applied only to that part of the subject that could be inspected during +matching, and there is a check that the starting offset points to the first +code unit of a character or to the end of the subject. If there are no +lookbehind assertions in the pattern, the check starts at the starting offset. +Otherwise, it starts at the length of the longest lookbehind before the +starting offset, or at the start of the subject if there are not that many +characters before the starting offset. Note that the sequences \eb and \eB are +one-character lookbehinds. +.P +The check is carried out before any other processing takes place, and a +negative error code is returned if the check fails. There are several UTF error +codes for each code unit width, corresponding to different problems with the +code unit sequence. There are discussions about the validity of +.\" HTML +.\" +UTF-8 strings, +.\" +.\" HTML +.\" +UTF-16 strings, +.\" +and +.\" HTML +.\" +UTF-32 strings +.\" +in the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. +.P +If you know that your subject is valid, and you want to skip this check for +performance reasons, you can set the PCRE2_NO_UTF_CHECK option when calling +\fBpcre2_match()\fP. You might want to do this for the second and subsequent +calls to \fBpcre2_match()\fP if you are making repeated calls to find multiple +matches in the same subject string. +.P +\fBWarning:\fP Unless PCRE2_MATCH_INVALID_UTF was set at compile time, when +PCRE2_NO_UTF_CHECK is set at match time the effect of passing an invalid +string as a subject, or an invalid value of \fIstartoffset\fP, is undefined. +Your program may crash or loop indefinitely or give wrong results. +.sp + PCRE2_PARTIAL_HARD + PCRE2_PARTIAL_SOFT +.sp +These options turn on the partial matching feature. A partial match occurs if +the end of the subject string is reached successfully, but there are not enough +subject characters to complete the match. In addition, either at least one +character must have been inspected or the pattern must contain a lookbehind, or +the pattern must be one that could match an empty string. +.P +If this situation arises when PCRE2_PARTIAL_SOFT (but not PCRE2_PARTIAL_HARD) +is set, matching continues by testing any remaining alternatives. Only if no +complete match can be found is PCRE2_ERROR_PARTIAL returned instead of +PCRE2_ERROR_NOMATCH. In other words, PCRE2_PARTIAL_SOFT specifies that the +caller is prepared to handle a partial match, but only if no complete match can +be found. +.P +If PCRE2_PARTIAL_HARD is set, it overrides PCRE2_PARTIAL_SOFT. In this case, if +a partial match is found, \fBpcre2_match()\fP immediately returns +PCRE2_ERROR_PARTIAL, without considering any other alternatives. In other +words, when PCRE2_PARTIAL_HARD is set, a partial match is considered to be more +important that an alternative complete match. +.P +There is a more detailed discussion of partial and multi-segment matching, with +examples, in the +.\" HREF +\fBpcre2partial\fP +.\" +documentation. +. +. +. +.SH "NEWLINE HANDLING WHEN MATCHING" +.rs +.sp +When PCRE2 is built, a default newline convention is set; this is usually the +standard convention for the operating system. The default can be overridden in +a +.\" HTML +.\" +compile context +.\" +by calling \fBpcre2_set_newline()\fP. It can also be overridden by starting a +pattern string with, for example, (*CRLF), as described in the +.\" HTML +.\" +section on newline conventions +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +page. During matching, the newline choice affects the behaviour of the dot, +circumflex, and dollar metacharacters. It may also alter the way the match +starting position is advanced after a match failure for an unanchored pattern. +.P +When PCRE2_NEWLINE_CRLF, PCRE2_NEWLINE_ANYCRLF, or PCRE2_NEWLINE_ANY is set as +the newline convention, and a match attempt for an unanchored pattern fails +when the current starting position is at a CRLF sequence, and the pattern +contains no explicit matches for CR or LF characters, the match position is +advanced by two characters instead of one, in other words, to after the CRLF. +.P +The above rule is a compromise that makes the most common cases work as +expected. For example, if the pattern is .+A (and the PCRE2_DOTALL option is +not set), it does not match the string "\er\enA" because, after failing at the +start, it skips both the CR and the LF before retrying. However, the pattern +[\er\en]A does match that string, because it contains an explicit CR or LF +reference, and so advances only by one character after the first failure. +.P +An explicit match for CR of LF is either a literal appearance of one of those +characters in the pattern, or one of the \er or \en or equivalent octal or +hexadecimal escape sequences. Implicit matches such as [^X] do not count, nor +does \es, even though it includes CR and LF in the characters that it matches. +.P +Notwithstanding the above, anomalous effects may still occur when CRLF is a +valid newline sequence and explicit \er or \en escapes appear in the pattern. +. +. +.\" HTML +.SH "HOW PCRE2_MATCH() RETURNS A STRING AND CAPTURED SUBSTRINGS" +.rs +.sp +.nf +.B uint32_t pcre2_get_ovector_count(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE *pcre2_get_ovector_pointer(pcre2_match_data *\fImatch_data\fP); +.fi +.P +In general, a pattern matches a certain portion of the subject, and in +addition, further substrings from the subject may be picked out by +parenthesized parts of the pattern. Following the usage in Jeffrey Friedl's +book, this is called "capturing" in what follows, and the phrase "capture +group" (Perl terminology) is used for a fragment of a pattern that picks out a +substring. PCRE2 supports several other kinds of parenthesized group that do +not cause substrings to be captured. The \fBpcre2_pattern_info()\fP function +can be used to find out how many capture groups there are in a compiled +pattern. +.P +You can use auxiliary functions for accessing captured substrings +.\" HTML +.\" +by number +.\" +or +.\" HTML +.\" +by name, +.\" +as described in sections below. +.P +Alternatively, you can make direct use of the vector of PCRE2_SIZE values, +called the \fBovector\fP, which contains the offsets of captured strings. It is +part of the +.\" HTML +.\" +match data block. +.\" +The function \fBpcre2_get_ovector_pointer()\fP returns the address of the +ovector, and \fBpcre2_get_ovector_count()\fP returns the number of pairs of +values it contains. +.P +Within the ovector, the first in each pair of values is set to the offset of +the first code unit of a substring, and the second is set to the offset of the +first code unit after the end of a substring. These values are always code unit +offsets, not character offsets. That is, they are byte offsets in the 8-bit +library, 16-bit offsets in the 16-bit library, and 32-bit offsets in the 32-bit +library. +.P +After a partial match (error return PCRE2_ERROR_PARTIAL), only the first pair +of offsets (that is, \fIovector[0]\fP and \fIovector[1]\fP) are set. They +identify the part of the subject that was partially matched. See the +.\" HREF +\fBpcre2partial\fP +.\" +documentation for details of partial matching. +.P +After a fully successful match, the first pair of offsets identifies the +portion of the subject string that was matched by the entire pattern. The next +pair is used for the first captured substring, and so on. The value returned by +\fBpcre2_match()\fP is one more than the highest numbered pair that has been +set. For example, if two substrings have been captured, the returned value is +3. If there are no captured substrings, the return value from a successful +match is 1, indicating that just the first pair of offsets has been set. +.P +If a pattern uses the \eK escape sequence within a positive assertion, the +reported start of a successful match can be greater than the end of the match. +For example, if the pattern (?=ab\eK) is matched against "ab", the start and +end offset values for the match are 2 and 0. +.P +If a capture group is matched repeatedly within a single match operation, it is +the last portion of the subject that it matched that is returned. +.P +If the ovector is too small to hold all the captured substring offsets, as much +as possible is filled in, and the function returns a value of zero. If captured +substrings are not of interest, \fBpcre2_match()\fP may be called with a match +data block whose ovector is of minimum length (that is, one pair). +.P +It is possible for capture group number \fIn+1\fP to match some part of the +subject when group \fIn\fP has not been used at all. For example, if the string +"abc" is matched against the pattern (a|(z))(bc) the return from the function +is 4, and groups 1 and 3 are matched, but 2 is not. When this happens, both +values in the offset pairs corresponding to unused groups are set to +PCRE2_UNSET. +.P +Offset values that correspond to unused groups at the end of the expression are +also set to PCRE2_UNSET. For example, if the string "abc" is matched against +the pattern (abc)(x(yz)?)? groups 2 and 3 are not matched. The return from the +function is 2, because the highest used capture group number is 1. The offsets +for the second and third capture groups (assuming the vector is large enough, +of course) are set to PCRE2_UNSET. +.P +Elements in the ovector that do not correspond to capturing parentheses in the +pattern are never changed. That is, if a pattern contains \fIn\fP capturing +parentheses, no more than \fIovector[0]\fP to \fIovector[2n+1]\fP are set by +\fBpcre2_match()\fP. The other elements retain whatever values they previously +had. After a failed match attempt, the contents of the ovector are unchanged. +. +. +.\" HTML +.SH "OTHER INFORMATION ABOUT A MATCH" +.rs +.sp +.nf +.B PCRE2_SPTR pcre2_get_mark(pcre2_match_data *\fImatch_data\fP); +.sp +.B PCRE2_SIZE pcre2_get_startchar(pcre2_match_data *\fImatch_data\fP); +.fi +.P +As well as the offsets in the ovector, other information about a match is +retained in the match data block and can be retrieved by the above functions in +appropriate circumstances. If they are called at other times, the result is +undefined. +.P +After a successful match, a partial match (PCRE2_ERROR_PARTIAL), or a failure +to match (PCRE2_ERROR_NOMATCH), a mark name may be available. The function +\fBpcre2_get_mark()\fP can be called to access this name, which can be +specified in the pattern by any of the backtracking control verbs, not just +(*MARK). The same function applies to all the verbs. It returns a pointer to +the zero-terminated name, which is within the compiled pattern. If no name is +available, NULL is returned. The length of the name (excluding the terminating +zero) is stored in the code unit that precedes the name. You should use this +length instead of relying on the terminating zero if the name might contain a +binary zero. +.P +After a successful match, the name that is returned is the last mark name +encountered on the matching path through the pattern. Instances of backtracking +verbs without names do not count. Thus, for example, if the matching path +contains (*MARK:A)(*PRUNE), the name "A" is returned. After a "no match" or a +partial match, the last encountered name is returned. For example, consider +this pattern: +.sp + ^(*MARK:A)((*MARK:B)a|b)c +.sp +When it matches "bc", the returned name is A. The B mark is "seen" in the first +branch of the group, but it is not on the matching path. On the other hand, +when this pattern fails to match "bx", the returned name is B. +.P +\fBWarning:\fP By default, certain start-of-match optimizations are used to +give a fast "no match" result in some situations. For example, if the anchoring +is removed from the pattern above, there is an initial check for the presence +of "c" in the subject before running the matching engine. This check fails for +"bx", causing a match failure without seeing any marks. You can disable the +start-of-match optimizations by setting the PCRE2_NO_START_OPTIMIZE option for +\fBpcre2_compile()\fP or by starting the pattern with (*NO_START_OPT). +.P +After a successful match, a partial match, or one of the invalid UTF errors +(for example, PCRE2_ERROR_UTF8_ERR5), \fBpcre2_get_startchar()\fP can be +called. After a successful or partial match it returns the code unit offset of +the character at which the match started. For a non-partial match, this can be +different to the value of \fIovector[0]\fP if the pattern contains the \eK +escape sequence. After a partial match, however, this value is always the same +as \fIovector[0]\fP because \eK does not affect the result of a partial match. +.P +After a UTF check failure, \fBpcre2_get_startchar()\fP can be used to obtain +the code unit offset of the invalid UTF character. Details are given in the +.\" HREF +\fBpcre2unicode\fP +.\" +page. +. +. +.\" HTML +.SH "ERROR RETURNS FROM \fBpcre2_match()\fP" +.rs +.sp +If \fBpcre2_match()\fP fails, it returns a negative number. This can be +converted to a text string by calling the \fBpcre2_get_error_message()\fP +function (see "Obtaining a textual error message" +.\" HTML +.\" +below). +.\" +Negative error codes are also returned by other functions, and are documented +with them. The codes are given names in the header file. If UTF checking is in +force and an invalid UTF subject string is detected, one of a number of +UTF-specific negative error codes is returned. Details are given in the +.\" HREF +\fBpcre2unicode\fP +.\" +page. The following are the other errors that may be returned by +\fBpcre2_match()\fP: +.sp + PCRE2_ERROR_NOMATCH +.sp +The subject string did not match the pattern. +.sp + PCRE2_ERROR_PARTIAL +.sp +The subject string did not match, but it did match partially. See the +.\" HREF +\fBpcre2partial\fP +.\" +documentation for details of partial matching. +.sp + PCRE2_ERROR_BADMAGIC +.sp +PCRE2 stores a 4-byte "magic number" at the start of the compiled code, to +catch the case when it is passed a junk pointer. This is the error that is +returned when the magic number is not present. +.sp + PCRE2_ERROR_BADMODE +.sp +This error is given when a compiled pattern is passed to a function in a +library of a different code unit width, for example, a pattern compiled by +the 8-bit library is passed to a 16-bit or 32-bit library function. +.sp + PCRE2_ERROR_BADOFFSET +.sp +The value of \fIstartoffset\fP was greater than the length of the subject. +.sp + PCRE2_ERROR_BADOPTION +.sp +An unrecognized bit was set in the \fIoptions\fP argument. +.sp + PCRE2_ERROR_BADUTFOFFSET +.sp +The UTF code unit sequence that was passed as a subject was checked and found +to be valid (the PCRE2_NO_UTF_CHECK option was not set), but the value of +\fIstartoffset\fP did not point to the beginning of a UTF character or the end +of the subject. +.sp + PCRE2_ERROR_CALLOUT +.sp +This error is never generated by \fBpcre2_match()\fP itself. It is provided for +use by callout functions that want to cause \fBpcre2_match()\fP or +\fBpcre2_callout_enumerate()\fP to return a distinctive error code. See the +.\" HREF +\fBpcre2callout\fP +.\" +documentation for details. +.sp + PCRE2_ERROR_DEPTHLIMIT +.sp +The nested backtracking depth limit was reached. +.sp + PCRE2_ERROR_HEAPLIMIT +.sp +The heap limit was reached. +.sp + PCRE2_ERROR_INTERNAL +.sp +An unexpected internal error has occurred. This error could be caused by a bug +in PCRE2 or by overwriting of the compiled pattern. +.sp + PCRE2_ERROR_JIT_STACKLIMIT +.sp +This error is returned when a pattern that was successfully studied using JIT +is being matched, but the memory available for the just-in-time processing +stack is not large enough. See the +.\" HREF +\fBpcre2jit\fP +.\" +documentation for more details. +.sp + PCRE2_ERROR_MATCHLIMIT +.sp +The backtracking match limit was reached. +.sp + PCRE2_ERROR_NOMEMORY +.sp +Heap memory is used to remember backtracking points. This error is given when +the memory allocation function (default or custom) fails. Note that a different +error, PCRE2_ERROR_HEAPLIMIT, is given if the amount of memory needed exceeds +the heap limit. PCRE2_ERROR_NOMEMORY is also returned if +PCRE2_COPY_MATCHED_SUBJECT is set and memory allocation fails. +.sp + PCRE2_ERROR_NULL +.sp +Either the \fIcode\fP, \fIsubject\fP, or \fImatch_data\fP argument was passed +as NULL. +.sp + PCRE2_ERROR_RECURSELOOP +.sp +This error is returned when \fBpcre2_match()\fP detects a recursion loop within +the pattern. Specifically, it means that either the whole pattern or a +capture group has been called recursively for the second time at the same +position in the subject string. Some simple patterns that might do this are +detected and faulted at compile time, but more complicated cases, in particular +mutual recursions between two different groups, cannot be detected until +matching is attempted. +. +. +.\" HTML +.SH "OBTAINING A TEXTUAL ERROR MESSAGE" +.rs +.sp +.nf +.B int pcre2_get_error_message(int \fIerrorcode\fP, PCRE2_UCHAR *\fIbuffer\fP, +.B " PCRE2_SIZE \fIbufflen\fP);" +.fi +.P +A text message for an error code from any PCRE2 function (compile, match, or +auxiliary) can be obtained by calling \fBpcre2_get_error_message()\fP. The code +is passed as the first argument, with the remaining two arguments specifying a +code unit buffer and its length in code units, into which the text message is +placed. The message is returned in code units of the appropriate width for the +library that is being used. +.P +The returned message is terminated with a trailing zero, and the function +returns the number of code units used, excluding the trailing zero. If the +error number is unknown, the negative error code PCRE2_ERROR_BADDATA is +returned. If the buffer is too small, the message is truncated (but still with +a trailing zero), and the negative error code PCRE2_ERROR_NOMEMORY is returned. +None of the messages are very long; a buffer size of 120 code units is ample. +. +. +.\" HTML +.SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER" +.rs +.sp +.nf +.B int pcre2_substring_length_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_SIZE *\fIlength\fP);" +.sp +.B int pcre2_substring_copy_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR *\fIbuffer\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B int pcre2_substring_get_bynumber(pcre2_match_data *\fImatch_data\fP, +.B " uint32_t \fInumber\fP, PCRE2_UCHAR **\fIbufferptr\fP," +.B " PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP); +.fi +.P +Captured substrings can be accessed directly by using the ovector as described +.\" HTML +.\" +above. +.\" +For convenience, auxiliary functions are provided for extracting captured +substrings as new, separate, zero-terminated strings. A substring that contains +a binary zero is correctly extracted and has a further zero added on the end, +but the result is not, of course, a C string. +.P +The functions in this section identify substrings by number. The number zero +refers to the entire matched substring, with higher numbers referring to +substrings captured by parenthesized groups. After a partial match, only +substring zero is available. An attempt to extract any other substring gives +the error PCRE2_ERROR_PARTIAL. The next section describes similar functions for +extracting captured substrings by name. +.P +If a pattern uses the \eK escape sequence within a positive assertion, the +reported start of a successful match can be greater than the end of the match. +For example, if the pattern (?=ab\eK) is matched against "ab", the start and +end offset values for the match are 2 and 0. In this situation, calling these +functions with a zero substring number extracts a zero-length empty string. +.P +You can find the length in code units of a captured substring without +extracting it by calling \fBpcre2_substring_length_bynumber()\fP. The first +argument is a pointer to the match data block, the second is the group number, +and the third is a pointer to a variable into which the length is placed. If +you just want to know whether or not the substring has been captured, you can +pass the third argument as NULL. +.P +The \fBpcre2_substring_copy_bynumber()\fP function copies a captured substring +into a supplied buffer, whereas \fBpcre2_substring_get_bynumber()\fP copies it +into new memory, obtained using the same memory allocation function that was +used for the match data block. The first two arguments of these functions are a +pointer to the match data block and a capture group number. +.P +The final arguments of \fBpcre2_substring_copy_bynumber()\fP are a pointer to +the buffer and a pointer to a variable that contains its length in code units. +This is updated to contain the actual number of code units used for the +extracted substring, excluding the terminating zero. +.P +For \fBpcre2_substring_get_bynumber()\fP the third and fourth arguments point +to variables that are updated with a pointer to the new memory and the number +of code units that comprise the substring, again excluding the terminating +zero. When the substring is no longer needed, the memory should be freed by +calling \fBpcre2_substring_free()\fP. +.P +The return value from all these functions is zero for success, or a negative +error code. If the pattern match failed, the match failure code is returned. +If a substring number greater than zero is used after a partial match, +PCRE2_ERROR_PARTIAL is returned. Other possible error codes are: +.sp + PCRE2_ERROR_NOMEMORY +.sp +The buffer was too small for \fBpcre2_substring_copy_bynumber()\fP, or the +attempt to get memory failed for \fBpcre2_substring_get_bynumber()\fP. +.sp + PCRE2_ERROR_NOSUBSTRING +.sp +There is no substring with that number in the pattern, that is, the number is +greater than the number of capturing parentheses. +.sp + PCRE2_ERROR_UNAVAILABLE +.sp +The substring number, though not greater than the number of captures in the +pattern, is greater than the number of slots in the ovector, so the substring +could not be captured. +.sp + PCRE2_ERROR_UNSET +.sp +The substring did not participate in the match. For example, if the pattern is +(abc)|(def) and the subject is "def", and the ovector contains at least two +capturing slots, substring number 1 is unset. +. +. +.SH "EXTRACTING A LIST OF ALL CAPTURED SUBSTRINGS" +.rs +.sp +.nf +.B int pcre2_substring_list_get(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_UCHAR ***\fIlistptr\fP, PCRE2_SIZE **\fIlengthsptr\fP); +.sp +.B void pcre2_substring_list_free(PCRE2_UCHAR **\fIlist\fP); +.fi +.P +The \fBpcre2_substring_list_get()\fP function extracts all available substrings +and builds a list of pointers to them. It also (optionally) builds a second +list that contains their lengths (in code units), excluding a terminating zero +that is added to each of them. All this is done in a single block of memory +that is obtained using the same memory allocation function that was used to get +the match data block. +.P +This function must be called only after a successful match. If called after a +partial match, the error code PCRE2_ERROR_PARTIAL is returned. +.P +The address of the memory block is returned via \fIlistptr\fP, which is also +the start of the list of string pointers. The end of the list is marked by a +NULL pointer. The address of the list of lengths is returned via +\fIlengthsptr\fP. If your strings do not contain binary zeros and you do not +therefore need the lengths, you may supply NULL as the \fBlengthsptr\fP +argument to disable the creation of a list of lengths. The yield of the +function is zero if all went well, or PCRE2_ERROR_NOMEMORY if the memory block +could not be obtained. When the list is no longer needed, it should be freed by +calling \fBpcre2_substring_list_free()\fP. +.P +If this function encounters a substring that is unset, which can happen when +capture group number \fIn+1\fP matches some part of the subject, but group +\fIn\fP has not been used at all, it returns an empty string. This can be +distinguished from a genuine zero-length substring by inspecting the +appropriate offset in the ovector, which contain PCRE2_UNSET for unset +substrings, or by calling \fBpcre2_substring_length_bynumber()\fP. +. +. +.\" HTML +.SH "EXTRACTING CAPTURED SUBSTRINGS BY NAME" +.rs +.sp +.nf +.B int pcre2_substring_number_from_name(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP);" +.sp +.B int pcre2_substring_length_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SIZE *\fIlength\fP);" +.sp +.B int pcre2_substring_copy_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR *\fIbuffer\fP, PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B int pcre2_substring_get_byname(pcre2_match_data *\fImatch_data\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_UCHAR **\fIbufferptr\fP, PCRE2_SIZE *\fIbufflen\fP);" +.sp +.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP); +.fi +.P +To extract a substring by name, you first have to find associated number. +For example, for this pattern: +.sp + (a+)b(?\ed+)... +.sp +the number of the capture group called "xxx" is 2. If the name is known to be +unique (PCRE2_DUPNAMES was not set), you can find the number from the name by +calling \fBpcre2_substring_number_from_name()\fP. The first argument is the +compiled pattern, and the second is the name. The yield of the function is the +group number, PCRE2_ERROR_NOSUBSTRING if there is no group with that name, or +PCRE2_ERROR_NOUNIQUESUBSTRING if there is more than one group with that name. +Given the number, you can extract the substring directly from the ovector, or +use one of the "bynumber" functions described above. +.P +For convenience, there are also "byname" functions that correspond to the +"bynumber" functions, the only difference being that the second argument is a +name instead of a number. If PCRE2_DUPNAMES is set and there are duplicate +names, these functions scan all the groups with the given name, and return the +captured substring from the first named group that is set. +.P +If there are no groups with the given name, PCRE2_ERROR_NOSUBSTRING is +returned. If all groups with the name have numbers that are greater than the +number of slots in the ovector, PCRE2_ERROR_UNAVAILABLE is returned. If there +is at least one group with a slot in the ovector, but no group is found to be +set, PCRE2_ERROR_UNSET is returned. +.P +\fBWarning:\fP If the pattern uses the (?| feature to set up multiple +capture groups with the same number, as described in the +.\" HTML +.\" +section on duplicate group numbers +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +page, you cannot use names to distinguish the different capture groups, because +names are not included in the compiled code. The matching process uses only +numbers. For this reason, the use of different names for groups with the +same number causes an error at compile time. +. +. +.\" HTML +.SH "CREATING A NEW STRING WITH SUBSTITUTIONS" +.rs +.sp +.nf +.B int pcre2_substitute(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP, PCRE2_SPTR \fIreplacement\fP," +.B " PCRE2_SIZE \fIrlength\fP, PCRE2_UCHAR *\fIoutputbuffer\fP," +.B " PCRE2_SIZE *\fIoutlengthptr\fP);" +.fi +.P +This function optionally calls \fBpcre2_match()\fP and then makes a copy of the +subject string in \fIoutputbuffer\fP, replacing parts that were matched with +the \fIreplacement\fP string, whose length is supplied in \fBrlength\fP, which +can be given as PCRE2_ZERO_TERMINATED for a zero-terminated string. As a +special case, if \fIreplacement\fP is NULL and \fIrlength\fP is zero, the +replacement is assumed to be an empty string. If \fIrlength\fP is non-zero, an +error occurs if \fIreplacement\fP is NULL. +.P +There is an option (see PCRE2_SUBSTITUTE_REPLACEMENT_ONLY below) to return just +the replacement string(s). The default action is to perform just one +replacement if the pattern matches, but there is an option that requests +multiple replacements (see PCRE2_SUBSTITUTE_GLOBAL below). +.P +If successful, \fBpcre2_substitute()\fP returns the number of substitutions +that were carried out. This may be zero if no match was found, and is never +greater than one unless PCRE2_SUBSTITUTE_GLOBAL is set. A negative value is +returned if an error is detected. +.P +Matches in which a \eK item in a lookahead in the pattern causes the match to +end before it starts are not supported, and give rise to an error return. For +global replacements, matches in which \eK in a lookbehind causes the match to +start earlier than the point that was reached in the previous iteration are +also not supported. +.P +The first seven arguments of \fBpcre2_substitute()\fP are the same as for +\fBpcre2_match()\fP, except that the partial matching options are not +permitted, and \fImatch_data\fP may be passed as NULL, in which case a match +data block is obtained and freed within this function, using memory management +functions from the match context, if provided, or else those that were used to +allocate memory for the compiled code. +.P +If \fImatch_data\fP is not NULL and PCRE2_SUBSTITUTE_MATCHED is not set, the +provided block is used for all calls to \fBpcre2_match()\fP, and its contents +afterwards are the result of the final call. For global changes, this will +always be a no-match error. The contents of the ovector within the match data +block may or may not have been changed. +.P +As well as the usual options for \fBpcre2_match()\fP, a number of additional +options can be set in the \fIoptions\fP argument of \fBpcre2_substitute()\fP. +One such option is PCRE2_SUBSTITUTE_MATCHED. When this is set, an external +\fImatch_data\fP block must be provided, and it must have already been used for +an external call to \fBpcre2_match()\fP with the same pattern and subject +arguments. The data in the \fImatch_data\fP block (return code, offset vector) +is then used for the first substitution instead of calling \fBpcre2_match()\fP +from within \fBpcre2_substitute()\fP. This allows an application to check for a +match before choosing to substitute, without having to repeat the match. +.P +The contents of the externally supplied match data block are not changed when +PCRE2_SUBSTITUTE_MATCHED is set. If PCRE2_SUBSTITUTE_GLOBAL is also set, +\fBpcre2_match()\fP is called after the first substitution to check for further +matches, but this is done using an internally obtained match data block, thus +always leaving the external block unchanged. +.P +The \fIcode\fP argument is not used for matching before the first substitution +when PCRE2_SUBSTITUTE_MATCHED is set, but it must be provided, even when +PCRE2_SUBSTITUTE_GLOBAL is not set, because it contains information such as the +UTF setting and the number of capturing parentheses in the pattern. +.P +The default action of \fBpcre2_substitute()\fP is to return a copy of the +subject string with matched substrings replaced. However, if +PCRE2_SUBSTITUTE_REPLACEMENT_ONLY is set, only the replacement substrings are +returned. In the global case, multiple replacements are concatenated in the +output buffer. Substitution callouts (see +.\" HTML +.\" +below) +.\" +can be used to separate them if necessary. +.P +The \fIoutlengthptr\fP argument of \fBpcre2_substitute()\fP must point to a +variable that contains the length, in code units, of the output buffer. If the +function is successful, the value is updated to contain the length in code +units of the new string, excluding the trailing zero that is automatically +added. +.P +If the function is not successful, the value set via \fIoutlengthptr\fP depends +on the type of error. For syntax errors in the replacement string, the value is +the offset in the replacement string where the error was detected. For other +errors, the value is PCRE2_UNSET by default. This includes the case of the +output buffer being too small, unless PCRE2_SUBSTITUTE_OVERFLOW_LENGTH is set. +.P +PCRE2_SUBSTITUTE_OVERFLOW_LENGTH changes what happens when the output buffer is +too small. The default action is to return PCRE2_ERROR_NOMEMORY immediately. If +this option is set, however, \fBpcre2_substitute()\fP continues to go through +the motions of matching and substituting (without, of course, writing anything) +in order to compute the size of buffer that is needed, which will include the +extra space for the terminating NUL. This value is passed back via the +\fIoutlengthptr\fP variable, with the result of the function still being +PCRE2_ERROR_NOMEMORY. +.P +Passing a buffer size of zero is a permitted way of finding out how much memory +is needed for given substitution. However, this does mean that the entire +operation is carried out twice. Depending on the application, it may be more +efficient to allocate a large buffer and free the excess afterwards, instead of +using PCRE2_SUBSTITUTE_OVERFLOW_LENGTH. +.P +The replacement string, which is interpreted as a UTF string in UTF mode, is +checked for UTF validity unless PCRE2_NO_UTF_CHECK is set. An invalid UTF +replacement string causes an immediate return with the relevant UTF error code. +.P +If PCRE2_SUBSTITUTE_LITERAL is set, the replacement string is not interpreted +in any way. By default, however, a dollar character is an escape character that +can specify the insertion of characters from capture groups and names from +(*MARK) or other control verbs in the pattern. Dollar is the only escape +character (backslash is treated as literal). The following forms are +recognized: +.sp + $$ insert a dollar character + $n or ${n} insert the contents of group \fIn\fP + $0 or $& insert the entire matched substring + $` insert the substring that precedes the match + $' insert the substring that follows the match + $_ insert the entire input string + $*MARK or ${*MARK} insert a control verb name +.sp +Either a group number or a group name can be given for \fIn\fP, for example $2 or +$NAME. Curly brackets are required only if the following character would be +interpreted as part of the number or name. The number may be zero to include +the entire matched string. For example, if the pattern a(b)c is matched with +"=abc=" and the replacement string "+$1$0$1+", the result is "=+babcb+=". +.P +The JavaScript form $, where the angle brackets are part of the syntax, +is also recognized for group names, but not for group numbers or *MARK. +.P +$*MARK inserts the name from the last encountered backtracking control verb on +the matching path that has a name. (*MARK) must always include a name, but the +other verbs need not. For example, in the case of (*MARK:A)(*PRUNE) the name +inserted is "A", but for (*MARK:A)(*PRUNE:B) the relevant name is "B". This +facility can be used to perform simple simultaneous substitutions, as this +\fBpcre2test\fP example shows: +.sp + /(*MARK:pear)apple|(*MARK:orange)lemon/g,replace=${*MARK} + apple lemon + 2: pear orange +.sp +PCRE2_SUBSTITUTE_GLOBAL causes the function to iterate over the subject string, +replacing every matching substring. If this option is not set, only the first +matching substring is replaced. The search for matches takes place in the +original subject string (that is, previous replacements do not affect it). +Iteration is implemented by advancing the \fIstartoffset\fP value for each +search, which is always passed the entire subject string. If an offset limit is +set in the match context, searching stops when that limit is reached. +.P +You can restrict the effect of a global substitution to a portion of the +subject string by setting either or both of \fIstartoffset\fP and an offset +limit. Here is a \fBpcre2test\fP example: +.sp + /B/g,replace=!,use_offset_limit + ABC ABC ABC ABC\e=offset=3,offset_limit=12 + 2: ABC A!C A!C ABC +.sp +When continuing with global substitutions after matching a substring with zero +length, an attempt to find a non-empty match at the same offset is performed. +If this is not successful, the offset is advanced by one character except when +CRLF is a valid newline sequence and the next two characters are CR, LF. In +this case, the offset is advanced by two characters. +.P +PCRE2_SUBSTITUTE_UNKNOWN_UNSET causes references to capture groups that do +not appear in the pattern to be treated as unset groups. This option should be +used with care, because it means that a typo in a group name or number no +longer causes the PCRE2_ERROR_NOSUBSTRING error. +.P +PCRE2_SUBSTITUTE_UNSET_EMPTY causes unset capture groups (including unknown +groups when PCRE2_SUBSTITUTE_UNKNOWN_UNSET is set) to be treated as empty +strings when inserted as described above. If this option is not set, an attempt +to insert an unset group causes the PCRE2_ERROR_UNSET error. This option does +not influence the extended substitution syntax described below. +.P +PCRE2_SUBSTITUTE_EXTENDED causes extra processing to be applied to the +replacement string. Without this option, only the dollar character is special, +and only the group insertion forms listed above are valid. When +PCRE2_SUBSTITUTE_EXTENDED is set, several things change: +.P +Firstly, backslash in a replacement string is interpreted as an escape +character. The usual forms such as \ex{ddd} can be used to specify particular +character codes, and backslash followed by any non-alphanumeric character +quotes that character. Extended quoting can be coded using \eQ...\eE, exactly +as in pattern strings. The escapes \eb and \ev are interpreted as the +characters backspace and vertical tab, respectively. +.P +The interpretation of backslash followed by one or more digits is the same as +in a pattern, which in Perl has some ambiguities. Details are given in the +.\" HREF +\fBpcre2pattern\fP +.\" +page. +.P +The Python form \eg, where the angle brackets are part of the syntax and \fIn\fP +is either a group name or number, is recognized as an altertive way of +inserting the contents of a group, for example \eg<3>. +.P +There are also four escape sequences for forcing the case of inserted letters. +Case forcing applies to all inserted characters, including those from capture +groups and letters within \eQ...\eE quoted sequences. The insertion mechanism +has three states: no case forcing, force upper case, and force lower case. The +escape sequences change the current state: \eU and \eL change to upper or lower +case forcing, respectively, and \eE (when not terminating a \eQ quoted +sequence) reverts to no case forcing. The sequences \eu and \el force the next +character (if it is a letter) to upper or lower case, respectively, and then +the state automatically reverts to no case forcing. +.P +However, if \eu is immediately followed by \eL or \el is immediately followed +by \eU, the next character's case is forced by the first escape sequence, and +subsequent characters by the second. This provides a "title casing" facility +that can be applied to group captures. For example, if group 1 has captured +"heLLo", the replacement string "\eu\eL$1" becomes "Hello". +.P +If either PCRE2_UTF or PCRE2_UCP was set when the pattern was compiled, Unicode +properties are used for case forcing characters whose code points are greater +than 127. However, only simple case folding, as determined by the Unicode file +\fBCaseFolding.txt\fP is supported. PCRE2 does not support language-specific +special casing rules such as using different lower case Greek sigmas in the +middle and ends of words (as defined in the Unicode file +\fBSpecialCasing.txt\fP). +.P +Note that case forcing sequences such as \eU...\eE do not nest. For example, +the result of processing "\eUaa\eLBB\eEcc\eE" is "AAbbcc"; the final \eE has no +effect. Note also that the PCRE2_ALT_BSUX and PCRE2_EXTRA_ALT_BSUX options do +not apply to replacement strings. +.P +The final effect of setting PCRE2_SUBSTITUTE_EXTENDED is to add more +flexibility to capture group substitution. The syntax is similar to that used +by Bash: +.sp + ${n:-string} + ${n:+string1:string2} +.sp +As in the simple case, \fIn\fP may be a group number or a name. The first form +specifies a default value. If group \fIn\fP is set, its value is inserted; if +not, the string is expanded and the result inserted. The second form specifies +strings that are expanded and inserted when group \fIn\fP is set or unset, +respectively. The first form is just a convenient shorthand for +.sp + ${n:+${n}:string} +.sp +Backslash can be used to escape colons and closing curly brackets in the +replacement strings. A change of the case forcing state within a replacement +string remains in force afterwards, as shown in this \fBpcre2test\fP example: +.sp + /(some)?(body)/substitute_extended,replace=${1:+\eU:\eL}HeLLo + body + 1: hello + somebody + 1: HELLO +.sp +The PCRE2_SUBSTITUTE_UNSET_EMPTY option does not affect these extended +substitutions. However, PCRE2_SUBSTITUTE_UNKNOWN_UNSET does cause unknown +groups in the extended syntax forms to be treated as unset. +.P +If PCRE2_SUBSTITUTE_LITERAL is set, PCRE2_SUBSTITUTE_UNKNOWN_UNSET, +PCRE2_SUBSTITUTE_UNSET_EMPTY, and PCRE2_SUBSTITUTE_EXTENDED are irrelevant and +are ignored. +. +. +.SS "Substitution errors" +.rs +.sp +In the event of an error, \fBpcre2_substitute()\fP returns a negative error +code. Except for PCRE2_ERROR_NOMATCH (which is never returned), errors from +\fBpcre2_match()\fP are passed straight back. +.P +PCRE2_ERROR_NOSUBSTRING is returned for a non-existent substring insertion, +unless PCRE2_SUBSTITUTE_UNKNOWN_UNSET is set. +.P +PCRE2_ERROR_UNSET is returned for an unset substring insertion (including an +unknown substring when PCRE2_SUBSTITUTE_UNKNOWN_UNSET is set) when the simple +(non-extended) syntax is used and PCRE2_SUBSTITUTE_UNSET_EMPTY is not set. +.P +PCRE2_ERROR_NOMEMORY is returned if the output buffer is not big enough. If the +PCRE2_SUBSTITUTE_OVERFLOW_LENGTH option is set, the size of buffer that is +needed is returned via \fIoutlengthptr\fP. Note that this does not happen by +default. +.P +PCRE2_ERROR_NULL is returned if PCRE2_SUBSTITUTE_MATCHED is set but the +\fImatch_data\fP argument is NULL or if the \fIsubject\fP or \fIreplacement\fP +arguments are NULL. For backward compatibility reasons an exception is made for +the \fIreplacement\fP argument if the \fIrlength\fP argument is also 0. +.P +PCRE2_ERROR_BADREPLACEMENT is used for miscellaneous syntax errors in the +replacement string, with more particular errors being PCRE2_ERROR_BADREPESCAPE +(invalid escape sequence), PCRE2_ERROR_REPMISSINGBRACE (closing curly bracket +not found), PCRE2_ERROR_BADSUBSTITUTION (syntax error in extended group +substitution), and PCRE2_ERROR_BADSUBSPATTERN (the pattern match ended before +it started or the match started earlier than the current position in the +subject, which can happen if \eK is used in an assertion). +.P +As for all PCRE2 errors, a text message that describes the error can be +obtained by calling the \fBpcre2_get_error_message()\fP function (see +"Obtaining a textual error message" +.\" HTML +.\" +above). +.\" +. +. +.\" HTML +.SS "Substitution callouts" +.rs +.sp +.nf +.B int pcre2_set_substitute_callout(pcre2_match_context *\fImcontext\fP, +.B " int (*\fIcallout_function\fP)(pcre2_substitute_callout_block *, void *)," +.B " void *\fIcallout_data\fP);" +.fi +.sp +The \fBpcre2_set_substitution_callout()\fP function can be used to specify a +callout function for \fBpcre2_substitute()\fP. This information is passed in +a match context. The callout function is called after each substitution has +been processed, but it can cause the replacement not to happen. +.P +The callout function is not called for simulated substitutions that happen as a +result of the PCRE2_SUBSTITUTE_OVERFLOW_LENGTH option. In this mode, when +substitution processing exceeds the buffer space provided by the caller, +processing continues by counting code units. The simulation is unable to +populate the callout block, and so the simulation is pessimistic about the +required buffer size. Whichever is larger of accepted or rejected substitution +is reported as the required size. Therefore, the returned buffer length may be +an overestimate (without a substitution callout, it is normally an exact +measurement). +.P +The first argument of the callout function is a pointer to a substitute callout +block structure, which contains the following fields, not necessarily in this +order: +.sp + uint32_t \fIversion\fP; + uint32_t \fIsubscount\fP; + PCRE2_SPTR \fIinput\fP; + PCRE2_SPTR \fIoutput\fP; + PCRE2_SIZE \fI*ovector\fP; + uint32_t \fIoveccount\fP; + PCRE2_SIZE \fIoutput_offsets[2]\fP; +.sp +The \fIversion\fP field contains the version number of the block format. The +current version is 0. The version number will increase in future if more fields +are added, but the intention is never to remove any of the existing fields. +.P +The \fIsubscount\fP field is the number of the current match. It is 1 for the +first callout, 2 for the second, and so on. The \fIinput\fP and \fIoutput\fP +pointers are copies of the values passed to \fBpcre2_substitute()\fP. +.P +The \fIovector\fP field points to the ovector, which contains the result of the +most recent match. The \fIoveccount\fP field contains the number of pairs that +are set in the ovector, and is always greater than zero. +.P +The \fIoutput_offsets\fP vector contains the offsets of the replacement in the +output string. This has already been processed for dollar and (if requested) +backslash substitutions as described above. +.P +The second argument of the callout function is the value passed as +\fIcallout_data\fP when the function was registered. The value returned by the +callout function is interpreted as follows: +.P +If the value is zero, the replacement is accepted, and, if +PCRE2_SUBSTITUTE_GLOBAL is set, processing continues with a search for the next +match. If the value is not zero, the current replacement is not accepted. If +the value is greater than zero, processing continues when +PCRE2_SUBSTITUTE_GLOBAL is set. Otherwise (the value is less than zero or +PCRE2_SUBSTITUTE_GLOBAL is not set), the rest of the input is copied to the +output and the call to \fBpcre2_substitute()\fP exits, returning the number of +matches so far. +. +. +.SS "Substitution case callouts" +.rs +.sp +.nf +.B int pcre2_set_substitute_case_callout(pcre2_match_context *\fImcontext\fP, +.B " PCRE2_SIZE (*\fIcallout_function\fP)(PCRE2_SPTR, PCRE2_SIZE," +.B " PCRE2_UCHAR *, PCRE2_SIZE," +.B " int, void *)," +.B " void *\fIcallout_data\fP);" +.fi +.sp +The \fBpcre2_set_substitution_case_callout()\fP function can be used to specify +a callout function for \fBpcre2_substitute()\fP to use when performing case +transformations. This does not affect any case insensitivity behaviour when +performing a match, but only the user-visible transformations performed when +processing a substitution such as: +.sp + pcre2_substitute(..., "\e\eU$1", ...) +.P +The default case transformations applied by PCRE2 are reasonably complete, and, +in UTF or UCP mode, perform the simple locale-invariant case transformations as +specified by Unicode. This is suitable for the internal (invisible) +case-equivalence procedures used during pattern matching, but an application +may wish to use more sophisticated locale-aware processing for the user-visible +substitution transformations. +.P +One example implementation of the \fIcallout_function\fP using the ICU +library would be: +.sp +.nf + PCRE2_SIZE + icu_case_callout( + PCRE2_SPTR input, PCRE2_SIZE input_len, + PCRE2_UCHAR *output, PCRE2_SIZE output_cap, + int to_case, void *data_ptr) + { + UErrorCode err = U_ZERO_ERROR; + int32_t r = to_case == PCRE2_SUBSTITUTE_CASE_LOWER + ? u_strToLower(output, output_cap, input, input_len, NULL, &err) + : to_case == PCRE2_SUBSTITUTE_CASE_UPPER + ? u_strToUpper(output, output_cap, input, input_len, NULL, &err) + : u_strToTitle(output, output_cap, input, input_len, &first_char_only, + NULL, &err); + if (U_FAILURE(err)) return (~(PCRE2_SIZE)0); + return r; + } +.fi +.P +The first and second arguments of the case callout function are the Unicode +string to transform. +.P +The third and fourth arguments are the output buffer and its capacity. +.P +The fifth is one of the constants PCRE2_SUBSTITUTE_CASE_LOWER, +PCRE2_SUBSTITUTE_CASE_UPPER, or PCRE2_SUBSTITUTE_CASE_TITLE_FIRST. +PCRE2_SUBSTITUTE_CASE_LOWER and PCRE2_SUBSTITUTE_CASE_UPPER are passed to the +callout to indicate that the case of the entire callout input should be +case-transformed. PCRE2_SUBSTITUTE_CASE_TITLE_FIRST is passed to indicate that +only the first character or glyph should be transformed to Unicode titlecase +and the rest to Unicode lowercase (note that titlecasing sometimes uses Unicode +properties to titlecase each word in a string; but PCRE2 is requesting that only +the single leading character is to be titlecased). +.P +The sixth argument is the \fIcallout_data\fP supplied to +\fBpcre2_set_substitute_case_callout()\fP. +.P +The resulting string in the destination buffer may be larger or smaller than the +input, if the casing rules merge or split characters. The return value is the +length required for the output string. If a buffer of sufficient size was +provided to the callout, then the result must be written to the buffer and the +number of code units returned. If the result does not fit in the provided +buffer, then the required capacity must be returned and PCRE2 will not make use +of the output buffer. PCRE2 provides input and output buffers which overlap, so +the callout must support this by suitable internal buffering. +.P +Alternatively, if the callout wishes to indicate an error, then it may return +(~(PCRE2_SIZE)0). In this case pcre2_substitute() will immediately fail with +error PCRE2_ERROR_REPLACECASE. +.P +When a case callout is combined with the PCRE2_SUBSTITUTE_OVERFLOW_LENGTH +option, there are situations when pcre2_substitute() will return an +underestimate of the required buffer size. If you call pcre2_substitute() once +with PCRE2_SUBSTITUTE_OVERFLOW_LENGTH, and the input buffer is too small for +the replacement string to be constructed, then instead of calling the case +callout, pcre2_substitute() will make an estimate of the required buffer size. +The second call should also pass PCRE2_SUBSTITUTE_OVERFLOW_LENGTH, because that +second call is not guaranteed to succeed either, if the case callout requires +more buffer space than expected. The caller must make repeated attempts in a +loop. +. +. +.SH "DUPLICATE CAPTURE GROUP NAMES" +.rs +.sp +.nf +.B int pcre2_substring_nametable_scan(const pcre2_code *\fIcode\fP, +.B " PCRE2_SPTR \fIname\fP, PCRE2_SPTR *\fIfirst\fP, PCRE2_SPTR *\fIlast\fP);" +.fi +.P +When a pattern is compiled with the PCRE2_DUPNAMES option, names for capture +groups are not required to be unique. Duplicate names are always allowed for +groups with the same number, created by using the (?| feature. Indeed, if such +groups are named, they are required to use the same names. +.P +Normally, patterns that use duplicate names are such that in any one match, +only one of each set of identically-named groups participates. An example is +shown in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. +.P +When duplicates are present, \fBpcre2_substring_copy_byname()\fP and +\fBpcre2_substring_get_byname()\fP return the first substring corresponding to +the given name that is set. Only if none are set is PCRE2_ERROR_UNSET is +returned. The \fBpcre2_substring_number_from_name()\fP function returns the +error PCRE2_ERROR_NOUNIQUESUBSTRING when there are duplicate names. +.P +If you want to get full details of all captured substrings for a given name, +you must use the \fBpcre2_substring_nametable_scan()\fP function. The first +argument is the compiled pattern, and the second is the name. If the third and +fourth arguments are NULL, the function returns a group number for a unique +name, or PCRE2_ERROR_NOUNIQUESUBSTRING otherwise. +.P +When the third and fourth arguments are not NULL, they must be pointers to +variables that are updated by the function. After it has run, they point to the +first and last entries in the name-to-number table for the given name, and the +function returns the length of each entry in code units. In both cases, +PCRE2_ERROR_NOSUBSTRING is returned if there are no entries for the given name. +.P +The format of the name table is described +.\" HTML +.\" +above +.\" +in the section entitled \fIInformation about a pattern\fP. Given all the +relevant entries for the name, you can extract each of their numbers, and hence +the captured data. +. +. +.SH "FINDING ALL POSSIBLE MATCHES AT ONE POSITION" +.rs +.sp +The traditional matching function uses a similar algorithm to Perl, which stops +when it finds the first match at a given point in the subject. If you want to +find all possible matches, or the longest possible match at a given position, +consider using the alternative matching function (see below) instead. If you +cannot use the alternative function, you can kludge it up by making use of the +callout facility, which is described in the +.\" HREF +\fBpcre2callout\fP +.\" +documentation. +.P +What you have to do is to insert a callout right at the end of the pattern. +When your callout function is called, extract and save the current matched +substring. Then return 1, which forces \fBpcre2_match()\fP to backtrack and try +other alternatives. Ultimately, when it runs out of matches, +\fBpcre2_match()\fP will yield PCRE2_ERROR_NOMATCH. +. +. +.\" HTML +.SH "MATCHING A PATTERN: THE ALTERNATIVE FUNCTION" +.rs +.sp +.nf +.B int pcre2_dfa_match(const pcre2_code *\fIcode\fP, PCRE2_SPTR \fIsubject\fP, +.B " PCRE2_SIZE \fIlength\fP, PCRE2_SIZE \fIstartoffset\fP," +.B " uint32_t \fIoptions\fP, pcre2_match_data *\fImatch_data\fP," +.B " pcre2_match_context *\fImcontext\fP," +.B " int *\fIworkspace\fP, PCRE2_SIZE \fIwscount\fP);" +.fi +.P +The function \fBpcre2_dfa_match()\fP is called to match a subject string +against a compiled pattern, using a matching algorithm that scans the subject +string just once (not counting lookaround assertions), and does not backtrack +(except when processing lookaround assertions). This has different +characteristics to the normal algorithm, and is not compatible with Perl. Some +of the features of PCRE2 patterns are not supported. Nevertheless, there are +times when this kind of matching can be useful. For a discussion of the two +matching algorithms, and a list of features that \fBpcre2_dfa_match()\fP does +not support, see the +.\" HREF +\fBpcre2matching\fP +.\" +documentation. +.P +The arguments for the \fBpcre2_dfa_match()\fP function are the same as for +\fBpcre2_match()\fP, plus two extras. The ovector within the match data block +is used in a different way, and this is described below. The other common +arguments are used in the same way as for \fBpcre2_match()\fP, so their +description is not repeated here. +.P +The two additional arguments provide workspace for the function. The workspace +vector should contain at least 20 elements. It is used for keeping track of +multiple paths through the pattern tree. More workspace is needed for patterns +and subjects where there are a lot of potential matches. +.P +Here is an example of a simple call to \fBpcre2_dfa_match()\fP: +.sp + int wspace[20]; + pcre2_match_data *md = pcre2_match_data_create(4, NULL); + int rc = pcre2_dfa_match( + re, /* result of pcre2_compile() */ + "some string", /* the subject string */ + 11, /* the length of the subject string */ + 0, /* start at offset 0 in the subject */ + 0, /* default options */ + md, /* the match data block */ + NULL, /* a match context; NULL means use defaults */ + wspace, /* working space vector */ + 20); /* number of elements (NOT size in bytes) */ +. +.SS "Option bits for \fBpcre2_dfa_match()\fP" +.rs +.sp +The unused bits of the \fIoptions\fP argument for \fBpcre2_dfa_match()\fP must +be zero. The only bits that may be set are PCRE2_ANCHORED, +PCRE2_COPY_MATCHED_SUBJECT, PCRE2_ENDANCHORED, PCRE2_NOTBOL, PCRE2_NOTEOL, +PCRE2_NOTEMPTY, PCRE2_NOTEMPTY_ATSTART, PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, +PCRE2_PARTIAL_SOFT, PCRE2_DFA_SHORTEST, and PCRE2_DFA_RESTART. All but the last +four of these are exactly the same as for \fBpcre2_match()\fP, so their +description is not repeated here. +.sp + PCRE2_PARTIAL_HARD + PCRE2_PARTIAL_SOFT +.sp +These have the same general effect as they do for \fBpcre2_match()\fP, but the +details are slightly different. When PCRE2_PARTIAL_HARD is set for +\fBpcre2_dfa_match()\fP, it returns PCRE2_ERROR_PARTIAL if the end of the +subject is reached and there is still at least one matching possibility that +requires additional characters. This happens even if some complete matches have +already been found. When PCRE2_PARTIAL_SOFT is set, the return code +PCRE2_ERROR_NOMATCH is converted into PCRE2_ERROR_PARTIAL if the end of the +subject is reached, there have been no complete matches, but there is still at +least one matching possibility. The portion of the string that was inspected +when the longest partial match was found is set as the first matching string in +both cases. There is a more detailed discussion of partial and multi-segment +matching, with examples, in the +.\" HREF +\fBpcre2partial\fP +.\" +documentation. +.sp + PCRE2_DFA_SHORTEST +.sp +Setting the PCRE2_DFA_SHORTEST option causes the matching algorithm to stop as +soon as it has found one match. Because of the way the alternative algorithm +works, this is necessarily the shortest possible match at the first possible +matching point in the subject string. +.sp + PCRE2_DFA_RESTART +.sp +When \fBpcre2_dfa_match()\fP returns a partial match, it is possible to call it +again, with additional subject characters, and have it continue with the same +match. The PCRE2_DFA_RESTART option requests this action; when it is set, the +\fIworkspace\fP and \fIwscount\fP options must reference the same vector as +before because data about the match so far is left in them after a partial +match. There is more discussion of this facility in the +.\" HREF +\fBpcre2partial\fP +.\" +documentation. +. +. +.SS "Successful returns from \fBpcre2_dfa_match()\fP" +.rs +.sp +When \fBpcre2_dfa_match()\fP succeeds, it may have matched more than one +substring in the subject. Note, however, that all the matches from one run of +the function start at the same point in the subject. The shorter matches are +all initial substrings of the longer matches. For example, if the pattern +.sp + <.*> +.sp +is matched against the string +.sp + This is no more +.sp +the three matched strings are +.sp + + + +.sp +On success, the yield of the function is a number greater than zero, which is +the number of matched substrings. The offsets of the substrings are returned in +the ovector, and can be extracted by number in the same way as for +\fBpcre2_match()\fP, but the numbers bear no relation to any capture groups +that may exist in the pattern, because DFA matching does not support capturing. +.P +Calls to the convenience functions that extract substrings by name +return the error PCRE2_ERROR_DFA_UFUNC (unsupported function) if used after a +DFA match. The convenience functions that extract substrings by number never +return PCRE2_ERROR_NOSUBSTRING. +.P +The matched strings are stored in the ovector in reverse order of length; that +is, the longest matching string is first. If there were too many matches to fit +into the ovector, the yield of the function is zero, and the vector is filled +with the longest matches. +.P +NOTE: PCRE2's "auto-possessification" optimization usually applies to character +repeats at the end of a pattern (as well as internally). For example, the +pattern "a\ed+" is compiled as if it were "a\ed++". For DFA matching, this +means that only one possible match is found. If you really do want multiple +matches in such cases, either use an ungreedy repeat such as "a\ed+?" or set +the PCRE2_NO_AUTO_POSSESS option when compiling. +. +. +.SS "Error returns from \fBpcre2_dfa_match()\fP" +.rs +.sp +The \fBpcre2_dfa_match()\fP function returns a negative number when it fails. +Many of the errors are the same as for \fBpcre2_match()\fP, as described +.\" HTML +.\" +above. +.\" +There are in addition the following errors that are specific to +\fBpcre2_dfa_match()\fP: +.sp + PCRE2_ERROR_DFA_UITEM +.sp +This return is given if \fBpcre2_dfa_match()\fP encounters an item in the +pattern that it does not support, for instance, the use of \eC in a UTF mode or +a backreference. +.sp + PCRE2_ERROR_DFA_UCOND +.sp +This return is given if \fBpcre2_dfa_match()\fP encounters a condition item +that uses a backreference for the condition, or a test for recursion in a +specific capture group. These are not supported. +.sp + PCRE2_ERROR_DFA_UINVALID_UTF +.sp +This return is given if \fBpcre2_dfa_match()\fP is called for a pattern that +was compiled with PCRE2_MATCH_INVALID_UTF. This is not supported for DFA +matching. +.sp + PCRE2_ERROR_DFA_WSSIZE +.sp +This return is given if \fBpcre2_dfa_match()\fP runs out of space in the +\fIworkspace\fP vector. +.sp + PCRE2_ERROR_DFA_RECURSE +.sp +When a recursion or subroutine call is processed, the matching function calls +itself recursively, using private memory for the ovector and \fIworkspace\fP. +This error is given if the internal ovector is not large enough. This should be +extremely rare, as a vector of size 1000 is used. +.sp + PCRE2_ERROR_DFA_BADRESTART +.sp +When \fBpcre2_dfa_match()\fP is called with the \fBPCRE2_DFA_RESTART\fP option, +some plausibility checks are made on the contents of the workspace, which +should contain data about the previous partial match. If any of these checks +fail, this error is given. +. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre2build\fP(3), \fBpcre2callout\fP(3), \fBpcre2demo(3)\fP, +\fBpcre2matching\fP(3), \fBpcre2partial\fP(3), \fBpcre2posix\fP(3), +\fBpcre2sample\fP(3), \fBpcre2unicode\fP(3). +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 26 December 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2build.3 b/miniconda3/share/man/man3/pcre2build.3 new file mode 100644 index 0000000000000000000000000000000000000000..787e02de3eae6feb3a91d40dd346ca3606c5d215 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2build.3 @@ -0,0 +1,665 @@ +.TH PCRE2BUILD 3 "16 April 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +. +. +.SH "BUILDING PCRE2" +.rs +.sp +PCRE2 is distributed with a \fBconfigure\fP script that can be used to build +the library in Unix-like environments using the applications known as +Autotools. Also in the distribution are files to support building using +\fBCMake\fP instead of \fBconfigure\fP. The text file +.\" HTML +.\" +\fBREADME\fP +.\" +contains general information about building with Autotools (some of which is +repeated below), and also has some comments about building on various operating +systems. The files in the \fBvms\fP directory support building under OpenVMS. +There is a lot more information about building PCRE2 without using +Autotools (including information about using \fBCMake\fP and building "by +hand") in the text file called +.\" HTML +.\" +\fBNON-AUTOTOOLS-BUILD\fP. +.\" +You should consult this file as well as the +.\" HTML +.\" +\fBREADME\fP +.\" +file if you are building in a non-Unix-like environment. +. +. +.SH "PCRE2 BUILD-TIME OPTIONS" +.rs +.sp +The rest of this document describes the optional features of PCRE2 that can be +selected when the library is compiled. It assumes use of the \fBconfigure\fP +script, where the optional features are selected or deselected by providing +options to \fBconfigure\fP before running the \fBmake\fP command. However, the +same options can be selected in both Unix-like and non-Unix-like environments +if you are using \fBCMake\fP instead of \fBconfigure\fP to build PCRE2. +.P +If you are not using Autotools or \fBCMake\fP, option selection can be done by +editing the \fBconfig.h\fP file, or by passing parameter settings to the +compiler, as described in +.\" HTML +.\" +\fBNON-AUTOTOOLS-BUILD\fP. +.\" +.P +The complete list of options for \fBconfigure\fP (which includes the standard +ones such as the selection of the installation directory) can be obtained by +running +.sp + ./configure --help +.sp +The following sections include descriptions of "on/off" options whose names +begin with --enable or --disable. Because of the way that \fBconfigure\fP +works, --enable and --disable always come in pairs, so the complementary option +always exists as well, but as it specifies the default, it is not described. +Options that specify values have names that start with --with. At the end of a +\fBconfigure\fP run, a summary of the configuration is output. +. +. +.SH "BUILDING 8-BIT, 16-BIT AND 32-BIT LIBRARIES" +.rs +.sp +By default, a library called \fBlibpcre2-8\fP is built, containing functions +that take string arguments contained in arrays of bytes, interpreted either as +single-byte characters, or UTF-8 strings. You can also build two other +libraries, called \fBlibpcre2-16\fP and \fBlibpcre2-32\fP, which process +strings that are contained in arrays of 16-bit and 32-bit code units, +respectively. These can be interpreted either as single-unit characters or +UTF-16/UTF-32 strings. To build these additional libraries, add one or both of +the following to the \fBconfigure\fP command: +.sp + --enable-pcre2-16 + --enable-pcre2-32 +.sp +If you do not want the 8-bit library, add +.sp + --disable-pcre2-8 +.sp +as well. At least one of the three libraries must be built. Note that the POSIX +wrapper is for the 8-bit library only, and that \fBpcre2grep\fP is an 8-bit +program. Neither of these are built if you select only the 16-bit or 32-bit +libraries. +. +. +.SH "BUILDING SHARED AND STATIC LIBRARIES" +.rs +.sp +The Autotools PCRE2 building process uses \fBlibtool\fP to build both shared +and static libraries by default. You can suppress an unwanted library by adding +one of +.sp + --disable-shared + --disable-static +.sp +to the \fBconfigure\fP command. Setting --disable-shared ensures that PCRE2 +libraries are built as static libraries. The binaries that are then created as +part of the build process (for example, \fBpcre2test\fP and \fBpcre2grep\fP) +are linked statically with one or more PCRE2 libraries, but may also be +dynamically linked with other libraries such as \fBlibc\fP. If you want these +binaries to be fully statically linked, you can set LDFLAGS like this: +.sp +LDFLAGS=--static ./configure --disable-shared +.sp +Note the two hyphens in --static. Of course, this works only if static versions +of all the relevant libraries are available for linking. +. +. +.SH "UNICODE AND UTF SUPPORT" +.rs +.sp +By default, PCRE2 is built with support for Unicode and UTF character strings. +To build it without Unicode support, add +.sp + --disable-unicode +.sp +to the \fBconfigure\fP command. This setting applies to all three libraries. It +is not possible to build one library with Unicode support and another without +in the same configuration. +.P +Of itself, Unicode support does not make PCRE2 treat strings as UTF-8, UTF-16 +or UTF-32. To do that, applications that use the library can set the PCRE2_UTF +option when they call \fBpcre2_compile()\fP to compile a pattern. +Alternatively, patterns may be started with (*UTF) unless the application has +locked this out by setting PCRE2_NEVER_UTF. +.P +UTF support allows the libraries to process character code points up to +0x10ffff in the strings that they handle. Unicode support also gives access to +the Unicode properties of characters, using pattern escapes such as \eP, \ep, +and \eX. Only the general category properties such as \fILu\fP and \fINd\fP, +script names, and some bi-directional properties are supported. Details are +given in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. +.P +Pattern escapes such as \ed and \ew do not by default make use of Unicode +properties. The application can request that they do by setting the PCRE2_UCP +option. Unless the application has set PCRE2_NEVER_UCP, a pattern may also +request this by starting with (*UCP). +. +. +.SH "DISABLING THE USE OF \eC" +.rs +.sp +The \eC escape sequence, which matches a single code unit, even in a UTF mode, +can cause unpredictable behaviour because it may leave the current matching +point in the middle of a multi-code-unit character. The application can lock it +out by setting the PCRE2_NEVER_BACKSLASH_C option when calling +\fBpcre2_compile()\fP. There is also a build-time option +.sp + --enable-never-backslash-C +.sp +(note the upper case C) which locks out the use of \eC entirely. +. +. +.SH "JUST-IN-TIME COMPILER SUPPORT" +.rs +.sp +Just-in-time (JIT) compiler support is included in the build by specifying +.sp + --enable-jit +.sp +This support is available only for certain hardware architectures. If this +option is set for an unsupported architecture, a building error occurs. +If in doubt, use +.sp + --enable-jit=auto +.sp +which enables JIT only if the current hardware is supported. You can check +if JIT is enabled in the configuration summary that is output at the end of a +\fBconfigure\fP run. If you are enabling JIT under SELinux you may also want to +add +.sp + --enable-jit-sealloc +.sp +which enables the use of an execmem allocator in JIT that is compatible with +SELinux. This has no effect if JIT is not enabled. See the +.\" HREF +\fBpcre2jit\fP +.\" +documentation for a discussion of JIT usage. When JIT support is enabled, +\fBpcre2grep\fP automatically makes use of it, unless you add +.sp + --disable-pcre2grep-jit +.sp +to the \fBconfigure\fP command. +. +. +.SH "NEWLINE RECOGNITION" +.rs +.sp +By default, PCRE2 interprets the linefeed (LF) character as indicating the end +of a line. This is the normal newline character on Unix-like systems. You can +compile PCRE2 to use carriage return (CR) instead, by adding +.sp + --enable-newline-is-cr +.sp +to the \fBconfigure\fP command. There is also an --enable-newline-is-lf option, +which explicitly specifies linefeed as the newline character. +.P +Alternatively, you can specify that line endings are to be indicated by the +two-character sequence CRLF (CR immediately followed by LF). If you want this, +add +.sp + --enable-newline-is-crlf +.sp +to the \fBconfigure\fP command. There is a fourth option, specified by +.sp + --enable-newline-is-anycrlf +.sp +which causes PCRE2 to recognize any of the three sequences CR, LF, or CRLF as +indicating a line ending. A fifth option, specified by +.sp + --enable-newline-is-any +.sp +causes PCRE2 to recognize any Unicode newline sequence. The Unicode newline +sequences are the three just mentioned, plus the single characters VT (vertical +tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line +separator, U+2028), and PS (paragraph separator, U+2029). The final option is +.sp + --enable-newline-is-nul +.sp +which causes NUL (binary zero) to be set as the default line-ending character. +.P +Whatever default line ending convention is selected when PCRE2 is built can be +overridden by applications that use the library. At build time it is +recommended to use the standard for your operating system. +. +. +.SH "WHAT \eR MATCHES" +.rs +.sp +By default, the sequence \eR in a pattern matches any Unicode newline sequence, +independently of what has been selected as the line ending sequence. If you +specify +.sp + --enable-bsr-anycrlf +.sp +the default is changed so that \eR matches only CR, LF, or CRLF. Whatever is +selected when PCRE2 is built can be overridden by applications that use the +library. +. +. +.SH "HANDLING VERY LARGE PATTERNS" +.rs +.sp +Within a compiled pattern, offset values are used to point from one part to +another (for example, from an opening parenthesis to an alternation +metacharacter). By default, in the 8-bit and 16-bit libraries, two-byte values +are used for these offsets, leading to a maximum size for a compiled pattern of +around 64 thousand code units. This is sufficient to handle all but the most +gigantic patterns. Nevertheless, some people do want to process truly enormous +patterns, so it is possible to compile PCRE2 to use three-byte or four-byte +offsets by adding a setting such as +.sp + --with-link-size=3 +.sp +to the \fBconfigure\fP command. The value given must be 2, 3, or 4. For the +16-bit library, a value of 3 is rounded up to 4. In these libraries, using +longer offsets slows down the operation of PCRE2 because it has to load +additional data when handling them. For the 32-bit library the value is always +4 and cannot be overridden; the value of --with-link-size is ignored. +. +. +.SH "LIMITING PCRE2 RESOURCE USAGE" +.rs +.sp +The \fBpcre2_match()\fP function increments a counter each time it goes round +its main loop. Putting a limit on this counter controls the amount of computing +resource used by a single call to \fBpcre2_match()\fP. The limit can be changed +at run time, as described in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. The default is 10 million, but this can be changed by adding a +setting such as +.sp + --with-match-limit=500000 +.sp +to the \fBconfigure\fP command. This setting also applies to the +\fBpcre2_dfa_match()\fP matching function, and to JIT matching (though the +counting is done differently). +.P +The \fBpcre2_match()\fP function uses heap memory to record backtracking +points. The more nested backtracking points there are (that is, the deeper the +search tree), the more memory is needed. There is an upper limit, specified in +kibibytes (units of 1024 bytes). This limit can be changed at run time, as +described in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. The default limit (in effect unlimited) is 20 million. You can +change this by a setting such as +.sp + --with-heap-limit=500 +.sp +which limits the amount of heap to 500 KiB. This limit applies only to +interpretive matching in \fBpcre2_match()\fP and \fBpcre2_dfa_match()\fP, which +may also use the heap for internal workspace when processing complicated +patterns. This limit does not apply when JIT (which has its own memory +arrangements) is used. +.P +You can also explicitly limit the depth of nested backtracking in the +\fBpcre2_match()\fP interpreter. This limit defaults to the value that is set +for --with-match-limit. You can set a lower default limit by adding, for +example, +.sp + --with-match-limit-depth=10000 +.sp +to the \fBconfigure\fP command. This value can be overridden at run time. This +depth limit indirectly limits the amount of heap memory that is used, but +because the size of each backtracking "frame" depends on the number of +capturing parentheses in a pattern, the amount of heap that is used before the +limit is reached varies from pattern to pattern. This limit was more useful in +versions before 10.30, where function recursion was used for backtracking. +.P +As well as applying to \fBpcre2_match()\fP, the depth limit also controls +the depth of recursive function calls in \fBpcre2_dfa_match()\fP. These are +used for lookaround assertions, atomic groups, and recursion within patterns. +The limit does not apply to JIT matching. +. +. +.SH "LIMITING VARIABLE-LENGTH LOOKBEHIND ASSERTIONS" +.rs +.sp +Lookbehind assertions in which one or more branches can match a variable number +of characters are supported only if there is a maximum matching length for each +top-level branch. There is a limit to this maximum that defaults to 255 +characters. You can alter this default by a setting such as +.sp + --with-max-varlookbehind=100 +.sp +The limit can be changed at runtime by calling +\fBpcre2_set_max_varlookbehind()\fP. Lookbehind assertions in which every +branch matches a fixed number of characters (not necessarily all the same) are +not constrained by this limit. +. +. +.\" HTML +.SH "CREATING CHARACTER TABLES AT BUILD TIME" +.rs +.sp +PCRE2 uses fixed tables for processing characters whose code points are less +than 256. By default, PCRE2 is built with a set of tables that are distributed +in the file \fIsrc/pcre2_chartables.c.dist\fP. These tables are for ASCII codes +only. If you add +.sp + --enable-rebuild-chartables +.sp +to the \fBconfigure\fP command, the distributed tables are no longer used. +Instead, a program called \fBpcre2_dftables\fP is compiled and run. This +outputs the source for new set of tables, created in the default locale of your +C run-time system. This method of replacing the tables does not work if you are +cross compiling, because \fBpcre2_dftables\fP needs to be run on the local +host and therefore not compiled with the cross compiler. +.P +If you need to create alternative tables when cross compiling, you will have to +do so "by hand". There may also be other reasons for creating tables manually. +To cause \fBpcre2_dftables\fP to be built on the local host, run a normal +compiling command, and then run the program with the output file as its +argument, for example: +.sp + cc src/pcre2_dftables.c -o pcre2_dftables + ./pcre2_dftables src/pcre2_chartables.c +.sp +This builds the tables in the default locale of the local host. If you want to +specify a locale, you must use the -L option: +.sp + LC_ALL=fr_FR ./pcre2_dftables -L src/pcre2_chartables.c +.sp +You can also specify -b (with or without -L). This causes the tables to be +written in binary instead of as source code. A set of binary tables can be +loaded into memory by an application and passed to \fBpcre2_compile()\fP in the +same way as tables created by calling \fBpcre2_maketables()\fP. The tables are +just a string of bytes, independent of hardware characteristics such as +endianness. This means they can be bundled with an application that runs in +different environments, to ensure consistent behaviour. +. +. +.SH "USING EBCDIC CODE" +.rs +.sp +PCRE2 assumes by default that it will run in an environment where the character +code is ASCII or Unicode, which is a superset of ASCII. This is the case for +most computer operating systems. PCRE2 can, however, be compiled to run in an +8-bit EBCDIC environment by adding +.sp + --enable-ebcdic --disable-unicode +.sp +to the \fBconfigure\fP command. This setting implies +--enable-rebuild-chartables. You should only use it if you know that you are in +an EBCDIC environment (for example, an IBM mainframe operating system). +.P +It is not possible to support both EBCDIC and UTF-8 codes in the same version +of the library. Consequently, --enable-unicode and --enable-ebcdic are mutually +exclusive. +.P +The EBCDIC character that corresponds to an ASCII LF is assumed to have the +value 0x15 by default. However, in some EBCDIC environments, 0x25 is used. In +such an environment you should use +.sp + --enable-ebcdic-nl25 +.sp +as well as, or instead of, --enable-ebcdic. The EBCDIC character for CR has the +same value as in ASCII, namely, 0x0d. Whichever of 0x15 and 0x25 is \fInot\fP +chosen as LF is made to correspond to the Unicode NEL character (which, in +Unicode, is 0x85). +.P +The options that select newline behaviour, such as --enable-newline-is-cr, +and equivalent run-time options, refer to these character values in an EBCDIC +environment. +. +. +.SH "PCRE2GREP SUPPORT FOR EXTERNAL SCRIPTS" +.rs +.sp +By default \fBpcre2grep\fP supports the use of callouts with string arguments +within the patterns it is matching. There are two kinds: one that generates +output using local code, and another that calls an external program or script. +If --disable-pcre2grep-callout-fork is added to the \fBconfigure\fP command, +only the first kind of callout is supported; if --disable-pcre2grep-callout is +used, all callouts are completely ignored. For more details of \fBpcre2grep\fP +callouts, see the +.\" HREF +\fBpcre2grep\fP +.\" +documentation. +. +. +.SH "PCRE2GREP OPTIONS FOR COMPRESSED FILE SUPPORT" +.rs +.sp +By default, \fBpcre2grep\fP reads all files as plain text. You can build it so +that it recognizes files whose names end in \fB.gz\fP or \fB.bz2\fP, and reads +them with \fBlibz\fP or \fBlibbz2\fP, respectively, by adding one or both of +.sp + --enable-pcre2grep-libz + --enable-pcre2grep-libbz2 +.sp +to the \fBconfigure\fP command. These options naturally require that the +relevant libraries are installed on your system. Configuration will fail if +they are not. +. +. +.SH "PCRE2GREP BUFFER SIZE" +.rs +.sp +\fBpcre2grep\fP uses an internal buffer to hold a "window" on the file it is +scanning, in order to be able to output "before" and "after" lines when it +finds a match. The default starting size of the buffer is 20KiB. The buffer +itself is three times this size, but because of the way it is used for holding +"before" lines, the longest line that is guaranteed to be processable is the +notional buffer size. If a longer line is encountered, \fBpcre2grep\fP +automatically expands the buffer, up to a specified maximum size, whose default +is 1MiB or the starting size, whichever is the larger. You can change the +default parameter values by adding, for example, +.sp + --with-pcre2grep-bufsize=51200 + --with-pcre2grep-max-bufsize=2097152 +.sp +to the \fBconfigure\fP command. The caller of \fBpcre2grep\fP can override +these values by using --buffer-size and --max-buffer-size on the command line. +. +. +.SH "PCRE2TEST OPTION FOR LIBREADLINE SUPPORT" +.rs +.sp +If you add one of +.sp + --enable-pcre2test-libreadline + --enable-pcre2test-libedit +.sp +to the \fBconfigure\fP command, \fBpcre2test\fP is linked with the +\fBlibreadline\fP or\fBlibedit\fP library, respectively, and when its input is +from a terminal, it reads it using the \fBreadline()\fP function. This provides +line-editing and history facilities. Note that \fBlibreadline\fP is +GPL-licensed, so if you distribute a binary of \fBpcre2test\fP linked in this +way, there may be licensing issues. These can be avoided by linking instead +with \fBlibedit\fP, which has a BSD licence. +.P +Setting --enable-pcre2test-libreadline causes the \fB-lreadline\fP option to be +added to the \fBpcre2test\fP build. In many operating environments with a +system-installed readline library this is sufficient. However, in some +environments (e.g. if an unmodified distribution version of readline is in +use), some extra configuration may be necessary. The INSTALL file for +\fBlibreadline\fP says this: +.sp + "Readline uses the termcap functions, but does not link with + the termcap or curses library itself, allowing applications + which link with readline the to choose an appropriate library." +.sp +If your environment has not been set up so that an appropriate library is +automatically included, you may need to add something like +.sp + LIBS="-ncurses" +.sp +immediately before the \fBconfigure\fP command. +. +. +.SH "INCLUDING DEBUGGING CODE" +.rs +.sp +If you add +.sp + --enable-debug +.sp +to the \fBconfigure\fP command, additional debugging code is included in the +build. This feature is intended for use by the PCRE2 maintainers. +. +. +.SH "DEBUGGING WITH VALGRIND SUPPORT" +.rs +.sp +If you add +.sp + --enable-valgrind +.sp +to the \fBconfigure\fP command, PCRE2 will use valgrind annotations to mark +certain memory regions as unaddressable. This allows it to detect invalid +memory accesses, and is mostly useful for debugging PCRE2 itself. +. +. +.SH "CODE COVERAGE REPORTING" +.rs +.sp +If your C compiler is gcc, you can build a version of PCRE2 that can generate a +code coverage report for its test suite. To enable this, you must install +\fBlcov\fP version 1.6 or above. Then specify +.sp + --enable-coverage +.sp +to the \fBconfigure\fP command and build PCRE2 in the usual way. +.P +Note that using \fBccache\fP (a caching C compiler) is incompatible with code +coverage reporting. If you have configured \fBccache\fP to run automatically +on your system, you must set the environment variable +.sp + CCACHE_DISABLE=1 +.sp +before running \fBmake\fP to build PCRE2, so that \fBccache\fP is not used. +.P +When --enable-coverage is used, the following addition targets are added to the +\fIMakefile\fP: +.sp + make coverage +.sp +This creates a fresh coverage report for the PCRE2 test suite. It is equivalent +to running "make coverage-reset", "make coverage-baseline", "make check", and +then "make coverage-report". +.sp + make coverage-reset +.sp +This zeroes the coverage counters, but does nothing else. +.sp + make coverage-baseline +.sp +This captures baseline coverage information. +.sp + make coverage-report +.sp +This creates the coverage report. +.sp + make coverage-clean-report +.sp +This removes the generated coverage report without cleaning the coverage data +itself. +.sp + make coverage-clean-data +.sp +This removes the captured coverage data without removing the coverage files +created at compile time (*.gcno). +.sp + make coverage-clean +.sp +This cleans all coverage data including the generated coverage report. For more +information about code coverage, see the \fBgcov\fP and \fBlcov\fP +documentation. +. +. +.SH "DISABLING THE Z AND T FORMATTING MODIFIERS" +.rs +.sp +The C99 standard defines formatting modifiers z and t for size_t and +ptrdiff_t values, respectively. By default, PCRE2 uses these modifiers in +environments other than old versions of Microsoft Visual Studio when +__STDC_VERSION__ is defined and has a value greater than or equal to 199901L +(indicating support for C99). +However, there is at least one environment that claims to be C99 but does not +support these modifiers. If +.sp + --disable-percent-zt +.sp +is specified, no use is made of the z or t modifiers. Instead of %td or %zu, +a suitable format is used depending in the size of long for the platform. +. +. +.SH "SUPPORT FOR FUZZERS" +.rs +.sp +There is a special option for use by people who want to run fuzzing tests on +PCRE2: +.sp + --enable-fuzz-support +.sp +At present this applies only to the 8-bit library. If set, it causes an extra +library called libpcre2-fuzzsupport.a to be built, but not installed. This +contains a single function called LLVMFuzzerTestOneInput() whose arguments are +a pointer to a string and the length of the string. When called, this function +tries to compile the string as a pattern, and if that succeeds, to match it. +This is done both with no options and with some random options bits that are +generated from the string. +.P +Setting --enable-fuzz-support also causes a binary called \fBpcre2fuzzcheck\fP +to be created. This is normally run under valgrind or used when PCRE2 is +compiled with address sanitizing enabled. It calls the fuzzing function and +outputs information about what it is doing. The input strings are specified by +arguments: if an argument starts with "=" the rest of it is a literal input +string. Otherwise, it is assumed to be a file name, and the contents of the +file are the test string. +. +. +.SH "OBSOLETE OPTION" +.rs +.sp +In versions of PCRE2 prior to 10.30, there were two ways of handling +backtracking in the \fBpcre2_match()\fP function. The default was to use the +system stack, but if +.sp + --disable-stack-for-recursion +.sp +was set, memory on the heap was used. From release 10.30 onwards this has +changed (the stack is no longer used) and this option now does nothing except +give a warning. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre2api\fP(3), \fBpcre2-config\fP(3). +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 16 April 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2callout.3 b/miniconda3/share/man/man3/pcre2callout.3 new file mode 100644 index 0000000000000000000000000000000000000000..3726fbc403224b4e8f2719e06c2f162792a1bad7 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2callout.3 @@ -0,0 +1,457 @@ +.TH PCRE2CALLOUT 3 "19 January 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.SM +.nf +.B int (*pcre2_callout)(pcre2_callout_block *, void *); +.sp +.B int pcre2_callout_enumerate(const pcre2_code *\fIcode\fP, +.B " int (*\fIcallback\fP)(pcre2_callout_enumerate_block *, void *)," +.B " void *\fIuser_data\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +PCRE2 provides a feature called "callout", which is a means of temporarily +passing control to the caller of PCRE2 in the middle of pattern matching. The +caller of PCRE2 provides an external function by putting its entry point in +a match context (see \fBpcre2_set_callout()\fP in the +.\" HREF +\fBpcre2api\fP +.\" +documentation). +.P +When using the \fBpcre2_substitute()\fP function, an additional callout feature +is available. This does a callout after each change to the subject string and +is described in the +.\" HREF +\fBpcre2api\fP +.\" +documentation; the rest of this document is concerned with callouts during +pattern matching. +.P +Within a regular expression, (?C) indicates a point at which the external +function is to be called. Different callout points can be identified by putting +a number less than 256 after the letter C. The default value is zero. +Alternatively, the argument may be a delimited string. The starting delimiter +must be one of ` ' " ^ % # $ { and the ending delimiter is the same as the +start, except for {, where the ending delimiter is }. If the ending delimiter +is needed within the string, it must be doubled. For example, this pattern has +two callout points: +.sp + (?C1)abc(?C"some ""arbitrary"" text")def +.sp +If the PCRE2_AUTO_CALLOUT option bit is set when a pattern is compiled, PCRE2 +automatically inserts callouts, all with number 255, before each item in the +pattern except for immediately before or after an explicit callout. For +example, if PCRE2_AUTO_CALLOUT is used with the pattern +.sp + A(?C3)B +.sp +it is processed as if it were +.sp + (?C255)A(?C3)B(?C255) +.sp +Here is a more complicated example: +.sp + A(\ed{2}|--) +.sp +With PCRE2_AUTO_CALLOUT, this pattern is processed as if it were +.sp + (?C255)A(?C255)((?C255)\ed{2}(?C255)|(?C255)-(?C255)-(?C255))(?C255) +.sp +Notice that there is a callout before and after each parenthesis and +alternation bar. If the pattern contains a conditional group whose condition is +an assertion, an automatic callout is inserted immediately before the +condition. Such a callout may also be inserted explicitly, for example: +.sp + (?(?C9)(?=a)ab|de) (?(?C%text%)(?!=d)ab|de) +.sp +This applies only to assertion conditions (because they are themselves +independent groups). +.P +Callouts can be useful for tracking the progress of pattern matching. The +.\" HREF +\fBpcre2test\fP +.\" +program has a pattern qualifier (/auto_callout) that sets automatic callouts. +When any callouts are present, the output from \fBpcre2test\fP indicates how +the pattern is being matched. This is useful information when you are trying to +optimize the performance of a particular pattern. +. +. +.SH "MISSING CALLOUTS" +.rs +.sp +You should be aware that, because of optimizations in the way PCRE2 compiles +and matches patterns, callouts sometimes do not happen exactly as you might +expect. +. +. +.SS "Auto-possessification" +.rs +.sp +At compile time, PCRE2 "auto-possessifies" repeated items when it knows that +what follows cannot be part of the repeat. For example, a+[bc] is compiled as +if it were a++[bc]. The \fBpcre2test\fP output when this pattern is compiled +with PCRE2_ANCHORED and PCRE2_AUTO_CALLOUT and then applied to the string +"aaaa" is: +.sp + --->aaaa + +0 ^ a+ + +2 ^ ^ [bc] + No match +.sp +This indicates that when matching [bc] fails, there is no backtracking into a+ +(because it is being treated as a++) and therefore the callouts that would be +taken for the backtracks do not occur. You can disable the auto-possessify +feature by passing PCRE2_NO_AUTO_POSSESS to \fBpcre2_compile()\fP, or starting +the pattern with (*NO_AUTO_POSSESS). In this case, the output changes to this: +.sp + --->aaaa + +0 ^ a+ + +2 ^ ^ [bc] + +2 ^ ^ [bc] + +2 ^ ^ [bc] + +2 ^^ [bc] + No match +.sp +This time, when matching [bc] fails, the matcher backtracks into a+ and tries +again, repeatedly, until a+ itself fails. +. +. +.SS "Automatic .* anchoring" +.rs +.sp +By default, an optimization is applied when .* is the first significant item in +a pattern. If PCRE2_DOTALL is set, so that the dot can match any character, the +pattern is automatically anchored. If PCRE2_DOTALL is not set, a match can +start only after an internal newline or at the beginning of the subject, and +\fBpcre2_compile()\fP remembers this. If a pattern has more than one top-level +branch, automatic anchoring occurs if all branches are anchorable. +.P +This optimization is disabled, however, if .* is in an atomic group or if there +is a backreference to the capture group in which it appears. It is also +disabled if the pattern contains (*PRUNE) or (*SKIP). However, the presence of +callouts does not affect it. +.P +For example, if the pattern .*\ed is compiled with PCRE2_AUTO_CALLOUT and +applied to the string "aa", the \fBpcre2test\fP output is: +.sp + --->aa + +0 ^ .* + +2 ^ ^ \ed + +2 ^^ \ed + +2 ^ \ed + No match +.sp +This shows that all match attempts start at the beginning of the subject. In +other words, the pattern is anchored. You can disable this optimization by +passing PCRE2_NO_DOTSTAR_ANCHOR to \fBpcre2_compile()\fP, or starting the +pattern with (*NO_DOTSTAR_ANCHOR). In this case, the output changes to: +.sp + --->aa + +0 ^ .* + +2 ^ ^ \ed + +2 ^^ \ed + +2 ^ \ed + +0 ^ .* + +2 ^^ \ed + +2 ^ \ed + No match +.sp +This shows more match attempts, starting at the second subject character. +Another optimization, described in the next section, means that there is no +subsequent attempt to match with an empty subject. +. +. +.SS "Other optimizations" +.rs +.sp +Other optimizations that provide fast "no match" results also affect callouts. +For example, if the pattern is +.sp + ab(?C4)cd +.sp +PCRE2 knows that any matching string must contain the letter "d". If the +subject string is "abyz", the lack of "d" means that matching doesn't ever +start, and the callout is never reached. However, with "abyd", though the +result is still no match, the callout is obeyed. +.P +For most patterns PCRE2 also knows the minimum length of a matching string, and +will immediately give a "no match" return without actually running a match if +the subject is not long enough, or, for unanchored patterns, if it has been +scanned far enough. +.P +You can disable these optimizations by passing the PCRE2_NO_START_OPTIMIZE +option to \fBpcre2_compile()\fP, or by starting the pattern with +(*NO_START_OPT). This slows down the matching process, but does ensure that +callouts such as the example above are obeyed. +. +. +.\" HTML +.SH "THE CALLOUT INTERFACE" +.rs +.sp +During matching, when PCRE2 reaches a callout point, if an external function is +provided in the match context, it is called. This applies to both normal, +DFA, and JIT matching. The first argument to the callout function is a pointer +to a \fBpcre2_callout\fP block. The second argument is the void * callout data +that was supplied when the callout was set up by calling +\fBpcre2_set_callout()\fP (see the +.\" HREF +\fBpcre2api\fP +.\" +documentation). The callout block structure contains the following fields, not +necessarily in this order: +.sp + uint32_t \fIversion\fP; + uint32_t \fIcallout_number\fP; + uint32_t \fIcapture_top\fP; + uint32_t \fIcapture_last\fP; + uint32_t \fIcallout_flags\fP; + PCRE2_SIZE *\fIoffset_vector\fP; + PCRE2_SPTR \fImark\fP; + PCRE2_SPTR \fIsubject\fP; + PCRE2_SIZE \fIsubject_length\fP; + PCRE2_SIZE \fIstart_match\fP; + PCRE2_SIZE \fIcurrent_position\fP; + PCRE2_SIZE \fIpattern_position\fP; + PCRE2_SIZE \fInext_item_length\fP; + PCRE2_SIZE \fIcallout_string_offset\fP; + PCRE2_SIZE \fIcallout_string_length\fP; + PCRE2_SPTR \fIcallout_string\fP; +.sp +The \fIversion\fP field contains the version number of the block format. The +current version is 2; the three callout string fields were added for version 1, +and the \fIcallout_flags\fP field for version 2. If you are writing an +application that might use an earlier release of PCRE2, you should check the +version number before accessing any of these fields. The version number will +increase in future if more fields are added, but the intention is never to +remove any of the existing fields. +. +. +.SS "Fields for numerical callouts" +.rs +.sp +For a numerical callout, \fIcallout_string\fP is NULL, and \fIcallout_number\fP +contains the number of the callout, in the range 0-255. This is the number +that follows (?C for callouts that part of the pattern; it is 255 for +automatically generated callouts. +. +. +.SS "Fields for string callouts" +.rs +.sp +For callouts with string arguments, \fIcallout_number\fP is always zero, and +\fIcallout_string\fP points to the string that is contained within the compiled +pattern. Its length is given by \fIcallout_string_length\fP. Duplicated ending +delimiters that were present in the original pattern string have been turned +into single characters, but there is no other processing of the callout string +argument. An additional code unit containing binary zero is present after the +string, but is not included in the length. The delimiter that was used to start +the string is also stored within the pattern, immediately before the string +itself. You can access this delimiter as \fIcallout_string\fP[-1] if you need +it. +.P +The \fIcallout_string_offset\fP field is the code unit offset to the start of +the callout argument string within the original pattern string. This is +provided for the benefit of applications such as script languages that might +need to report errors in the callout string within the pattern. +. +. +.SS "Fields for all callouts" +.rs +.sp +The remaining fields in the callout block are the same for both kinds of +callout. +.P +The \fIoffset_vector\fP field is a pointer to a vector of capturing offsets +(the "ovector"). You may read the elements in this vector, but you must not +change any of them. +.P +For calls to \fBpcre2_match()\fP, the \fIoffset_vector\fP field is not (since +release 10.30) a pointer to the actual ovector that was passed to the matching +function in the match data block. Instead it points to an internal ovector of a +size large enough to hold all possible captured substrings in the pattern. Note +that whenever a recursion or subroutine call within a pattern completes, the +capturing state is reset to what it was before. +.P +The \fIcapture_last\fP field contains the number of the most recently captured +substring, and the \fIcapture_top\fP field contains one more than the number of +the highest numbered captured substring so far. If no substrings have yet been +captured, the value of \fIcapture_last\fP is 0 and the value of +\fIcapture_top\fP is 1. The values of these fields do not always differ by one; +for example, when the callout in the pattern ((a)(b))(?C2) is taken, +\fIcapture_last\fP is 1 but \fIcapture_top\fP is 4. +.P +The contents of ovector[2] to ovector[*2-1] can be inspected in +order to extract substrings that have been matched so far, in the same way as +extracting substrings after a match has completed. The values in ovector[0] and +ovector[1] are always PCRE2_UNSET because the match is by definition not +complete. Substrings that have not been captured but whose numbers are less +than \fIcapture_top\fP also have both of their ovector slots set to +PCRE2_UNSET. +.P +For DFA matching, the \fIoffset_vector\fP field points to the ovector that was +passed to the matching function in the match data block for callouts at the top +level, but to an internal ovector during the processing of pattern recursions, +lookarounds, and atomic groups. However, these ovectors hold no useful +information because \fBpcre2_dfa_match()\fP does not support substring +capturing. The value of \fIcapture_top\fP is always 1 and the value of +\fIcapture_last\fP is always 0 for DFA matching. +.P +The \fIsubject\fP and \fIsubject_length\fP fields contain copies of the values +that were passed to the matching function. +.P +The \fIstart_match\fP field normally contains the offset within the subject at +which the current match attempt started. However, if the escape sequence \eK +has been encountered, this value is changed to reflect the modified starting +point. If the pattern is not anchored, the callout function may be called +several times from the same point in the pattern for different starting points +in the subject. +.P +The \fIcurrent_position\fP field contains the offset within the subject of the +current match pointer. +.P +The \fIpattern_position\fP field contains the offset in the pattern string to +the next item to be matched. +.P +The \fInext_item_length\fP field contains the length of the next item to be +processed in the pattern string. When the callout is at the end of the pattern, +the length is zero. When the callout precedes an opening parenthesis, the +length includes meta characters that follow the parenthesis. For example, in a +callout before an assertion such as (?=ab) the length is 3. For an alternation +bar or a closing parenthesis, the length is one, unless a closing parenthesis +is followed by a quantifier, in which case its length is included. (This +changed in release 10.23. In earlier releases, before an opening parenthesis +the length was that of the entire group, and before an alternation bar or a +closing parenthesis the length was zero.) +.P +The \fIpattern_position\fP and \fInext_item_length\fP fields are intended to +help in distinguishing between different automatic callouts, which all have the +same callout number. However, they are set for all callouts, and are used by +\fBpcre2test\fP to show the next item to be matched when displaying callout +information. +.P +In callouts from \fBpcre2_match()\fP the \fImark\fP field contains a pointer to +the zero-terminated name of the most recently passed (*MARK), (*PRUNE), or +(*THEN) item in the match, or NULL if no such items have been passed. Instances +of (*PRUNE) or (*THEN) without a name do not obliterate a previous (*MARK). In +callouts from the DFA matching function this field always contains NULL. +.P +The \fIcallout_flags\fP field is always zero in callouts from +\fBpcre2_dfa_match()\fP or when JIT is being used. When \fBpcre2_match()\fP +without JIT is used, the following bits may be set: +.sp + PCRE2_CALLOUT_STARTMATCH +.sp +This is set for the first callout after the start of matching for each new +starting position in the subject. +.sp + PCRE2_CALLOUT_BACKTRACK +.sp +This is set if there has been a matching backtrack since the previous callout, +or since the start of matching if this is the first callout from a +\fBpcre2_match()\fP run. +.P +Both bits are set when a backtrack has caused a "bumpalong" to a new starting +position in the subject. Output from \fBpcre2test\fP does not indicate the +presence of these bits unless the \fBcallout_extra\fP modifier is set. +.P +The information in the \fBcallout_flags\fP field is provided so that +applications can track and tell their users how matching with backtracking is +done. This can be useful when trying to optimize patterns, or just to +understand how PCRE2 works. There is no support in \fBpcre2_dfa_match()\fP +because there is no backtracking in DFA matching, and there is no support in +JIT because JIT is all about maximimizing matching performance. In both these +cases the \fBcallout_flags\fP field is always zero. +. +. +.SH "RETURN VALUES FROM CALLOUTS" +.rs +.sp +The external callout function returns an integer to PCRE2. If the value is +zero, matching proceeds as normal. If the value is greater than zero, matching +fails at the current point, but the testing of other matching possibilities +goes ahead, just as if a lookahead assertion had failed. If the value is less +than zero, the match is abandoned, and the matching function returns the +negative value. +.P +Negative values should normally be chosen from the set of PCRE2_ERROR_xxx +values. In particular, PCRE2_ERROR_NOMATCH forces a standard "no match" +failure. The error number PCRE2_ERROR_CALLOUT is reserved for use by callout +functions; it will never be used by PCRE2 itself. +. +. +.SH "CALLOUT ENUMERATION" +.rs +.sp +.nf +.B int pcre2_callout_enumerate(const pcre2_code *\fIcode\fP, +.B " int (*\fIcallback\fP)(pcre2_callout_enumerate_block *, void *)," +.B " void *\fIuser_data\fP);" +.fi +.sp +A script language that supports the use of string arguments in callouts might +like to scan all the callouts in a pattern before running the match. This can +be done by calling \fBpcre2_callout_enumerate()\fP. The first argument is a +pointer to a compiled pattern, the second points to a callback function, and +the third is arbitrary user data. The callback function is called for every +callout in the pattern in the order in which they appear. Its first argument is +a pointer to a callout enumeration block, and its second argument is the +\fIuser_data\fP value that was passed to \fBpcre2_callout_enumerate()\fP. The +data block contains the following fields: +.sp + \fIversion\fP Block version number + \fIpattern_position\fP Offset to next item in pattern + \fInext_item_length\fP Length of next item in pattern + \fIcallout_number\fP Number for numbered callouts + \fIcallout_string_offset\fP Offset to string within pattern + \fIcallout_string_length\fP Length of callout string + \fIcallout_string\fP Points to callout string or is NULL +.sp +The version number is currently 0. It will increase if new fields are ever +added to the block. The remaining fields are the same as their namesakes in the +\fBpcre2_callout\fP block that is used for callouts during matching, as +described +.\" HTML +.\" +above. +.\" +.P +Note that the value of \fIpattern_position\fP is unique for each callout. +However, if a callout occurs inside a group that is quantified with a non-zero +minimum or a fixed maximum, the group is replicated inside the compiled +pattern. For example, a pattern such as /(a){2}/ is compiled as if it were +/(a)(a)/. This means that the callout will be enumerated more than once, but +with the same value for \fIpattern_position\fP in each case. +.P +The callback function should normally return zero. If it returns a non-zero +value, scanning the pattern stops, and that value is returned from +\fBpcre2_callout_enumerate()\fP. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 19 January 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2compat.3 b/miniconda3/share/man/man3/pcre2compat.3 new file mode 100644 index 0000000000000000000000000000000000000000..131f5764b0ec343f54f34283acab88e43500c299 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2compat.3 @@ -0,0 +1,256 @@ +.TH PCRE2COMPAT 3 "02 October 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "DIFFERENCES BETWEEN PCRE2 AND PERL" +.rs +.sp +This document describes some of the known differences in the ways that PCRE2 +and Perl handle regular expressions. The differences described here are with +respect to Perl version 5.38.0, but as both Perl and PCRE2 are continually +changing, the information may at times be out of date. +.P +1. When PCRE2_DOTALL (equivalent to Perl's /s qualifier) is not set, the +behaviour of the '.' metacharacter differs from Perl. In PCRE2, '.' matches the +next character unless it is the start of a newline sequence. This means that, +if the newline setting is CR, CRLF, or NUL, '.' will match the code point LF +(0x0A) in ASCII/Unicode environments, and NL (either 0x15 or 0x25) when using +EBCDIC. In Perl, '.' appears never to match LF, even when 0x0A is not a newline +indicator. +.P +2. PCRE2 has only a subset of Perl's Unicode support. Details of what it does +have are given in the +.\" HREF +\fBpcre2unicode\fP +.\" +page. +.P +3. Like Perl, PCRE2 allows repeat quantifiers on parenthesized assertions, but +they do not mean what you might think. For example, (?!a){3} does not assert +that the next three characters are not "a". It just asserts that the next +character is not "a" three times (in principle; PCRE2 optimizes this to run the +assertion just once). Perl allows some repeat quantifiers on other assertions, +for example, \eb* , but these do not seem to have any use. PCRE2 does not allow +any kind of quantifier on non-lookaround assertions. +.P +4. If a braced quantifier such as {1,2} appears where there is nothing to +repeat (for example, at the start of a branch), PCRE2 raises an error whereas +Perl treats the quantifier characters as literal. +.P +5. Capture groups that occur inside negative lookaround assertions are counted, +but their entries in the offsets vector are set only when a negative assertion +is a condition that has a matching branch (that is, the condition is false). +Perl may set such capture groups in other circumstances. +.P +6. The following Perl escape sequences are not supported: \eF, \el, \eL, \eu, +\eU, and \eN when followed by a character name. \eN on its own, matching a +non-newline character, and \eN{U+dd..}, matching a Unicode code point, are +supported. The escapes that modify the case of following letters are +implemented by Perl's general string-handling and are not part of its pattern +matching engine. If any of these are encountered by PCRE2, an error is +generated by default. However, if either of the PCRE2_ALT_BSUX or +PCRE2_EXTRA_ALT_BSUX options is set, \eU and \eu are interpreted as ECMAScript +interprets them. +.P +7. The Perl escape sequences \ep, \eP, and \eX are supported only if PCRE2 is +built with Unicode support (the default). The properties that can be tested +with \ep and \eP are limited to the general category properties such as Lu and +Nd, the derived properties Any and Lc (synonym L&), script names such as Greek +or Han, Bidi_Class, Bidi_Control, and a few binary properties. Both PCRE2 and +Perl support the Cs (surrogate) property, but in PCRE2 its use is limited. See +the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation for details. The long synonyms for property names that Perl +supports (such as \ep{Letter}) are not supported by PCRE2, nor is it permitted +to prefix any of these properties with "Is". +.P +8. PCRE2 supports the \eQ...\eE escape for quoting substrings. Characters +in between are treated as literals. However, this is slightly different from +Perl in that $ and @ are also handled as literals inside the quotes. In Perl, +they cause variable interpolation (PCRE2 does not have variables). Also, Perl +does "double-quotish backslash interpolation" on any backslashes between \eQ +and \eE which, its documentation says, "may lead to confusing results". PCRE2 +treats a backslash between \eQ and \eE just like any other character. Note the +following examples: +.sp + Pattern PCRE2 matches Perl matches +.sp +.\" JOIN + \eQabc$xyz\eE abc$xyz abc followed by the + contents of $xyz + \eQabc\e$xyz\eE abc\e$xyz abc\e$xyz + \eQabc\eE\e$\eQxyz\eE abc$xyz abc$xyz + \eQA\eB\eE A\eB A\eB + \eQ\e\eE \e \e\eE +.sp +The \eQ...\eE sequence is recognized both inside and outside character classes +by both PCRE2 and Perl. Another difference from Perl is that any appearance of +\eQ or \eE inside what might otherwise be a quantifier causes PCRE2 not to +recognize the sequence as a quantifier. Perl recognizes a quantifier if +(redundantly) either of the numbers is inside \eQ...\eE, but not if the +separating comma is. When not recognized as a quantifier a sequence such as +{\eQ1\eE,2} is treated as the literal string "{1,2}". +.P +9. Fairly obviously, PCRE2 does not support the (?{code}) and (??{code}) +constructions. However, PCRE2 does have a "callout" feature, which allows an +external function to be called during pattern matching. See the +.\" HREF +\fBpcre2callout\fP +.\" +documentation for details. +.P +10. Subroutine calls (whether recursive or not) were treated as atomic groups +up to PCRE2 release 10.23, but from release 10.30 this changed, and +backtracking into subroutine calls is now supported, as in Perl. +.P +11. In PCRE2, if any of the backtracking control verbs are used in a group that +is called as a subroutine (whether or not recursively), their effect is +confined to that group; it does not extend to the surrounding pattern. This is +not always the case in Perl. In particular, if (*THEN) is present in a group +that is called as a subroutine, its action is limited to that group, even if +the group does not contain any | characters. Note that such groups are +processed as anchored at the point where they are tested. PCRE2 also confines +all control verbs within atomic assertions, again including (*THEN) in +assertions with only one branch. +.P +12. If a pattern contains more than one backtracking control verb, the first +one that is backtracked onto acts. For example, in the pattern +A(*COMMIT)B(*PRUNE)C a failure in B triggers (*COMMIT), but a failure in C +triggers (*PRUNE). Perl's behaviour is more complex; in many cases it is the +same as PCRE2, but there are cases where it differs. +.P +13. There are some differences that are concerned with the settings of captured +strings when part of a pattern is repeated. For example, matching "aba" against +the pattern /^(a(b)?)+$/ in Perl leaves $2 unset, but in PCRE2 it is set to +"b". +.P +14. PCRE2's handling of duplicate capture group numbers and names is not as +general as Perl's. This is a consequence of the fact the PCRE2 works internally +just with numbers, using an external table to translate between numbers and +names. In particular, a pattern such as (?|(?A)|(?B)), where the two +capture groups have the same number but different names, is not supported, and +causes an error at compile time. If it were allowed, it would not be possible +to distinguish which group matched, because both names map to capture group +number 1. To avoid this confusing situation, an error is given at compile time. +.P +15. Perl used to recognize comments in some places that PCRE2 does not, for +example, between the ( and ? at the start of a group. If the /x modifier is +set, Perl allowed white space between ( and ? though the latest Perls give an +error (for a while it was just deprecated). There may still be some cases where +Perl behaves differently. +.P +16. Perl, when in warning mode, gives warnings for character classes such as +[A-\ed] or [a-[:digit:]]. It then treats the hyphens as literals. PCRE2 has no +warning features, so it gives an error in these cases because they are almost +certainly user mistakes. +.P +17. In PCRE2, until release 10.45, the upper/lower case character properties Lu +and Ll were not affected when case-independent matching was specified. Perl has +changed in this respect, and PCRE2 has now changed to match. When caseless +matching is in force, Lu, Ll, and Lt (title case) are all treated as Lc (cased +letter). +.P +18. From release 5.32.0, Perl locks out the use of \eK in lookaround +assertions. From release 10.38 PCRE2 does the same by default. However, there +is an option for re-enabling the previous behaviour. When this option is set, +\eK is acted on when it occurs in positive assertions, but is ignored in +negative assertions. +.P +19. PCRE2 provides some extensions to the Perl regular expression facilities. +Perl 5.10 included new features that were not in earlier versions of Perl, some +of which (such as named parentheses) were in PCRE2 for some time before. This +list is with respect to Perl 5.38: +.sp +(a) If PCRE2_DOLLAR_ENDONLY is set and PCRE2_MULTILINE is not set, the $ +meta-character matches only at the very end of the string. +.sp +(b) A backslash followed by a letter with no special meaning is faulted. (Perl +can be made to issue a warning.) +.sp +(c) If PCRE2_UNGREEDY is set, the greediness of the repetition quantifiers is +inverted, that is, by default they are not greedy, but if followed by a +question mark they are. +.sp +(d) PCRE2_ANCHORED can be used at matching time to force a pattern to be tried +only at the first matching position in the subject string. +.sp +(e) The PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY and PCRE2_NOTEMPTY_ATSTART +options have no Perl equivalents. +.sp +(f) The \eR escape sequence can be restricted to match only CR, LF, or CRLF +by the PCRE2_BSR_ANYCRLF option. +.sp +(g) The callout facility is PCRE2-specific. Perl supports codeblocks and +variable interpolation, but not general hooks on every match. +.sp +(h) The partial matching facility is PCRE2-specific. +.sp +(i) The alternative matching function (\fBpcre2_dfa_match()\fP matches in a +different way and is not Perl-compatible. +.sp +(j) PCRE2 recognizes some special sequences such as (*CR) or (*NO_JIT) at +the start of a pattern. These set overall options that cannot be changed within +the pattern. +.sp +(k) PCRE2 supports non-atomic positive lookaround assertions. This is an +extension to the lookaround facilities. The default, Perl-compatible +lookarounds are atomic. +.sp +(l) There are three syntactical items in patterns that can refer to a capturing +group by number: back references such as \eg{2}, subroutine calls such as (?3), +and condition references such as (?(4)...). PCRE2 supports relative group +numbers such as +2 and -4 in all three cases. Perl supports both plus and minus +for subroutine calls, but only minus for back references, and no relative +numbering at all for conditions. +.sp +(m) The scan substring assertion (syntax (*scs:(n)...)) is a PCRE2 extension +that is not available in Perl. +.P +20. Perl has different limits than PCRE2. See the +.\" HREF +\fBpcre2limit\fP +.\" +documentation for details. Perl went with 5.10 from recursion to iteration +keeping the intermediate matches on the heap, which is ~10% slower but does not +fall into any stack-overflow limit. PCRE2 made a similar change at release +10.30, and also has many build-time and run-time customizable limits. +.P +21. Unlike Perl, PCRE2 doesn't have character set modifiers and specially no way +to set characters by context just like Perl's "/d". A regular expression using +PCRE2_UTF and PCRE2_UCP will use similar rules to Perl's "/u"; something closer +to "/a" could be selected by adding other PCRE2_EXTRA_ASCII* options on top. +.P +22. Some recursive patterns that Perl diagnoses as infinite recursions can be +handled by PCRE2, either by the interpreter or the JIT. An example is +/(?:|(?0)abcd)(?(R)|\ez)/, which matches a sequence of any number of repeated +"abcd" substrings at the end of the subject. +.P +23. Both PCRE2 and Perl error when \ex{ escapes are invalid, but Perl tries to +recover and prints a warning if the problem was that an invalid hexadecimal +digit was found, since PCRE2 doesn't have warnings it returns an error instead. +Additionally, Perl accepts \ex{} and generates NUL unlike PCRE2. +.P +24. From release 10.45, PCRE2 gives an error if \ex is not followed by a +hexadecimal digit or a curly bracket. It used to interpret this as the NUL +character. Perl still generates NUL, but warns when in warning mode in most +cases. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 02 October 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2convert.3 b/miniconda3/share/man/man3/pcre2convert.3 new file mode 100644 index 0000000000000000000000000000000000000000..8b7a4e6c1239df5c296dc7d53cab0307919142df --- /dev/null +++ b/miniconda3/share/man/man3/pcre2convert.3 @@ -0,0 +1,164 @@ +.TH PCRE2CONVERT 3 "14 November 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "EXPERIMENTAL PATTERN CONVERSION FUNCTIONS" +.rs +.sp +This document describes a set of functions that can be used to convert +"foreign" patterns into PCRE2 regular expressions. This facility is currently +experimental, and may be changed in future releases. Two kinds of pattern, +globs and POSIX patterns, are supported. +. +. +.SH "THE CONVERT CONTEXT" +.rs +.sp +.nf +.B pcre2_convert_context *pcre2_convert_context_create( +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B pcre2_convert_context *pcre2_convert_context_copy( +.B " pcre2_convert_context *\fIcvcontext\fP);" +.sp +.B void pcre2_convert_context_free(pcre2_convert_context *\fIcvcontext\fP); +.sp +.B int pcre2_set_glob_escape(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIescape_char\fP);" +.sp +.B int pcre2_set_glob_separator(pcre2_convert_context *\fIcvcontext\fP, +.B " uint32_t \fIseparator_char\fP);" +.fi +.sp +A convert context is used to hold parameters that affect the way that pattern +conversion works. Like all PCRE2 contexts, you need to use a context only if +you want to override the defaults. There are the usual create, copy, and free +functions. If custom memory management functions are set in a general context +that is passed to \fBpcre2_convert_context_create()\fP, they are used for all +memory management within the conversion functions. +.P +There are only two parameters in the convert context at present. Both apply +only to glob conversions. The escape character defaults to grave accent under +Windows, otherwise backslash. It can be set to zero, meaning no escape +character, or to any punctuation character with a code point less than 256. +The separator character defaults to backslash under Windows, otherwise forward +slash. It can be set to forward slash, backslash, or dot. +.P +The two setting functions return zero on success, or PCRE2_ERROR_BADDATA if +their second argument is invalid. +. +. +.SH "THE CONVERSION FUNCTION" +.rs +.sp +.nf +.B int pcre2_pattern_convert(PCRE2_SPTR \fIpattern\fP, PCRE2_SIZE \fIlength\fP, +.B " uint32_t \fIoptions\fP, PCRE2_UCHAR **\fIbuffer\fP," +.B " PCRE2_SIZE *\fIblength\fP, pcre2_convert_context *\fIcvcontext\fP);" +.sp +.B void pcre2_converted_pattern_free(PCRE2_UCHAR *\fIconverted_pattern\fP); +.fi +.sp +The first two arguments of \fBpcre2_pattern_convert()\fP define the foreign +pattern that is to be converted. The length may be given as +PCRE2_ZERO_TERMINATED. The \fBoptions\fP argument defines how the pattern is to +be processed. If the input is UTF, the PCRE2_CONVERT_UTF option should be set. +PCRE2_CONVERT_NO_UTF_CHECK may also be set if you are sure the input is valid. +One or more of the glob options, or one of the following POSIX options must be +set to define the type of conversion that is required: +.sp + PCRE2_CONVERT_GLOB + PCRE2_CONVERT_GLOB_NO_WILD_SEPARATOR + PCRE2_CONVERT_GLOB_NO_STARSTAR + PCRE2_CONVERT_POSIX_BASIC + PCRE2_CONVERT_POSIX_EXTENDED +.sp +Details of the conversions are given below. The \fBbuffer\fP and \fBblength\fP +arguments define how the output is handled: +.P +If \fBbuffer\fP is NULL, the function just returns the length of the converted +pattern via \fBblength\fP. This is one less than the length of buffer needed, +because a terminating zero is always added to the output. +.P +If \fBbuffer\fP points to a NULL pointer, an output buffer is obtained using +the allocator in the context or \fBmalloc()\fP if no context is supplied. A +pointer to this buffer is placed in the variable to which \fBbuffer\fP points. +When no longer needed the output buffer must be freed by calling +\fBpcre2_converted_pattern_free()\fP. If this function is called with a NULL +argument, it returns immediately without doing anything. +.P +If \fBbuffer\fP points to a non-NULL pointer, \fBblength\fP must be set to the +actual length of the buffer provided (in code units). +.P +In all cases, after successful conversion, the variable pointed to by +\fBblength\fP is updated to the length actually used (in code units), excluding +the terminating zero that is always added. +.P +If an error occurs, the length (via \fBblength\fP) is set to the offset +within the input pattern where the error was detected. Only gross syntax errors +are caught; there are plenty of errors that will get passed on for +\fBpcre2_compile()\fP to discover. +.P +The return from \fBpcre2_pattern_convert()\fP is zero on success or a non-zero +PCRE2 error code. Note that PCRE2 error codes may be positive or negative: +\fBpcre2_compile()\fP uses mostly positive codes and \fBpcre2_match()\fP +negative ones; \fBpcre2_convert()\fP uses existing codes of both kinds. A +textual error message can be obtained by calling +\fBpcre2_get_error_message()\fP. +. +. +.SH "CONVERTING GLOBS" +.rs +.sp +Globs are used to match file names, and consequently have the concept of a +"path separator", which defaults to backslash under Windows and forward slash +otherwise. If PCRE2_CONVERT_GLOB is set, the wildcards * and ? are not +permitted to match separator characters, but the double-star (**) feature +(which does match separators) is supported. +.P +PCRE2_CONVERT_GLOB_NO_WILD_SEPARATOR matches globs with wildcards allowed to +match separator characters. PCRE2_CONVERT_GLOB_NO_STARSTAR matches globs with +the double-star feature disabled. These options may be given together. +. +. +.SH "CONVERTING POSIX PATTERNS" +.rs +.sp +POSIX defines two kinds of regular expression pattern: basic and extended. +These can be processed by setting PCRE2_CONVERT_POSIX_BASIC or +PCRE2_CONVERT_POSIX_EXTENDED, respectively. +.P +In POSIX patterns, backslash is not special in a character class. Unmatched +closing parentheses are treated as literals. +.P +In basic patterns, ? + | {} and () must be escaped to be recognized +as metacharacters outside a character class. If the first character in the +pattern is * it is treated as a literal. ^ is a metacharacter only at the start +of a branch. +.P +In extended patterns, a backslash not in a character class always +makes the next character literal, whatever it is. There are no backreferences. +.P +Note: POSIX mandates that the longest possible match at the first matching +position must be found. This is not what \fBpcre2_match()\fP does; it yields +the first match that is found. An application can use \fBpcre2_dfa_match()\fP +to find the longest match, but that does not support backreferences (but then +neither do POSIX extended patterns). +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 14 November 2023 +Copyright (c) 1997-2018 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2demo.3 b/miniconda3/share/man/man3/pcre2demo.3 new file mode 100644 index 0000000000000000000000000000000000000000..3f4da3bcab85846365290ecd676b462efe7fce07 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2demo.3 @@ -0,0 +1,526 @@ +.TH PCRE2DEMO 3 "31 August 2021" "PCRE2 10.46" +.\"AUTOMATICALLY GENERATED BY PrepareRelease - do not EDIT! +.SH NAME +PCRE2DEMO - A demonstration C program for PCRE2 +.SH "SOURCE CODE" +.rs +.sp +.\" Start example. +.de EX +. do ds mF \\n[.fam] +. nr mE \\n(.f +. nf +. nh +. do fam C +. ft CW +.. +. +. +.\" End example. +.de EE +. do fam \\*(mF +. ft \\n(mE +. fi +. hy \\n(HY +.. +. +.RS -7 +.EX +/************************************************* +* PCRE2 DEMONSTRATION PROGRAM * +*************************************************/ + +/* This is a demonstration program to illustrate a straightforward way of +using the PCRE2 regular expression library from a C program. See the +pcre2sample documentation for a short discussion ("man pcre2sample" if you have +the PCRE2 man pages installed). PCRE2 is a revised API for the library, and is +incompatible with the original PCRE API. + +There are actually three libraries, each supporting a different code unit +width. This demonstration program uses the 8-bit library. The default is to +process each code unit as a separate character, but if the pattern begins with +"(*UTF)", both it and the subject are treated as UTF-8 strings, where +characters may occupy multiple code units. + +In Unix-like environments, if PCRE2 is installed in your standard system +libraries, you should be able to compile this program using this command: + +cc -Wall pcre2demo.c -lpcre2-8 -o pcre2demo + +If PCRE2 is not installed in a standard place, it is likely to be installed +with support for the pkg-config mechanism. If you have pkg-config, you can +compile this program using this command: + +cc -Wall pcre2demo.c `pkg-config --cflags --libs libpcre2-8` -o pcre2demo + +If you do not have pkg-config, you may have to use something like this: + +cc -Wall pcre2demo.c -I/usr/local/include -L/usr/local/lib \e + -R/usr/local/lib -lpcre2-8 -o pcre2demo + +Replace "/usr/local/include" and "/usr/local/lib" with wherever the include and +library files for PCRE2 are installed on your system. Only some operating +systems (Solaris is one) use the -R option. + +Building under Windows: + +If you want to statically link this program against a non-dll .a file, you must +define PCRE2_STATIC before including pcre2.h, so in this environment, uncomment +the following line. */ + +/* #define PCRE2_STATIC */ + +/* The PCRE2_CODE_UNIT_WIDTH macro must be defined before including pcre2.h. +For a program that uses only one code unit width, setting it to 8, 16, or 32 +makes it possible to use generic function names such as pcre2_compile(). Note +that just changing 8 to 16 (for example) is not sufficient to convert this +program to process 16-bit characters. Even in a fully 16-bit environment, where +string-handling functions such as strcmp() and printf() work with 16-bit +characters, the code for handling the table of named substrings will still need +to be modified. */ + +#define PCRE2_CODE_UNIT_WIDTH 8 + +#include +#include +#include + + +/************************************************************************** +* Here is the program. The API includes the concept of "contexts" for * +* setting up unusual interface requirements for compiling and matching, * +* such as custom memory managers and non-standard newline definitions. * +* This program does not do any of this, so it makes no use of contexts, * +* always passing NULL where a context could be given. * +**************************************************************************/ + +int main(int argc, char **argv) +{ +pcre2_code *re; +PCRE2_SPTR pattern; /* PCRE2_SPTR is a pointer to unsigned code units of */ +PCRE2_SPTR subject; /* the appropriate width (in this case, 8 bits). */ +PCRE2_SPTR name_table; + +int crlf_is_newline; +int errornumber; +int find_all; +int i; +int rc; +int utf8; + +uint32_t option_bits; +uint32_t namecount; +uint32_t name_entry_size; +uint32_t newline; + +PCRE2_SIZE erroroffset; +PCRE2_SIZE *ovector; +PCRE2_SIZE subject_length; + +pcre2_match_data *match_data; + + +/************************************************************************** +* First, sort out the command line. There is only one possible option at * +* the moment, "-g" to request repeated matching to find all occurrences, * +* like Perl's /g option. We set the variable find_all to a non-zero value * +* if the -g option is present. * +**************************************************************************/ + +find_all = 0; +for (i = 1; i < argc; i++) + { + if (strcmp(argv[i], "-g") == 0) find_all = 1; + else if (argv[i][0] == '-') + { + printf("Unrecognised option %s\en", argv[i]); + return 1; + } + else break; + } + +/* After the options, we require exactly two arguments, which are the pattern, +and the subject string. */ + +if (argc - i != 2) + { + printf("Exactly two arguments required: a regex and a subject string\en"); + return 1; + } + +/* Pattern and subject are char arguments, so they can be straightforwardly +cast to PCRE2_SPTR because we are working in 8-bit code units. The subject +length is cast to PCRE2_SIZE for completeness, though PCRE2_SIZE is in fact +defined to be size_t. */ + +pattern = (PCRE2_SPTR)argv[i]; +subject = (PCRE2_SPTR)argv[i+1]; +subject_length = (PCRE2_SIZE)strlen((char *)subject); + + +/************************************************************************* +* Now we are going to compile the regular expression pattern, and handle * +* any errors that are detected. * +*************************************************************************/ + +re = pcre2_compile( + pattern, /* the pattern */ + PCRE2_ZERO_TERMINATED, /* indicates pattern is zero-terminated */ + 0, /* default options */ + &errornumber, /* for error number */ + &erroroffset, /* for error offset */ + NULL); /* use default compile context */ + +/* Compilation failed: print the error message and exit. */ + +if (re == NULL) + { + PCRE2_UCHAR buffer[256]; + pcre2_get_error_message(errornumber, buffer, sizeof(buffer)); + printf("PCRE2 compilation failed at offset %d: %s\en", (int)erroroffset, + buffer); + return 1; + } + + +/************************************************************************* +* If the compilation succeeded, we call PCRE2 again, in order to do a * +* pattern match against the subject string. This does just ONE match. If * +* further matching is needed, it will be done below. Before running the * +* match we must set up a match_data block for holding the result. Using * +* pcre2_match_data_create_from_pattern() ensures that the block is * +* exactly the right size for the number of capturing parentheses in the * +* pattern. If you need to know the actual size of a match_data block as * +* a number of bytes, you can find it like this: * +* * +* PCRE2_SIZE match_data_size = pcre2_get_match_data_size(match_data); * +*************************************************************************/ + +match_data = pcre2_match_data_create_from_pattern(re, NULL); + +/* Now run the match. */ + +rc = pcre2_match( + re, /* the compiled pattern */ + subject, /* the subject string */ + subject_length, /* the length of the subject */ + 0, /* start at offset 0 in the subject */ + 0, /* default options */ + match_data, /* block for storing the result */ + NULL); /* use default match context */ + +/* Matching failed: handle error cases */ + +if (rc < 0) + { + switch(rc) + { + case PCRE2_ERROR_NOMATCH: printf("No match\en"); break; + /* + Handle other special cases if you like + */ + default: printf("Matching error %d\en", rc); break; + } + pcre2_match_data_free(match_data); /* Release memory used for the match */ + pcre2_code_free(re); /* data and the compiled pattern. */ + return 1; + } + +/* Match succeeded. Get a pointer to the output vector, where string offsets +are stored. */ + +ovector = pcre2_get_ovector_pointer(match_data); +printf("Match succeeded at offset %d\en", (int)ovector[0]); + + +/************************************************************************* +* We have found the first match within the subject string. If the output * +* vector wasn't big enough, say so. Then output any substrings that were * +* captured. * +*************************************************************************/ + +/* The output vector wasn't big enough. This should not happen, because we used +pcre2_match_data_create_from_pattern() above. */ + +if (rc == 0) + printf("ovector was not big enough for all the captured substrings\en"); + +/* Since release 10.38 PCRE2 has locked out the use of \eK in lookaround +assertions. However, there is an option to re-enable the old behaviour. If that +is set, it is possible to run patterns such as /(?=.\eK)/ that use \eK in an +assertion to set the start of a match later than its end. In this demonstration +program, we show how to detect this case, but it shouldn't arise because the +option is never set. */ + +if (ovector[0] > ovector[1]) + { + printf("\e\eK was used in an assertion to set the match start after its end.\en" + "From end to start the match was: %.*s\en", (int)(ovector[0] - ovector[1]), + (char *)(subject + ovector[1])); + printf("Run abandoned\en"); + pcre2_match_data_free(match_data); + pcre2_code_free(re); + return 1; + } + +/* Show substrings stored in the output vector by number. Obviously, in a real +application you might want to do things other than print them. */ + +for (i = 0; i < rc; i++) + { + PCRE2_SPTR substring_start = subject + ovector[2*i]; + PCRE2_SIZE substring_length = ovector[2*i+1] - ovector[2*i]; + printf("%2d: %.*s\en", i, (int)substring_length, (char *)substring_start); + } + + +/************************************************************************** +* That concludes the basic part of this demonstration program. We have * +* compiled a pattern, and performed a single match. The code that follows * +* shows first how to access named substrings, and then how to code for * +* repeated matches on the same subject. * +**************************************************************************/ + +/* See if there are any named substrings, and if so, show them by name. First +we have to extract the count of named parentheses from the pattern. */ + +(void)pcre2_pattern_info( + re, /* the compiled pattern */ + PCRE2_INFO_NAMECOUNT, /* get the number of named substrings */ + &namecount); /* where to put the answer */ + +if (namecount == 0) printf("No named substrings\en"); else + { + PCRE2_SPTR tabptr; + printf("Named substrings\en"); + + /* Before we can access the substrings, we must extract the table for + translating names to numbers, and the size of each entry in the table. */ + + (void)pcre2_pattern_info( + re, /* the compiled pattern */ + PCRE2_INFO_NAMETABLE, /* address of the table */ + &name_table); /* where to put the answer */ + + (void)pcre2_pattern_info( + re, /* the compiled pattern */ + PCRE2_INFO_NAMEENTRYSIZE, /* size of each entry in the table */ + &name_entry_size); /* where to put the answer */ + + /* Now we can scan the table and, for each entry, print the number, the name, + and the substring itself. In the 8-bit library the number is held in two + bytes, most significant first. */ + + tabptr = name_table; + for (i = 0; i < namecount; i++) + { + int n = (tabptr[0] << 8) | tabptr[1]; + printf("(%d) %*s: %.*s\en", n, name_entry_size - 3, tabptr + 2, + (int)(ovector[2*n+1] - ovector[2*n]), subject + ovector[2*n]); + tabptr += name_entry_size; + } + } + + +/************************************************************************* +* If the "-g" option was given on the command line, we want to continue * +* to search for additional matches in the subject string, in a similar * +* way to the /g option in Perl. This turns out to be trickier than you * +* might think because of the possibility of matching an empty string. * +* What happens is as follows: * +* * +* If the previous match was NOT for an empty string, we can just start * +* the next match at the end of the previous one. * +* * +* If the previous match WAS for an empty string, we can't do that, as it * +* would lead to an infinite loop. Instead, a call of pcre2_match() is * +* made with the PCRE2_NOTEMPTY_ATSTART and PCRE2_ANCHORED flags set. The * +* first of these tells PCRE2 that an empty string at the start of the * +* subject is not a valid match; other possibilities must be tried. The * +* second flag restricts PCRE2 to one match attempt at the initial string * +* position. If this match succeeds, an alternative to the empty string * +* match has been found, and we can print it and proceed round the loop, * +* advancing by the length of whatever was found. If this match does not * +* succeed, we still stay in the loop, advancing by just one character. * +* In UTF-8 mode, which can be set by (*UTF) in the pattern, this may be * +* more than one byte. * +* * +* However, there is a complication concerned with newlines. When the * +* newline convention is such that CRLF is a valid newline, we must * +* advance by two characters rather than one. The newline convention can * +* be set in the regex by (*CR), etc.; if not, we must find the default. * +*************************************************************************/ + +if (!find_all) /* Check for -g */ + { + pcre2_match_data_free(match_data); /* Release the memory that was used */ + pcre2_code_free(re); /* for the match data and the pattern. */ + return 0; /* Exit the program. */ + } + +/* Before running the loop, check for UTF-8 and whether CRLF is a valid newline +sequence. First, find the options with which the regex was compiled and extract +the UTF state. */ + +(void)pcre2_pattern_info(re, PCRE2_INFO_ALLOPTIONS, &option_bits); +utf8 = (option_bits & PCRE2_UTF) != 0; + +/* Now find the newline convention and see whether CRLF is a valid newline +sequence. */ + +(void)pcre2_pattern_info(re, PCRE2_INFO_NEWLINE, &newline); +crlf_is_newline = newline == PCRE2_NEWLINE_ANY || + newline == PCRE2_NEWLINE_CRLF || + newline == PCRE2_NEWLINE_ANYCRLF; + +/* Loop for second and subsequent matches */ + +for (;;) + { + uint32_t options = 0; /* Normally no options */ + PCRE2_SIZE start_offset = ovector[1]; /* Start at end of previous match */ + + /* If the previous match was for an empty string, we are finished if we are + at the end of the subject. Otherwise, arrange to run another match at the + same point to see if a non-empty match can be found. */ + + if (ovector[0] == ovector[1]) + { + if (ovector[0] == subject_length) break; + options = PCRE2_NOTEMPTY_ATSTART | PCRE2_ANCHORED; + } + + /* If the previous match was not an empty string, there is one tricky case to + consider. If a pattern contains \eK within a lookbehind assertion at the + start, the end of the matched string can be at the offset where the match + started. Without special action, this leads to a loop that keeps on matching + the same substring. We must detect this case and arrange to move the start on + by one character. The pcre2_get_startchar() function returns the starting + offset that was passed to pcre2_match(). */ + + else + { + PCRE2_SIZE startchar = pcre2_get_startchar(match_data); + if (start_offset <= startchar) + { + if (startchar >= subject_length) break; /* Reached end of subject. */ + start_offset = startchar + 1; /* Advance by one character. */ + if (utf8) /* If UTF-8, it may be more */ + { /* than one code unit. */ + for (; start_offset < subject_length; start_offset++) + if ((subject[start_offset] & 0xc0) != 0x80) break; + } + } + } + + /* Run the next matching operation */ + + rc = pcre2_match( + re, /* the compiled pattern */ + subject, /* the subject string */ + subject_length, /* the length of the subject */ + start_offset, /* starting offset in the subject */ + options, /* options */ + match_data, /* block for storing the result */ + NULL); /* use default match context */ + + /* This time, a result of NOMATCH isn't an error. If the value in "options" + is zero, it just means we have found all possible matches, so the loop ends. + Otherwise, it means we have failed to find a non-empty-string match at a + point where there was a previous empty-string match. In this case, we do what + Perl does: advance the matching position by one character, and continue. We + do this by setting the "end of previous match" offset, because that is picked + up at the top of the loop as the point at which to start again. + + There are two complications: (a) When CRLF is a valid newline sequence, and + the current position is just before it, advance by an extra byte. (b) + Otherwise we must ensure that we skip an entire UTF character if we are in + UTF mode. */ + + if (rc == PCRE2_ERROR_NOMATCH) + { + if (options == 0) break; /* All matches found */ + ovector[1] = start_offset + 1; /* Advance one code unit */ + if (crlf_is_newline && /* If CRLF is a newline & */ + start_offset < subject_length - 1 && /* we are at CRLF, */ + subject[start_offset] == '\er' && + subject[start_offset + 1] == '\en') + ovector[1] += 1; /* Advance by one more. */ + else if (utf8) /* Otherwise, ensure we */ + { /* advance a whole UTF-8 */ + while (ovector[1] < subject_length) /* character. */ + { + if ((subject[ovector[1]] & 0xc0) != 0x80) break; + ovector[1] += 1; + } + } + continue; /* Go round the loop again */ + } + + /* Other matching errors are not recoverable. */ + + if (rc < 0) + { + printf("Matching error %d\en", rc); + pcre2_match_data_free(match_data); + pcre2_code_free(re); + return 1; + } + + /* Match succeeded */ + + printf("\enMatch succeeded again at offset %d\en", (int)ovector[0]); + + /* The match succeeded, but the output vector wasn't big enough. This + should not happen. */ + + if (rc == 0) + printf("ovector was not big enough for all the captured substrings\en"); + + /* We must guard against patterns such as /(?=.\eK)/ that use \eK in an + assertion to set the start of a match later than its end. In this + demonstration program, we just detect this case and give up. */ + + if (ovector[0] > ovector[1]) + { + printf("\e\eK was used in an assertion to set the match start after its end.\en" + "From end to start the match was: %.*s\en", (int)(ovector[0] - ovector[1]), + (char *)(subject + ovector[1])); + printf("Run abandoned\en"); + pcre2_match_data_free(match_data); + pcre2_code_free(re); + return 1; + } + + /* As before, show substrings stored in the output vector by number, and then + also any named substrings. */ + + for (i = 0; i < rc; i++) + { + PCRE2_SPTR substring_start = subject + ovector[2*i]; + size_t substring_length = ovector[2*i+1] - ovector[2*i]; + printf("%2d: %.*s\en", i, (int)substring_length, (char *)substring_start); + } + + if (namecount == 0) printf("No named substrings\en"); else + { + PCRE2_SPTR tabptr = name_table; + printf("Named substrings\en"); + for (i = 0; i < namecount; i++) + { + int n = (tabptr[0] << 8) | tabptr[1]; + printf("(%d) %*s: %.*s\en", n, name_entry_size - 3, tabptr + 2, + (int)(ovector[2*n+1] - ovector[2*n]), subject + ovector[2*n]); + tabptr += name_entry_size; + } + } + } /* End of loop to find second and subsequent matches */ + +printf("\en"); +pcre2_match_data_free(match_data); +pcre2_code_free(re); +return 0; +} + +/* End of pcre2demo.c */ +.EE diff --git a/miniconda3/share/man/man3/pcre2jit.3 b/miniconda3/share/man/man3/pcre2jit.3 new file mode 100644 index 0000000000000000000000000000000000000000..009a5ff7b36b86128b5bd20041ca52c53716cad4 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2jit.3 @@ -0,0 +1,489 @@ +.TH PCRE2JIT 3 "22 August 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 JUST-IN-TIME COMPILER SUPPORT" +.rs +.sp +Just-in-time compiling is a heavyweight optimization that can greatly speed up +pattern matching. However, it comes at the cost of extra processing before the +match is performed, so it is of most benefit when the same pattern is going to +be matched many times. This does not necessarily mean many calls of a matching +function; if the pattern is not anchored, matching attempts may take place many +times at various positions in the subject, even for a single call. Therefore, +if the subject string is very long, it may still pay to use JIT even for +one-off matches. JIT support is available for all of the 8-bit, 16-bit and +32-bit PCRE2 libraries. +.P +JIT support applies only to the traditional Perl-compatible matching function. +It does not apply when the DFA matching function is being used. The code for +JIT support was written by Zoltan Herczeg. +. +. +.SH "AVAILABILITY OF JIT SUPPORT" +.rs +.sp +JIT support is an optional feature of PCRE2. The "configure" option +--enable-jit (or equivalent CMake option) must be set when PCRE2 is built if +you want to use JIT. The support is limited to the following hardware +platforms: +.sp + ARM 32-bit (v7, and Thumb2) + ARM 64-bit + IBM s390x 64 bit + Intel x86 32-bit and 64-bit + LoongArch 64 bit + MIPS 32-bit and 64-bit + Power PC 32-bit and 64-bit + RISC-V 32-bit and 64-bit +.sp +If --enable-jit is set on an unsupported platform, compilation fails. +.P +A client program can tell if JIT support has been compiled by calling +\fBpcre2_config()\fP with the PCRE2_CONFIG_JIT option. The result is one if +PCRE2 was built with JIT support, and zero otherwise. However, having the JIT +code available does not guarantee that it will be used for any particular +match. One reason for this is that there are a number of options and pattern +items that are +.\" HTML +.\" +not supported by JIT +.\" +(see below). Another reason is that in some environments JIT is unable to get +executable memory in which to build its compiled code. The only guarantee from +\fBpcre2_config()\fP is that if it returns zero, JIT will definitely \fInot\fP +be used. +.P +As of release 10.45 there is a more informative way to test for JIT support. If +\fBpcre2_compile_jit()\fP is called with the single option PCRE2_JIT_TEST_ALLOC +it returns zero if JIT is available and has a working allocator. Otherwise it +returns PCRE2_ERROR_NOMEMORY if JIT is available but cannot allocate executable +memory, or PCRE2_ERROR_JIT_UNSUPPORTED if JIT support is not compiled. The +code argument is ignored, so it can be a NULL value. +.P +A simple program does not need to check availability in order to use JIT when +possible. The API is implemented in a way that falls back to the interpretive +code if JIT is not available or cannot be used for a given match. For programs +that need the best possible performance, there is a +.\" HTML +.\" +"fast path" +.\" +API that is JIT-specific. +. +. +.SH "SIMPLE USE OF JIT" +.rs +.sp +To make use of the JIT support in the simplest way, all you have to do is to +call \fBpcre2_jit_compile()\fP after successfully compiling a pattern with +\fBpcre2_compile()\fP. This function has two arguments: the first is the +compiled pattern pointer that was returned by \fBpcre2_compile()\fP, and the +second is zero or more of the following option bits: PCRE2_JIT_COMPLETE, +PCRE2_JIT_PARTIAL_HARD, or PCRE2_JIT_PARTIAL_SOFT. +.P +If JIT support is not available, a call to \fBpcre2_jit_compile()\fP does +nothing and returns PCRE2_ERROR_JIT_BADOPTION. Otherwise, the compiled pattern +is passed to the JIT compiler, which turns it into machine code that executes +much faster than the normal interpretive code, but yields exactly the same +results. The returned value from \fBpcre2_jit_compile()\fP is zero on success, +or a negative error code. +.P +There is a limit to the size of pattern that JIT supports, imposed by the size +of machine stack that it uses. The exact rules are not documented because they +may change at any time, in particular, when new optimizations are introduced. +If a pattern is too big, a call to \fBpcre2_jit_compile()\fP returns +PCRE2_ERROR_NOMEMORY. +.P +PCRE2_JIT_COMPLETE requests the JIT compiler to generate code for complete +matches. If you want to run partial matches using the PCRE2_PARTIAL_HARD or +PCRE2_PARTIAL_SOFT options of \fBpcre2_match()\fP, you should set one or both +of the other options as well as, or instead of PCRE2_JIT_COMPLETE. The JIT +compiler generates different optimized code for each of the three modes +(normal, soft partial, hard partial). When \fBpcre2_match()\fP is called, the +appropriate code is run if it is available. Otherwise, the pattern is matched +using interpretive code. +.P +You can call \fBpcre2_jit_compile()\fP multiple times for the same compiled +pattern. It does nothing if it has previously compiled code for any of the +option bits. For example, you can call it once with PCRE2_JIT_COMPLETE and +(perhaps later, when you find you need partial matching) again with +PCRE2_JIT_COMPLETE and PCRE2_JIT_PARTIAL_HARD. This time it will ignore +PCRE2_JIT_COMPLETE and just compile code for partial matching. If +\fBpcre2_jit_compile()\fP is called with no option bits set, it immediately +returns zero. This is an alternative way of testing whether JIT support has +been compiled. +.P +At present, it is not possible to free JIT compiled code except when the entire +compiled pattern is freed by calling \fBpcre2_code_free()\fP. +.P +In some circumstances you may need to call additional functions. These are +described in the section entitled +.\" HTML +.\" +"Controlling the JIT stack" +.\" +below. +.P +There are some \fBpcre2_match()\fP options that are not supported by JIT, and +there are also some pattern items that JIT cannot handle. Details are given +.\" HTML +.\" +below. +.\" +In both cases, matching automatically falls back to the interpretive code. If +you want to know whether JIT was actually used for a particular match, you +should arrange for a JIT callback function to be set up as described in the +section entitled +.\" HTML +.\" +"Controlling the JIT stack" +.\" +below, even if you do not need to supply a non-default JIT stack. Such a +callback function is called whenever JIT code is about to be obeyed. If the +match-time options are not right for JIT execution, the callback function is +not obeyed. +.P +If the JIT compiler finds an unsupported item, no JIT data is generated. You +can find out if JIT compilation was successful for a compiled pattern by +calling \fBpcre2_pattern_info()\fP with the PCRE2_INFO_JITSIZE option. A +non-zero result means that JIT compilation was successful. A result of 0 means +that JIT support is not available, or the pattern was not processed by +\fBpcre2_jit_compile()\fP, or the JIT compiler was not able to handle the +pattern. Successful JIT compilation does not, however, guarantee the use of JIT +at match time because there are some match time options that are not supported +by JIT. +. +. +.SH "MATCHING SUBJECTS CONTAINING INVALID UTF" +.rs +.sp +When a pattern is compiled with the PCRE2_UTF option, subject strings are +normally expected to be a valid sequence of UTF code units. By default, this is +checked at the start of matching and an error is generated if invalid UTF is +detected. The PCRE2_NO_UTF_CHECK option can be passed to \fBpcre2_match()\fP to +skip the check (for improved performance) if you are sure that a subject string +is valid. If this option is used with an invalid string, the result is +undefined. The calling program may crash or loop or otherwise misbehave. +.P +However, a way of running matches on strings that may contain invalid UTF +sequences is available. Calling \fBpcre2_compile()\fP with the +PCRE2_MATCH_INVALID_UTF option has two effects: it tells the interpreter in +\fBpcre2_match()\fP to support invalid UTF, and, if \fBpcre2_jit_compile()\fP +is subsequently called, the compiled JIT code also supports invalid UTF. +Details of how this support works, in both the JIT and the interpretive cases, +is given in the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. +.P +There is also an obsolete option for \fBpcre2_jit_compile()\fP called +PCRE2_JIT_INVALID_UTF, which currently exists only for backward compatibility. +It is superseded by the \fBpcre2_compile()\fP option PCRE2_MATCH_INVALID_UTF +and should no longer be used. It may be removed in future. +. +. +.\" HTML +.SH "UNSUPPORTED OPTIONS AND PATTERN ITEMS" +.rs +.sp +The \fBpcre2_match()\fP options that are supported for JIT matching are +PCRE2_COPY_MATCHED_SUBJECT, PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY, +PCRE2_NOTEMPTY_ATSTART, PCRE2_NO_UTF_CHECK, PCRE2_PARTIAL_HARD, and +PCRE2_PARTIAL_SOFT. The PCRE2_ANCHORED and PCRE2_ENDANCHORED options are not +supported at match time. +.P +If the PCRE2_NO_JIT option is passed to \fBpcre2_match()\fP it disables the +use of JIT, forcing matching by the interpreter code. +.P +The only unsupported pattern items are \eC (match a single data unit) when +running in a UTF mode, and a callout immediately before an assertion condition +in a conditional group. +. +. +.SH "RETURN VALUES FROM JIT MATCHING" +.rs +.sp +When a pattern is matched using JIT, the return values are the same as those +given by the interpretive \fBpcre2_match()\fP code, with the addition of one +new error code: PCRE2_ERROR_JIT_STACKLIMIT. This means that the memory used for +the JIT stack was insufficient. See +.\" HTML +.\" +"Controlling the JIT stack" +.\" +below for a discussion of JIT stack usage. +.P +The error code PCRE2_ERROR_MATCHLIMIT is returned by the JIT code if searching +a very large pattern tree goes on for too long, as it is in the same +circumstance when JIT is not used, but the details of exactly what is counted +are not the same. The PCRE2_ERROR_DEPTHLIMIT error code is never returned +when JIT matching is used. +. +. +.\" HTML +.SH "CONTROLLING THE JIT STACK" +.rs +.sp +When the compiled JIT code runs, it needs a block of memory to use as a stack. +By default, it uses 32KiB on the machine stack. However, some large or +complicated patterns need more than this. The error PCRE2_ERROR_JIT_STACKLIMIT +is given when there is not enough stack. Three functions are provided for +managing blocks of memory for use as JIT stacks. There is further discussion +about the use of JIT stacks in the section entitled +.\" HTML +.\" +"JIT stack FAQ" +.\" +below. +.P +The \fBpcre2_jit_stack_create()\fP function creates a JIT stack. Its arguments +are a starting size, a maximum size, and a general context (for memory +allocation functions, or NULL for standard memory allocation). It returns a +pointer to an opaque structure of type \fBpcre2_jit_stack\fP, or NULL if there +is an error. The \fBpcre2_jit_stack_free()\fP function is used to free a stack +that is no longer needed. If its argument is NULL, this function returns +immediately, without doing anything. (For the technically minded: the address +space is allocated by mmap or VirtualAlloc.) A maximum stack size of 512KiB to +1MiB should be more than enough for any pattern. +.P +The \fBpcre2_jit_stack_assign()\fP function specifies which stack JIT code +should use. Its arguments are as follows: +.sp + pcre2_match_context *mcontext + pcre2_jit_callback callback + void *data +.sp +The first argument is a pointer to a match context. When this is subsequently +passed to a matching function, its information determines which JIT stack is +used. If this argument is NULL, the function returns immediately, without doing +anything. There are three cases for the values of the other two options: +.sp + (1) If \fIcallback\fP is NULL and \fIdata\fP is NULL, an internal 32KiB block + on the machine stack is used. This is the default when a match + context is created. +.sp + (2) If \fIcallback\fP is NULL and \fIdata\fP is not NULL, \fIdata\fP must be + a pointer to a valid JIT stack, the result of calling + \fBpcre2_jit_stack_create()\fP. +.sp + (3) If \fIcallback\fP is not NULL, it must point to a function that is + called with \fIdata\fP as an argument at the start of matching, in + order to set up a JIT stack. If the return from the callback + function is NULL, the internal 32KiB stack is used; otherwise the + return value must be a valid JIT stack, the result of calling + \fBpcre2_jit_stack_create()\fP. +.sp +A callback function is obeyed whenever JIT code is about to be run; it is not +obeyed when \fBpcre2_match()\fP is called with options that are incompatible +for JIT matching. A callback function can therefore be used to determine +whether a match operation was executed by JIT or by the interpreter. +.P +You may safely use the same JIT stack for more than one pattern (either by +assigning directly or by callback), as long as the patterns are matched +sequentially in the same thread. Currently, the only way to set up +non-sequential matches in one thread is to use callouts: if a callout function +starts another match, that match must use a different JIT stack to the one used +for currently suspended match(es). +.P +In a multithread application, if you do not specify a JIT stack, or if you +assign or pass back NULL from a callback, that is thread-safe, because each +thread has its own machine stack. However, if you assign or pass back a +non-NULL JIT stack, this must be a different stack for each thread so that the +application is thread-safe. +.P +Strictly speaking, even more is allowed. You can assign the same non-NULL stack +to a match context that is used by any number of patterns, as long as they are +not used for matching by multiple threads at the same time. For example, you +could use the same stack in all compiled patterns, with a global mutex in the +callback to wait until the stack is available for use. However, this is an +inefficient solution, and not recommended. +.P +This is a suggestion for how a multithreaded program that needs to set up +non-default JIT stacks might operate: +.sp + During thread initialization + thread_local_var = pcre2_jit_stack_create(...) +.sp + During thread exit + pcre2_jit_stack_free(thread_local_var) +.sp + Use a one-line callback function + return thread_local_var +.sp +All the functions described in this section do nothing if JIT is not available. +. +. +.\" HTML +.SH "JIT STACK FAQ" +.rs +.sp +(1) Why do we need JIT stacks? +.sp +PCRE2 (and JIT) is a recursive, depth-first engine, so it needs a stack where +the local data of the current node is pushed before checking its child nodes. +Allocating real machine stack on some platforms is difficult. For example, the +stack chain needs to be updated every time if we extend the stack on PowerPC. +Although it is possible, its updating time overhead decreases performance. So +we do the recursion in memory. +.P +(2) Why don't we simply allocate blocks of memory with \fBmalloc()\fP? +.sp +Modern operating systems have a nice feature: they can reserve an address space +instead of allocating memory. We can safely allocate memory pages inside this +address space, so the stack could grow without moving memory data (this is +important because of pointers). Thus we can allocate 1MiB address space, and +use only a single memory page (usually 4KiB) if that is enough. However, we can +still grow up to 1MiB anytime if needed. +.P +(3) Who "owns" a JIT stack? +.sp +The owner of the stack is the user program, not the JIT studied pattern or +anything else. The user program must ensure that if a stack is being used by +\fBpcre2_match()\fP, (that is, it is assigned to a match context that is passed +to the pattern currently running), that stack must not be used by any other +threads (to avoid overwriting the same memory area). The best practice for +multithreaded programs is to allocate a stack for each thread, and return this +stack through the JIT callback function. +.P +(4) When should a JIT stack be freed? +.sp +You can free a JIT stack at any time, as long as it will not be used by +\fBpcre2_match()\fP again. When you assign the stack to a match context, only a +pointer is set. There is no reference counting or any other magic. You can free +compiled patterns, contexts, and stacks in any order, anytime. +Just \fIdo not\fP call \fBpcre2_match()\fP with a match context pointing to an +already freed stack, as that will cause SEGFAULT. (Also, do not free a stack +currently used by \fBpcre2_match()\fP in another thread). You can also replace +the stack in a context at any time when it is not in use. You should free the +previous stack before assigning a replacement. +.P +(5) Should I allocate/free a stack every time before/after calling +\fBpcre2_match()\fP? +.sp +No, because this is too costly in terms of resources. However, you could +implement some clever idea which release the stack if it is not used in let's +say two minutes. The JIT callback can help to achieve this without keeping a +list of patterns. +.P +(6) OK, the stack is for long term memory allocation. But what happens if a +pattern causes stack overflow with a stack of 1MiB? Is that 1MiB kept until the +stack is freed? +.sp +Especially on embedded systems, it might be a good idea to release memory +sometimes without freeing the stack. There is no API for this at the moment. +Probably a function call which returns with the currently allocated memory for +any stack and another which allows releasing memory (shrinking the stack) would +be a good idea if someone needs this. +.P +(7) This is too much of a headache. Isn't there any better solution for JIT +stack handling? +.sp +No, thanks to Windows. If POSIX threads were used everywhere, we could throw +out this complicated API. +. +. +.SH "FREEING JIT SPECULATIVE MEMORY" +.rs +.sp +.nf +.B void pcre2_jit_free_unused_memory(pcre2_general_context *\fIgcontext\fP); +.fi +.P +The JIT executable allocator does not free all memory when it is possible. It +expects new allocations, and keeps some free memory around to improve +allocation speed. However, in low memory conditions, it might be better to free +all possible memory. You can cause this to happen by calling +pcre2_jit_free_unused_memory(). Its argument is a general context, for custom +memory management, or NULL for standard memory management. +. +. +.SH "EXAMPLE CODE" +.rs +.sp +This is a single-threaded example that specifies a JIT stack without using a +callback. A real program should include error checking after all the function +calls. +.sp + int rc; + pcre2_code *re; + pcre2_match_data *match_data; + pcre2_match_context *mcontext; + pcre2_jit_stack *jit_stack; +.sp + re = pcre2_compile(pattern, PCRE2_ZERO_TERMINATED, 0, + &errornumber, &erroffset, NULL); + rc = pcre2_jit_compile(re, PCRE2_JIT_COMPLETE); + mcontext = pcre2_match_context_create(NULL); + jit_stack = pcre2_jit_stack_create(32*1024, 512*1024, NULL); + pcre2_jit_stack_assign(mcontext, NULL, jit_stack); + match_data = pcre2_match_data_create(re, 10); + rc = pcre2_match(re, subject, length, 0, 0, match_data, mcontext); + /* Process result */ +.sp + pcre2_code_free(re); + pcre2_match_data_free(match_data); + pcre2_match_context_free(mcontext); + pcre2_jit_stack_free(jit_stack); +.sp +. +. +.\" HTML +.SH "JIT FAST PATH API" +.rs +.sp +Because the API described above falls back to interpreted matching when JIT is +not available, it is convenient for programs that are written for general use +in many environments. However, calling JIT via \fBpcre2_match()\fP does have a +performance impact. Programs that are written for use where JIT is known to be +available, and which need the best possible performance, can instead use a +"fast path" API to call JIT matching directly instead of calling +\fBpcre2_match()\fP (obviously only for patterns that have been successfully +processed by \fBpcre2_jit_compile()\fP). +.P +The fast path function is called \fBpcre2_jit_match()\fP, and it takes exactly +the same arguments as \fBpcre2_match()\fP. However, the subject string must be +specified with a length; PCRE2_ZERO_TERMINATED is not supported. Unsupported +option bits (for example, PCRE2_ANCHORED and PCRE2_ENDANCHORED) are ignored, as +is the PCRE2_NO_JIT option. The return values are also the same as for +\fBpcre2_match()\fP, plus PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial +or complete) is requested that was not compiled. +.P +When you call \fBpcre2_match()\fP, as well as testing for invalid options, a +number of other sanity checks are performed on the arguments. For example, if +the subject pointer is NULL but the length is non-zero, an immediate error is +given. Also, unless PCRE2_NO_UTF_CHECK is set, a UTF subject string is tested +for validity. In the interests of speed, these checks do not happen on the JIT +fast path. If invalid UTF data is passed when PCRE2_MATCH_INVALID_UTF was not +set for \fBpcre2_compile()\fP, the result is undefined. The program may crash +or loop or give wrong results. In the absence of PCRE2_MATCH_INVALID_UTF you +should call \fBpcre2_jit_match()\fP in UTF mode only if you are sure the +subject is valid. +.P +Bypassing the sanity checks and the \fBpcre2_match()\fP wrapping can give +speedups of more than 10%. +. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre2api\fP(3), \fBpcre2unicode\fP(3) +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel (FAQ by Zoltan Herczeg) +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 22 August 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2limits.3 b/miniconda3/share/man/man3/pcre2limits.3 new file mode 100644 index 0000000000000000000000000000000000000000..f51a7a8f577f52ebcb5d467fa52d385207e87887 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2limits.3 @@ -0,0 +1,81 @@ +.TH PCRE2LIMITS 3 "16 August 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "SIZE AND OTHER LIMITATIONS" +.rs +.sp +There are some size limitations in PCRE2 but it is hoped that they will never +in practice be relevant. +.P +The maximum size of a compiled pattern is approximately 64 thousand code units +for the 8-bit and 16-bit libraries if PCRE2 is compiled with the default +internal linkage size, which is 2 bytes for these libraries. If you want to +process regular expressions that are truly enormous, you can compile PCRE2 with +an internal linkage size of 3 or 4 (when building the 16-bit library, 3 is +rounded up to 4). See the \fBREADME\fP file in the source distribution and the +.\" HREF +\fBpcre2build\fP +.\" +documentation for details. In these cases the limit is substantially larger. +However, the speed of execution is slower. In the 32-bit library, the internal +linkage size is always 4. +.P +The maximum length of a source pattern string is essentially unlimited; it is +the largest number a PCRE2_SIZE variable can hold. However, the program that +calls \fBpcre2_compile()\fP can specify a smaller limit. +.P +The maximum length (in code units) of a subject string is one less than the +largest number a PCRE2_SIZE variable can hold. PCRE2_SIZE is an unsigned +integer type, usually defined as size_t. Its maximum value (that is +~(PCRE2_SIZE)0) is reserved as a special indicator for zero-terminated strings +and unset offsets. +.P +All values in repeating quantifiers must be less than 65536. +.P +There are two different limits that apply to branches of lookbehind assertions. +If every branch in such an assertion matches a fixed number of characters, +the maximum length of any branch is 65535 characters. If any branch matches a +variable number of characters, then the maximum matching length for every +branch is limited. The default limit is set at compile time, defaulting to 255, +but can be changed by the calling program. +.P +There is no limit to the number of parenthesized groups, but there can be no +more than 65535 capture groups, and there is a limit to the depth of nesting of +parenthesized subpatterns of all kinds. This is imposed in order to limit the +amount of system stack used at compile time. The default limit can be specified +when PCRE2 is built; if not, the default is set to 250. An application can +change this limit by calling pcre2_set_parens_nest_limit() to set the limit in +a compile context. +.P +The maximum length of name for a named capture group is 32 code units, and the +maximum number of such groups is 10000. +.P +The maximum length of a name in a (*MARK), (*PRUNE), (*SKIP), or (*THEN) verb +is 255 code units for the 8-bit library and 65535 code units for the 16-bit and +32-bit libraries. +.P +The maximum length of a string argument to a callout is the largest number a +32-bit unsigned integer can hold. +.P +The maximum amount of heap memory used for matching is controlled by the heap +limit, which can be set in a pattern or in a match context. The default is a +very large number, effectively unlimited. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 16 August 2023 +Copyright (c) 1997-2023 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2matching.3 b/miniconda3/share/man/man3/pcre2matching.3 new file mode 100644 index 0000000000000000000000000000000000000000..18ee75ac82e2928ead8478b72e9258bcbfb255b1 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2matching.3 @@ -0,0 +1,228 @@ +.TH PCRE2MATCHING 3 "30 August 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 MATCHING ALGORITHMS" +.rs +.sp +This document describes the two different algorithms that are available in +PCRE2 for matching a compiled regular expression against a given subject +string. The "standard" algorithm is the one provided by the \fBpcre2_match()\fP +function. This works in the same as Perl's matching function, and provides a +Perl-compatible matching operation. The just-in-time (JIT) optimization that is +described in the +.\" HREF +\fBpcre2jit\fP +.\" +documentation is compatible with this function. +.P +An alternative algorithm is provided by the \fBpcre2_dfa_match()\fP function; +it operates in a different way, and is not Perl-compatible. This alternative +has advantages and disadvantages compared with the standard algorithm, and +these are described below. +.P +When there is only one possible way in which a given subject string can match a +pattern, the two algorithms give the same answer. A difference arises, however, +when there are multiple possibilities. For example, if the anchored pattern +.sp + ^<.*> +.sp +is matched against the string +.sp + +.sp +there are three possible answers. The standard algorithm finds only one of +them, whereas the alternative algorithm finds all three. +. +. +.SH "REGULAR EXPRESSIONS AS TREES" +.rs +.sp +The set of strings that are matched by a regular expression can be represented +as a tree structure. An unlimited repetition in the pattern makes the tree of +infinite size, but it is still a tree. Matching the pattern to a given subject +string (from a given starting point) can be thought of as a search of the tree. +There are two ways to search a tree: depth-first and breadth-first, and these +correspond to the two matching algorithms provided by PCRE2. +. +. +.SH "THE STANDARD MATCHING ALGORITHM" +.rs +.sp +In the terminology of Jeffrey Friedl's book "Mastering Regular Expressions", +the standard algorithm is an "NFA algorithm". It conducts a depth-first search +of the pattern tree. That is, it proceeds along a single path through the tree, +checking that the subject matches what is required. When there is a mismatch, +the algorithm tries any alternatives at the current point, and if they all +fail, it backs up to the previous branch point in the tree, and tries the next +alternative branch at that level. This often involves backing up (moving to the +left) in the subject string as well. The order in which repetition branches are +tried is controlled by the greedy or ungreedy nature of the quantifier. +.P +If a leaf node is reached, a matching string has been found, and at that point +the algorithm stops. Thus, if there is more than one possible match, this +algorithm returns the first one that it finds. Whether this is the shortest, +the longest, or some intermediate length depends on the way the alternations +and the greedy or ungreedy repetition quantifiers are specified in the +pattern. +.P +Because it ends up with a single path through the tree, it is relatively +straightforward for this algorithm to keep track of the substrings that are +matched by portions of the pattern in parentheses. This provides support for +capturing parentheses and backreferences. +. +. +.SH "THE ALTERNATIVE MATCHING ALGORITHM" +.rs +.sp +This algorithm conducts a breadth-first search of the tree. Starting from the +first matching point in the subject, it scans the subject string from left to +right, once, character by character, and as it does this, it remembers all the +paths through the tree that represent valid matches. In Friedl's terminology, +this is a kind of "DFA algorithm", though it is not implemented as a +traditional finite state machine (it keeps multiple states active +simultaneously). +.P +Although the general principle of this matching algorithm is that it scans the +subject string only once, without backtracking, there is one exception: when a +lookaround assertion is encountered, the characters following or preceding the +current point have to be independently inspected. +.P +The scan continues until either the end of the subject is reached, or there are +no more unterminated paths. At this point, terminated paths represent the +different matching possibilities (if there are none, the match has failed). +Thus, if there is more than one possible match, this algorithm finds all of +them, and in particular, it finds the longest. The matches are returned in +the output vector in decreasing order of length. There is an option to stop the +algorithm after the first match (which is necessarily the shortest) is found. +.P +Note that the size of vector needed to contain all the results depends on the +number of simultaneous matches, not on the number of capturing parentheses in +the pattern. Using \fBpcre2_match_data_create_from_pattern()\fP to create the +match data block is therefore not advisable when doing DFA matching. +.P +Note also that all the matches that are found start at the same point in the +subject. If the pattern +.sp + cat(er(pillar)?)? +.sp +is matched against the string "the caterpillar catchment", the result is the +three strings "caterpillar", "cater", and "cat" that start at the fifth +character of the subject. The algorithm does not automatically move on to find +matches that start at later positions. +.P +PCRE2's "auto-possessification" optimization usually applies to character +repeats at the end of a pattern (as well as internally). For example, the +pattern "a\ed+" is compiled as if it were "a\ed++" because there is no point +even considering the possibility of backtracking into the repeated digits. For +DFA matching, this means that only one possible match is found. If you really +do want multiple matches in such cases, either use an ungreedy repeat +("a\ed+?") or set the PCRE2_NO_AUTO_POSSESS option when compiling. +.P +There are a number of features of PCRE2 regular expressions that are not +supported or behave differently in the alternative matching function. Those +that are not supported cause an error if encountered. +.P +1. Because the algorithm finds all possible matches, the greedy or ungreedy +nature of repetition quantifiers is not relevant (though it may affect +auto-possessification, as just described). During matching, greedy and ungreedy +quantifiers are treated in exactly the same way. However, possessive +quantifiers can make a difference when what follows could also match what is +quantified, for example in a pattern like this: +.sp + ^a++\ew! +.sp +This pattern matches "aaab!" but not "aaa!", which would be matched by a +non-possessive quantifier. Similarly, if an atomic group is present, it is +matched as if it were a standalone pattern at the current point, and the +longest match is then "locked in" for the rest of the overall pattern. +.P +2. When dealing with multiple paths through the tree simultaneously, it is not +straightforward to keep track of captured substrings for the different matching +possibilities, and PCRE2's implementation of this algorithm does not attempt to +do this. This means that no captured substrings are available. +.P +3. Because no substrings are captured, a number of related features are not +available: +.sp +(a) Backreferences; +.sp +(b) Conditional expressions that use a backreference as the condition or test +for a specific group recursion; +.sp +(c) Script runs; +.sp +(d) Scan substring assertions. +.P +4. Because many paths through the tree may be active, the \eK escape sequence, +which resets the start of the match when encountered (but may be on some paths +and not on others), is not supported. +.P +5. Callouts are supported, but the value of the \fIcapture_top\fP field is +always 1, and the value of the \fIcapture_last\fP field is always 0. +.P +6. The \eC escape sequence, which (in the standard algorithm) always matches a +single code unit, even in a UTF mode, is not supported in UTF modes because +the alternative algorithm moves through the subject string one character (not +code unit) at a time, for all active paths through the tree. +.P +7. Except for (*FAIL), the backtracking control verbs such as (*PRUNE) are not +supported. (*FAIL) is supported, and behaves like a failing negative assertion. +.P +8. The PCRE2_MATCH_INVALID_UTF option for \fBpcre2_compile()\fP is not +supported by \fBpcre2_dfa_match()\fP. +. +. +.SH "ADVANTAGES OF THE ALTERNATIVE ALGORITHM" +.rs +.sp +The main advantage of the alternative algorithm is that all possible matches +(at a single point in the subject) are automatically found, and in particular, +the longest match is found. To find more than one match at the same point using +the standard algorithm, you have to do kludgy things with callouts. +.P +Partial matching is possible with this algorithm, though it has some +limitations. The +.\" HREF +\fBpcre2partial\fP +.\" +documentation gives details of partial matching and discusses multi-segment +matching. +. +. +.SH "DISADVANTAGES OF THE ALTERNATIVE ALGORITHM" +.rs +.sp +The alternative algorithm suffers from a number of disadvantages: +.P +1. It is substantially slower than the standard algorithm. This is partly +because it has to search for all possible matches, but is also because it is +less susceptible to optimization. +.P +2. Capturing parentheses and other features such as backreferences that rely on +them are not supported. +.P +3. Matching within invalid UTF strings is not supported. +.P +4. Although atomic groups are supported, their use does not provide the +performance advantage that it does for the standard algorithm. +.P +5. JIT optimization is not supported. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 30 August 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2partial.3 b/miniconda3/share/man/man3/pcre2partial.3 new file mode 100644 index 0000000000000000000000000000000000000000..0674f71cacb72ec60f1f3a9e0bb66ed4f4a9d048 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2partial.3 @@ -0,0 +1,373 @@ +.TH PCRE2PARTIAL 3 "27 November 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PARTIAL MATCHING IN PCRE2" +.rs +.sp +In normal use of PCRE2, if there is a match up to the end of a subject string, +but more characters are needed to match the entire pattern, PCRE2_ERROR_NOMATCH +is returned, just like any other failing match. There are circumstances where +it might be helpful to distinguish this "partial match" case. +.P +One example is an application where the subject string is very long, and not +all available at once. The requirement here is to be able to do the matching +segment by segment, but special action is needed when a matched substring spans +the boundary between two segments. +.P +Another example is checking a user input string as it is typed, to ensure that +it conforms to a required format. Invalid characters can be immediately +diagnosed and rejected, giving instant feedback. +.P +Partial matching is a PCRE2-specific feature; it is not Perl-compatible. It is +requested by setting one of the PCRE2_PARTIAL_HARD or PCRE2_PARTIAL_SOFT +options when calling a matching function. The difference between the two +options is whether or not a partial match is preferred to an alternative +complete match, though the details differ between the two types of matching +function. If both options are set, PCRE2_PARTIAL_HARD takes precedence. +.P +If you want to use partial matching with just-in-time optimized code, as well +as setting a partial match option for the matching function, you must also call +\fBpcre2_jit_compile()\fP with one or both of these options: +.sp + PCRE2_JIT_PARTIAL_HARD + PCRE2_JIT_PARTIAL_SOFT +.sp +PCRE2_JIT_COMPLETE should also be set if you are going to run non-partial +matches on the same pattern. Separate code is compiled for each mode. If the +appropriate JIT mode has not been compiled, interpretive matching code is used. +.P +Setting a partial matching option disables two of PCRE2's standard +optimization hints. PCRE2 remembers the last literal code unit in a pattern, +and abandons matching immediately if it is not present in the subject string. +This optimization cannot be used for a subject string that might match only +partially. PCRE2 also remembers a minimum length of a matching string, and does +not bother to run the matching function on shorter strings. This optimization +is also disabled for partial matching. +. +. +.SH "REQUIREMENTS FOR A PARTIAL MATCH" +.rs +.sp +A possible partial match occurs during matching when the end of the subject +string is reached successfully, but either more characters are needed to +complete the match, or the addition of more characters might change what is +matched. +.P +Example 1: if the pattern is /abc/ and the subject is "ab", more characters are +definitely needed to complete a match. In this case both hard and soft matching +options yield a partial match. +.P +Example 2: if the pattern is /ab+/ and the subject is "ab", a complete match +can be found, but the addition of more characters might change what is +matched. In this case, only PCRE2_PARTIAL_HARD returns a partial match; +PCRE2_PARTIAL_SOFT returns the complete match. +.P +On reaching the end of the subject, when PCRE2_PARTIAL_HARD is set, if the next +pattern item is \ez, \eZ, \eb, \eB, or $ there is always a partial match. +Otherwise, for both options, the next pattern item must be one that inspects a +character, and at least one of the following must be true: +.P +(1) At least one character has already been inspected. An inspected character +need not form part of the final matched string; lookbehind assertions and the +\eK escape sequence provide ways of inspecting characters before the start of a +matched string. +.P +(2) The pattern contains one or more lookbehind assertions. This condition +exists in case there is a lookbehind that inspects characters before the start +of the match. +.P +(3) There is a special case when the whole pattern can match an empty string. +When the starting point is at the end of the subject, the empty string match is +a possibility, and if PCRE2_PARTIAL_SOFT is set and neither of the above +conditions is true, it is returned. However, because adding more characters +might result in a non-empty match, PCRE2_PARTIAL_HARD returns a partial match, +which in this case means "there is going to be a match at this point, but until +some more characters are added, we do not know if it will be an empty string or +something longer". +. +. +. +.SH "PARTIAL MATCHING USING pcre2_match()" +.rs +.sp +When a partial matching option is set, the result of calling +\fBpcre2_match()\fP can be one of the following: +.TP 2 +\fBA successful match\fP +A complete match has been found, starting and ending within this subject. +.TP +\fBPCRE2_ERROR_NOMATCH\fP +No match can start anywhere in this subject. +.TP +\fBPCRE2_ERROR_PARTIAL\fP +Adding more characters may result in a complete match that uses one or more +characters from the end of this subject. +.P +When a partial match is returned, the first two elements in the ovector point +to the portion of the subject that was matched, but the values in the rest of +the ovector are undefined. The appearance of \eK in the pattern has no effect +for a partial match. Consider this pattern: +.sp + /abc\eK123/ +.sp +If it is matched against "456abc123xyz" the result is a complete match, and the +ovector defines the matched string as "123", because \eK resets the "start of +match" point. However, if a partial match is requested and the subject string +is "456abc12", a partial match is found for the string "abc12", because all +these characters are needed for a subsequent re-match with additional +characters. +.P +If there is more than one partial match, the first one that was found provides +the data that is returned. Consider this pattern: +.sp + /123\ew+X|dogY/ +.sp +If this is matched against the subject string "abc123dog", both alternatives +fail to match, but the end of the subject is reached during matching, so +PCRE2_ERROR_PARTIAL is returned. The offsets are set to 3 and 9, identifying +"123dog" as the first partial match. (In this example, there are two partial +matches, because "dog" on its own partially matches the second alternative.) +. +. +.SS "How a partial match is processed by pcre2_match()" +.rs +.sp +What happens when a partial match is identified depends on which of the two +partial matching options is set. +.P +If PCRE2_PARTIAL_HARD is set, PCRE2_ERROR_PARTIAL is returned as soon as a +partial match is found, without continuing to search for possible complete +matches. This option is "hard" because it prefers an earlier partial match over +a later complete match. For this reason, the assumption is made that the end of +the supplied subject string is not the true end of the available data, which is +why \ez, \eZ, \eb, \eB, and $ always give a partial match. +.P +If PCRE2_PARTIAL_SOFT is set, the partial match is remembered, but matching +continues as normal, and other alternatives in the pattern are tried. If no +complete match can be found, PCRE2_ERROR_PARTIAL is returned instead of +PCRE2_ERROR_NOMATCH. This option is "soft" because it prefers a complete match +over a partial match. All the various matching items in a pattern behave as if +the subject string is potentially complete; \ez, \eZ, and $ match at the end of +the subject, as normal, and for \eb and \eB the end of the subject is treated +as a non-alphanumeric. +.P +The difference between the two partial matching options can be illustrated by a +pattern such as: +.sp + /dog(sbody)?/ +.sp +This matches either "dog" or "dogsbody", greedily (that is, it prefers the +longer string if possible). If it is matched against the string "dog" with +PCRE2_PARTIAL_SOFT, it yields a complete match for "dog". However, if +PCRE2_PARTIAL_HARD is set, the result is PCRE2_ERROR_PARTIAL. On the other +hand, if the pattern is made ungreedy the result is different: +.sp + /dog(sbody)??/ +.sp +In this case the result is always a complete match because that is found first, +and matching never continues after finding a complete match. It might be easier +to follow this explanation by thinking of the two patterns like this: +.sp + /dog(sbody)?/ is the same as /dogsbody|dog/ + /dog(sbody)??/ is the same as /dog|dogsbody/ +.sp +The second pattern will never match "dogsbody", because it will always find the +shorter match first. +. +. +.SS "Example of partial matching using pcre2test" +.rs +.sp +The \fBpcre2test\fP data modifiers \fBpartial_hard\fP (or \fBph\fP) and +\fBpartial_soft\fP (or \fBps\fP) set PCRE2_PARTIAL_HARD and PCRE2_PARTIAL_SOFT, +respectively, when calling \fBpcre2_match()\fP. Here is a run of +\fBpcre2test\fP using a pattern that matches the whole subject in the form of a +date: +.sp + re> /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/ + data> 25dec3\e=ph + Partial match: 23dec3 + data> 3ju\e=ph + Partial match: 3ju + data> 3juj\e=ph + No match +.sp +This example gives the same results for both hard and soft partial matching +options. Here is an example where there is a difference: +.sp + re> /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/ + data> 25jun04\e=ps + 0: 25jun04 + 1: jun + data> 25jun04\e=ph + Partial match: 25jun04 +.sp +With PCRE2_PARTIAL_SOFT, the subject is matched completely. For +PCRE2_PARTIAL_HARD, however, the subject is assumed not to be complete, so +there is only a partial match. +. +. +. +.SH "MULTI-SEGMENT MATCHING WITH pcre2_match()" +.rs +.sp +PCRE was not originally designed with multi-segment matching in mind. However, +over time, features (including partial matching) that make multi-segment +matching possible have been added. A very long string can be searched segment +by segment by calling \fBpcre2_match()\fP repeatedly, with the aim of achieving +the same results that would happen if the entire string was available for +searching all the time. Normally, the strings that are being sought are much +shorter than each individual segment, and are in the middle of very long +strings, so the pattern is normally not anchored. +.P +Special logic must be implemented to handle a matched substring that spans a +segment boundary. PCRE2_PARTIAL_HARD should be used, because it returns a +partial match at the end of a segment whenever there is the possibility of +changing the match by adding more characters. The PCRE2_NOTBOL option should +also be set for all but the first segment. +.P +When a partial match occurs, the next segment must be added to the current +subject and the match re-run, using the \fIstartoffset\fP argument of +\fBpcre2_match()\fP to begin at the point where the partial match started. +For example: +.sp + re> /\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed/ + data> ...the date is 23ja\e=ph + Partial match: 23ja + data> ...the date is 23jan19 and on that day...\e=offset=15 + 0: 23jan19 + 1: jan +.sp +Note the use of the \fBoffset\fP modifier to start the new match where the +partial match was found. In this example, the next segment was added to the one +in which the partial match was found. This is the most straightforward +approach, typically using a memory buffer that is twice the size of each +segment. After a partial match, the first half of the buffer is discarded, the +second half is moved to the start of the buffer, and a new segment is added +before repeating the match as in the example above. After a no match, the +entire buffer can be discarded. +.P +If there are memory constraints, you may want to discard text that precedes a +partial match before adding the next segment. Unfortunately, this is not at +present straightforward. In cases such as the above, where the pattern does not +contain any lookbehinds, it is sufficient to retain only the partially matched +substring. However, if the pattern contains a lookbehind assertion, characters +that precede the start of the partial match may have been inspected during the +matching process. When \fBpcre2test\fP displays a partial match, it indicates +these characters with '<' if the \fBallusedtext\fP modifier is set: +.sp + re> "(?<=123)abc" + data> xx123ab\e=ph,allusedtext + Partial match: 123ab + <<< +.sp +However, the \fBallusedtext\fP modifier is not available for JIT matching, +because JIT matching does not record the first (or last) consulted characters. +For this reason, this information is not available via the API. It is therefore +not possible in general to obtain the exact number of characters that must be +retained in order to get the right match result. If you cannot retain the +entire segment, you must find some heuristic way of choosing. +.P +If you know the approximate length of the matching substrings, you can use that +to decide how much text to retain. The only lookbehind information that is +currently available via the API is the length of the longest individual +lookbehind in a pattern, but this can be misleading if there are nested +lookbehinds. The value returned by calling \fBpcre2_pattern_info()\fP with the +PCRE2_INFO_MAXLOOKBEHIND option is the maximum number of characters (not code +units) that any individual lookbehind moves back when it is processed. A +pattern such as "(?<=(? /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/ + data> 23ja\e=dfa,ps + Partial match: 23ja + data> n05\e=dfa,dfa_restart + 0: n05 +.sp +The first call has "23ja" as the subject, and requests partial matching; the +second call has "n05" as the subject for the continued (restarted) match. +Notice that when the match is complete, only the last part is shown; PCRE2 does +not retain the previously partially-matched string. It is up to the calling +program to do that if it needs to. This means that, for an unanchored pattern, +if a continued match fails, it is not possible to try again at a new starting +point. All this facility is capable of doing is continuing with the previous +match attempt. For example, consider this pattern: +.sp + 1234|3789 +.sp +If the first part of the subject is "ABC123", a partial match of the first +alternative is found at offset 3. There is no partial match for the second +alternative, because such a match does not start at the same point in the +subject string. Attempting to continue with the string "7890" does not yield a +match because only those alternatives that match at one point in the subject +are remembered. Depending on the application, this may or may not be what you +want. +.P +If you do want to allow for starting again at the next character, one way of +doing it is to retain some or all of the segment and try a new complete match, +as described for \fBpcre2_match()\fP above. Another possibility is to work with +two buffers. If a partial match at offset \fIn\fP in the first buffer is +followed by "no match" when PCRE2_DFA_RESTART is used on the second buffer, you +can then try a new match starting at offset \fIn+1\fP in the first buffer. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 27 November 2024 +Copyright (c) 1997-2019 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2pattern.3 b/miniconda3/share/man/man3/pcre2pattern.3 new file mode 100644 index 0000000000000000000000000000000000000000..242ba7a13b00c38b5d387d5210b9945897fac0ad --- /dev/null +++ b/miniconda3/share/man/man3/pcre2pattern.3 @@ -0,0 +1,4191 @@ +.TH PCRE2PATTERN 3 "27 November 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 REGULAR EXPRESSION DETAILS" +.rs +.sp +The syntax and semantics of the regular expressions that are supported by PCRE2 +are described in detail below. There is a quick-reference syntax summary in the +.\" HREF +\fBpcre2syntax\fP +.\" +page. PCRE2 tries to match Perl syntax and semantics as closely as it can. +PCRE2 also supports some alternative regular expression syntax that does not +conflict with the Perl syntax in order to provide some compatibility with +regular expressions in Python, .NET, and Oniguruma. There are in addition some +options that enable alternative syntax and semantics that are not the same as +in Perl. +.P +Perl's regular expressions are described in its own documentation, and regular +expressions in general are covered in a number of books, some of which have +copious examples. Jeffrey Friedl's "Mastering Regular Expressions", published +by O'Reilly, covers regular expressions in great detail. This description of +PCRE2's regular expressions is intended as reference material. +.P +This document discusses the regular expression patterns that are supported by +PCRE2 when its main matching function, \fBpcre2_match()\fP, is used. PCRE2 also +has an alternative matching function, \fBpcre2_dfa_match()\fP, which matches +using a different algorithm that is not Perl-compatible. Some of the features +discussed below are not available when DFA matching is used. The advantages and +disadvantages of the alternative function, and how it differs from the normal +function, are discussed in the +.\" HREF +\fBpcre2matching\fP +.\" +page. +. +. +.SH "EBCDIC CHARACTER CODES" +.rs +.sp +Most computers use ASCII or Unicode for encoding characters, and PCRE2 assumes +this by default. However, it can be compiled to run in an environment that uses +the EBCDIC code, which is the case for some IBM mainframe operating systems. In +the sections below, character code values are ASCII or Unicode; in an EBCDIC +environment these characters may have different code values, and there are no +code points greater than 255. Differences in behaviour when PCRE2 is running in +an EBCDIC environment are described in the section +.\" HTML +.\" +"EBCDIC environments" +.\" +below, which you can ignore unless you really are in an EBCDIC environment. +. +. +.SH "SPECIAL START-OF-PATTERN ITEMS" +.rs +.sp +A number of options that can be passed to \fBpcre2_compile()\fP can also be set +by special items at the start of a pattern. These are not Perl-compatible, but +are provided to make these options accessible to pattern writers who are not +able to change the program that processes the pattern. Any number of these +items may appear, but they must all be together right at the start of the +pattern string, and the letters must be in upper case. +. +. +.SS "UTF support" +.rs +.sp +In the 8-bit and 16-bit PCRE2 libraries, characters may be coded either as +single code units, or as multiple UTF-8 or UTF-16 code units. UTF-32 can be +specified for the 32-bit library, in which case it constrains the character +values to valid Unicode code points. To process UTF strings, PCRE2 must be +built to include Unicode support (which is the default). When using UTF strings +you must either call the compiling function with one or both of the PCRE2_UTF +or PCRE2_MATCH_INVALID_UTF options, or the pattern must start with the special +sequence (*UTF), which is equivalent to setting the relevant PCRE2_UTF. How +setting a UTF mode affects pattern matching is mentioned in several places +below. There is also a summary of features in the +.\" HREF +\fBpcre2unicode\fP +.\" +page. +.P +Some applications that allow their users to supply patterns may wish to +restrict them to non-UTF data for security reasons. If the PCRE2_NEVER_UTF +option is passed to \fBpcre2_compile()\fP, (*UTF) is not allowed, and its +appearance in a pattern causes an error. +. +. +.SS "Unicode property support" +.rs +.sp +Another special sequence that may appear at the start of a pattern is (*UCP). +This has the same effect as setting the PCRE2_UCP option: it causes sequences +such as \ed and \ew to use Unicode properties to determine character types, +instead of recognizing only characters with codes less than 256 via a lookup +table. If also causes upper/lower casing operations to use Unicode properties +for characters with code points greater than 127, even when UTF is not set. +These behaviours can be changed within the pattern; see the section entitled +.\" HTML +.\" +"Internal Option Setting" +.\" +below. +.P +Some applications that allow their users to supply patterns may wish to +restrict them for security reasons. If the PCRE2_NEVER_UCP option is passed to +\fBpcre2_compile()\fP, (*UCP) is not allowed, and its appearance in a pattern +causes an error. +. +. +.SS "Locking out empty string matching" +.rs +.sp +Starting a pattern with (*NOTEMPTY) or (*NOTEMPTY_ATSTART) has the same effect +as passing the PCRE2_NOTEMPTY or PCRE2_NOTEMPTY_ATSTART option to whichever +matching function is subsequently called to match the pattern. These options +lock out the matching of empty strings, either entirely, or only at the start +of the subject. +. +. +.SS "Disabling auto-possessification" +.rs +.sp +If a pattern starts with (*NO_AUTO_POSSESS), it has the same effect as setting +the PCRE2_NO_AUTO_POSSESS option, or calling \fBpcre2_set_optimize()\fP with +a PCRE2_AUTO_POSSESS_OFF directive. This stops PCRE2 from making quantifiers +possessive when what follows cannot match the repeated item. For example, by +default a+b is treated as a++b. For more details, see the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +. +. +.SS "Disabling start-up optimizations" +.rs +.sp +If a pattern starts with (*NO_START_OPT), it has the same effect as setting the +PCRE2_NO_START_OPTIMIZE option, or calling \fBpcre2_set_optimize()\fP with +a PCRE2_START_OPTIMIZE_OFF directive. This disables several optimizations for +quickly reaching "no match" results. For more details, see the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +. +. +.SS "Disabling automatic anchoring" +.rs +.sp +If a pattern starts with (*NO_DOTSTAR_ANCHOR), it has the same effect as +setting the PCRE2_NO_DOTSTAR_ANCHOR option, or calling \fBpcre2_set_optimize()\fP +with a PCRE2_DOTSTAR_ANCHOR_OFF directive. This disables optimizations that +apply to patterns whose top-level branches all start with .* (match any number +of arbitrary characters). For more details, see the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +. +. +.SS "Disabling JIT compilation" +.rs +.sp +If a pattern that starts with (*NO_JIT) is successfully compiled, an attempt by +the application to apply the JIT optimization by calling +\fBpcre2_jit_compile()\fP is ignored. +. +. +.SS "Setting match resource limits" +.rs +.sp +The \fBpcre2_match()\fP function contains a counter that is incremented every +time it goes round its main loop. The caller of \fBpcre2_match()\fP can set a +limit on this counter, which therefore limits the amount of computing resource +used for a match. The maximum depth of nested backtracking can also be limited; +this indirectly restricts the amount of heap memory that is used, but there is +also an explicit memory limit that can be set. +.P +These facilities are provided to catch runaway matches that are provoked by +patterns with huge matching trees. A common example is a pattern with nested +unlimited repeats applied to a long string that does not match. When one of +these limits is reached, \fBpcre2_match()\fP gives an error return. The limits +can also be set by items at the start of the pattern of the form +.sp + (*LIMIT_HEAP=d) + (*LIMIT_MATCH=d) + (*LIMIT_DEPTH=d) +.sp +where d is any number of decimal digits. However, the value of the setting must +be less than the value set (or defaulted) by the caller of \fBpcre2_match()\fP +for it to have any effect. In other words, the pattern writer can lower the +limits set by the programmer, but not raise them. If there is more than one +setting of one of these limits, the lower value is used. The heap limit is +specified in kibibytes (units of 1024 bytes). +.P +Prior to release 10.30, LIMIT_DEPTH was called LIMIT_RECURSION. This name is +still recognized for backwards compatibility. +.P +The heap limit applies only when the \fBpcre2_match()\fP or +\fBpcre2_dfa_match()\fP interpreters are used for matching. It does not apply +to JIT. The match limit is used (but in a different way) when JIT is being +used, or when \fBpcre2_dfa_match()\fP is called, to limit computing resource +usage by those matching functions. The depth limit is ignored by JIT but is +relevant for DFA matching, which uses function recursion for recursions within +the pattern and for lookaround assertions and atomic groups. In this case, the +depth limit controls the depth of such recursion. +. +. +.\" HTML +.SS "Newline conventions" +.rs +.sp +PCRE2 supports six different conventions for indicating line breaks in +strings: a single CR (carriage return) character, a single LF (linefeed) +character, the two-character sequence CRLF, any of the three preceding, any +Unicode newline sequence, or the NUL character (binary zero). The +.\" HREF +\fBpcre2api\fP +.\" +page has +.\" HTML +.\" +further discussion +.\" +about newlines, and shows how to set the newline convention when calling +\fBpcre2_compile()\fP. +.P +It is also possible to specify a newline convention by starting a pattern +string with one of the following sequences: +.sp + (*CR) carriage return + (*LF) linefeed + (*CRLF) carriage return, followed by linefeed + (*ANYCRLF) any of the three above + (*ANY) all Unicode newline sequences + (*NUL) the NUL character (binary zero) +.sp +These override the default and the options given to the compiling function. For +example, on a Unix system where LF is the default newline sequence, the pattern +.sp + (*CR)a.b +.sp +changes the convention to CR. That pattern matches "a\enb" because LF is no +longer a newline. If more than one of these settings is present, the last one +is used. +.P +The newline convention affects where the circumflex and dollar assertions are +true. It also affects the interpretation of the dot metacharacter when +PCRE2_DOTALL is not set, and the behaviour of \eN when not followed by an +opening brace. However, it does not affect what the \eR escape sequence +matches. By default, this is any Unicode newline sequence, for Perl +compatibility. However, this can be changed; see the next section and the +description of \eR in the section entitled +.\" HTML +.\" +"Newline sequences" +.\" +below. A change of \eR setting can be combined with a change of newline +convention. +. +. +.SS "Specifying what \eR matches" +.rs +.sp +It is possible to restrict \eR to match only CR, LF, or CRLF (instead of the +complete set of Unicode line endings) by setting the option PCRE2_BSR_ANYCRLF +at compile time. This effect can also be achieved by starting a pattern with +(*BSR_ANYCRLF). For completeness, (*BSR_UNICODE) is also recognized, +corresponding to PCRE2_BSR_UNICODE. +. +. +.SH "CHARACTERS AND METACHARACTERS" +.rs +.sp +A regular expression is a pattern that is matched against a subject string from +left to right. Most characters stand for themselves in a pattern, and match the +corresponding characters in the subject. As a trivial example, the pattern +.sp + The quick brown fox +.sp +matches a portion of a subject string that is identical to itself. When +caseless matching is specified (the PCRE2_CASELESS option or (?i) within the +pattern), letters are matched independently of case. Note that there are two +ASCII characters, K and S, that, in addition to their lower case ASCII +equivalents, are case-equivalent with Unicode U+212A (Kelvin sign) and U+017F +(long S) respectively when either PCRE2_UTF or PCRE2_UCP is set, unless the +PCRE2_EXTRA_CASELESS_RESTRICT option is in force (either passed to +\fBpcre2_compile()\fP or set by (*CASELESS_RESTRICT) or (?r) within the +pattern). If the PCRE2_EXTRA_TURKISH_CASING option is in force (either passed +to \fBpcre2_compile()\fP or set by (*TURKISH_CASING) within the pattern), then +the 'i' letters are matched according to Turkish and Azeri languages. +.P +The power of regular expressions comes from the ability to include wild cards, +character classes, alternatives, and repetitions in the pattern. These are +encoded in the pattern by the use of \fImetacharacters\fP, which do not stand +for themselves but instead are interpreted in some special way. +.P +There are two different sets of metacharacters: those that are recognized +anywhere in the pattern except within square brackets, and those that are +recognized within square brackets. Outside square brackets, the metacharacters +are as follows: +.sp + \e general escape character with several uses + ^ assert start of string (or line, in multiline mode) + $ assert end of string (or line, in multiline mode) + . match any character except newline (by default) + [ start character class definition + | start of alternative branch + ( start group or control verb + ) end group or control verb + * 0 or more quantifier + + 1 or more quantifier; also "possessive quantifier" + ? 0 or 1 quantifier; also quantifier minimizer + { potential start of min/max quantifier +.sp +Brace characters { and } are also used to enclose data for constructions such +as \eg{2} or \ek{name}. In almost all uses of braces, space and/or horizontal +tab characters that follow { or precede } are allowed and are ignored. In the +case of quantifiers, they may also appear before or after the comma. The +exception to this is \eu{...} which is an ECMAScript compatibility feature +that is recognized only when the PCRE2_EXTRA_ALT_BSUX option is set. ECMAScript +does not ignore such white space; it causes the item to be interpreted as +literal. +.P +Part of a pattern that is in square brackets is called a "character class". In +a character class the only metacharacters are: +.sp + \e general escape character + ^ negate the class, but only if the first character + - indicates character range + [ POSIX character class (if followed by POSIX syntax) + ] terminates the character class +.sp +If a pattern is compiled with the PCRE2_EXTENDED option, most white space in +the pattern, other than in a character class, within a \eQ...\eE sequence, or +between a # outside a character class and the next newline, inclusive, is +ignored. An escaping backslash can be used to include a white space or a # +character as part of the pattern. If the PCRE2_EXTENDED_MORE option is set, the +same applies, but in addition unescaped space and horizontal tab characters are +ignored inside a character class. Note: only these two characters are ignored, +not the full set of pattern white space characters that are ignored outside a +character class. Option settings can be changed within a pattern; see the +section entitled +.\" HTML +.\" +"Internal Option Setting" +.\" +below. +.P +The following sections describe the use of each of the metacharacters. +. +. +.SH BACKSLASH +.rs +.sp +The backslash character has several uses. Firstly, if it is followed by a +character that is not a digit or a letter, it takes away any special meaning +that character may have. This use of backslash as an escape character applies +both inside and outside character classes. +.P +For example, if you want to match a * character, you must write \e* in the +pattern. This escaping action applies whether or not the following character +would otherwise be interpreted as a metacharacter, so it is always safe to +precede a non-alphanumeric with backslash to specify that it stands for itself. +In particular, if you want to match a backslash, you write \e\e. +.P +Only ASCII digits and letters have any special meaning after a backslash. All +other characters (in particular, those whose code points are greater than 127) +are treated as literals. +.P +If you want to treat all characters in a sequence as literals, you can do so by +putting them between \eQ and \eE. Note that this includes white space even when +the PCRE2_EXTENDED option is set so that most other white space is ignored. The +behaviour is different from Perl in that $ and @ are handled as literals in +\eQ...\eE sequences in PCRE2, whereas in Perl, $ and @ cause variable +interpolation. Also, Perl does "double-quotish backslash interpolation" on any +backslashes between \eQ and \eE which, its documentation says, "may lead to +confusing results". PCRE2 treats a backslash between \eQ and \eE just like any +other character. Note the following examples: +.sp + Pattern PCRE2 matches Perl matches +.sp +.\" JOIN + \eQabc$xyz\eE abc$xyz abc followed by the + contents of $xyz + \eQabc\e$xyz\eE abc\e$xyz abc\e$xyz + \eQabc\eE\e$\eQxyz\eE abc$xyz abc$xyz + \eQA\eB\eE A\eB A\eB + \eQ\e\eE \e \e\eE +.sp +The \eQ...\eE sequence is recognized both inside and outside character classes. +An isolated \eE that is not preceded by \eQ is ignored. If \eQ is not followed +by \eE later in the pattern, the literal interpretation continues to the end of +the pattern (that is, \eE is assumed at the end). If the isolated \eQ is inside +a character class, this causes an error, because the character class is then +not terminated by a closing square bracket. +.P +Another difference from Perl is that any appearance of \eQ or \eE inside what +might otherwise be a quantifier causes PCRE2 not to recognize the sequence as a +quantifier. Perl recognizes a quantifier if (redundantly) either of the numbers +is inside \eQ...\eE, but not if the separating comma is. When not recognized as +a quantifier a sequence such as {\eQ1\eE,2} is treated as the literal string +"{1,2}". +. +. +.\" HTML +.SS "Non-printing characters" +.rs +.sp +A second use of backslash provides a way of encoding non-printing characters +in patterns in a visible manner. There is no restriction on the appearance of +non-printing characters in a pattern, but when a pattern is being prepared by +text editing, it is often easier to use one of the following escape sequences +instead of the binary character it represents. In an ASCII or Unicode +environment, these escapes are as follows: +.sp + \ea alarm, that is, the BEL character (hex 07) + \ecx "control-x", where x is a non-control ASCII character + \ee escape (hex 1B) + \ef form feed (hex 0C) + \en linefeed (hex 0A) + \er carriage return (hex 0D) (but see below) + \et tab (hex 09) + \e0dd character with octal code 0dd + \eddd character with octal code ddd, or back reference + \eo{ddd..} character with octal code ddd.. + \exhh character with hex code hh + \ex{hhh..} character with hex code hhh.. + \eN{U+hhh..} character with Unicode hex code point hhh.. +.sp +A description of how back references work is given +.\" HTML +.\" +later, +.\" +following the discussion of +.\" HTML +.\" +parenthesized groups. +.\" +.P +By default, after \ex that is not followed by {, one or two hexadecimal +digits are read (letters can be in upper or lower case). If the character that +follows \ex is neither { nor a hexadecimal digit, an error occurs. This is +different from Perl's default behaviour, which generates a NUL character, but +is in line with the behaviour of Perl's 'strict' mode in re. +.P +Any number of hexadecimal digits may appear between \ex{ and }. If a character +other than a hexadecimal digit appears between \ex{ and }, or if there is no +terminating }, an error occurs. +.P +Characters whose code points are less than 256 can be defined by either of the +two syntaxes for \ex or by an octal sequence. There is no difference in the way +they are handled. For example, \exdc is exactly the same as \ex{dc} or \e334. +However, using the braced versions does make such sequences easier to read. +.P +Support is available for some ECMAScript (aka JavaScript) escape sequences via +two compile-time options. If PCRE2_ALT_BSUX is set, the sequence \ex followed +by { is not recognized. Only if \ex is followed by two hexadecimal digits is it +recognized as a character escape. Otherwise it is interpreted as a literal "x" +character. In this mode, support for code points greater than 256 is provided +by \eu, which must be followed by four hexadecimal digits; otherwise it is +interpreted as a literal "u" character. +.P +PCRE2_EXTRA_ALT_BSUX has the same effect as PCRE2_ALT_BSUX and, in addition, +\eu{hhh..} is recognized as the character specified by hexadecimal code point. +There may be any number of hexadecimal digits, but unlike other places that +also use curly brackets, spaces are not allowed and would result in the string +being interpreted as a literal. This syntax is from ECMAScript 6. +.P +The \eN{U+hhh..} escape sequence is recognized only when PCRE2 is operating in +UTF mode. Perl also uses \eN{name} to specify characters by Unicode name; PCRE2 +does not support this. Note that when \eN is not followed by an opening brace +(curly bracket) it has an entirely different meaning, matching any character +that is not a newline. +.P +There are some legacy applications where the escape sequence \er is expected to +match a newline. If the PCRE2_EXTRA_ESCAPED_CR_IS_LF option is set, \er in a +pattern is converted to \en so that it matches a LF (linefeed) instead of a CR +(carriage return) character. +.P +An error occurs if \ec is not followed by a character whose ASCII code point +is in the range 32 to 126. The precise effect of \ecx is as follows: if x is a +lower case letter, it is converted to upper case. Then bit 6 of the character +(hex 40) is inverted. Thus \ecA to \ecZ become hex 01 to hex 1A (A is 41, Z is +5A), but \ec{ becomes hex 3B ({ is 7B), and \ec; becomes hex 7B (; is 3B). If +the code unit following \ec has a code point less than 32 or greater than 126, +a compile-time error occurs. +.P +For differences in the way some escapes behave in EBCDIC environments, +see section +.\" HTML +.\" +"EBCDIC environments" +.\" +below. +. +. +.SS "Octal escapes and back references" +.rs +.sp +The escape \eo must be followed by a sequence of octal digits, enclosed in +braces. An error occurs if this is not the case. This escape provides a way of +specifying character code points as octal numbers greater than 0777, and it +also allows octal numbers and backreferences to be unambiguously distinguished. +.P +If braces are not used, after \e0 up to two further octal digits are read. +However, if the PCRE2_EXTRA_NO_BS0 option is set, at least one more octal digit +must follow \e0 (use \e00 to generate a NUL character). Make sure you supply +two digits after the initial zero if the pattern character that follows is +itself an octal digit. +.P +Inside a character class, when a backslash is followed by any octal digit, up +to three octal digits are read to generate a code point. Any subsequent digits +stand for themselves. The sequences \e8 and \e9 are treated as the literal +characters "8" and "9". +.P +Outside a character class, Perl's handling of a backslash followed by a digit +other than 0 is complicated by ambiguity, and Perl has changed over time, +causing PCRE2 also to change. From PCRE2 release 10.45 there is an option +called PCRE2_EXTRA_PYTHON_OCTAL that causes PCRE2 to use Python's unambiguous +rules. The next two subsections describe the two sets of rules. +.P +For greater clarity and unambiguity, it is best to avoid following \e by a +digit greater than zero. Instead, use \eo{...} or \ex{...} to specify numerical +character code points, and \eg{...} to specify backreferences. +. +. +.SS "Perl rules for non-class backslash 1-9" +.rs +.sp +All the digits that follow the backslash are read as a decimal number. If the +number is less than 10, begins with the digit 8 or 9, or if there are at least +that many previous capture groups in the expression, the entire sequence is +taken as a back reference. Otherwise, up to three octal digits are read to form +a character code. For example: +.sp + \e040 is another way of writing an ASCII space +.\" JOIN + \e40 is the same, provided there are fewer than 40 + previous capture groups + \e7 is always a backreference +.\" JOIN + \e11 might be a backreference, or another way of + writing a tab + \e011 is always a tab + \e0113 is a tab followed by the character "3" +.\" JOIN + \e113 might be a backreference, otherwise the + character with octal code 113 +.\" JOIN + \e377 might be a backreference, otherwise + the value 255 (decimal) + \e81 is always a backreference +.sp +Note that octal values of 100 or greater that are specified using this syntax +must not be introduced by a leading zero, because no more than three octal +digits are ever read. +. +. +.SS "Python rules for non_class backslash 1-9" +.rs +.sp +If there are at least three octal digits after the backslash, exactly three are +read as an octal code point number, but the value must be no greater than +\e377, even in modes where higher code point values are supported. Any +subsequent digits stand for themselves. If there are fewer than three octal +digits, the sequence is taken as a decimal back reference. Thus, for example, +\e12 is always a back reference, independent of how many captures there are in +the pattern. An error is generated for a reference to a non-existent capturing +group. +. +. +.SS "Constraints on character values" +.rs +.sp +Characters that are specified using octal or hexadecimal numbers are +limited to certain values, as follows: +.sp + 8-bit non-UTF mode no greater than 0xff + 16-bit non-UTF mode no greater than 0xffff + 32-bit non-UTF mode no greater than 0xffffffff + All UTF modes no greater than 0x10ffff and a valid code point +.sp +Invalid Unicode code points are all those in the range 0xd800 to 0xdfff (the +so-called "surrogate" code points). The check for these can be disabled by the +caller of \fBpcre2_compile()\fP by setting the option +PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES. However, this is possible only in UTF-8 +and UTF-32 modes, because these values are not representable in UTF-16. +. +. +.SS "Escape sequences in character classes" +.rs +.sp +All the sequences that define a single character value can be used both inside +and outside character classes. In addition, inside a character class, \eb is +interpreted as the backspace character (hex 08). +.P +When not followed by an opening brace, \eN is not allowed in a character class. +\eB, \eR, and \eX are not special inside a character class. Like other +unrecognized alphabetic escape sequences, they cause an error. Outside a +character class, these sequences have different meanings. +. +. +.SS "Unsupported escape sequences" +.rs +.sp +In Perl, the sequences \eF, \el, \eL, \eu, and \eU are recognized by its string +handler and used to modify the case of following characters. By default, PCRE2 +does not support these escape sequences in patterns. However, if either of the +PCRE2_ALT_BSUX or PCRE2_EXTRA_ALT_BSUX options is set, \eU matches a "U" +character, and \eu can be used to define a character by code point, as +described above. +. +. +.SS "Absolute and relative backreferences" +.rs +.sp +The sequence \eg followed by a signed or unsigned number, optionally enclosed +in braces, is an absolute or relative backreference. A named backreference +can be coded as \eg{name}. Backreferences are discussed +.\" HTML +.\" +later, +.\" +following the discussion of +.\" HTML +.\" +parenthesized groups. +.\" +. +. +.SS "Absolute and relative subroutine calls" +.rs +.sp +For compatibility with Oniguruma, the non-Perl syntax \eg followed by a name or +a number enclosed either in angle brackets or single quotes, is an alternative +syntax for referencing a capture group as a subroutine. Details are discussed +.\" HTML +.\" +later. +.\" +Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP +synonymous. The former is a backreference; the latter is a +.\" HTML +.\" +subroutine +.\" +call. +. +. +.\" HTML +.SS "Generic character types" +.rs +.sp +Another use of backslash is for specifying generic character types: +.sp + \ed any decimal digit + \eD any character that is not a decimal digit + \eh any horizontal white space character + \eH any character that is not a horizontal white space character + \eN any character that is not a newline + \es any white space character + \eS any character that is not a white space character + \ev any vertical white space character + \eV any character that is not a vertical white space character + \ew any "word" character + \eW any "non-word" character +.sp +The \eN escape sequence has the same meaning as +.\" HTML +.\" +the "." metacharacter +.\" +when PCRE2_DOTALL is not set, but setting PCRE2_DOTALL does not change the +meaning of \eN. Note that when \eN is followed by an opening brace it has a +different meaning. See the section entitled +.\" HTML +.\" +"Non-printing characters" +.\" +above for details. Perl also uses \eN{name} to specify characters by Unicode +name; PCRE2 does not support this. +.P +Each pair of lower and upper case escape sequences partitions the complete set +of characters into two disjoint sets. Any given character matches one, and only +one, of each pair. The sequences can appear both inside and outside character +classes. They each match one character of the appropriate type. If the current +matching point is at the end of the subject string, all of them fail, because +there is no character to match. +.P +The default \es characters are HT (9), LF (10), VT (11), FF (12), CR (13), and +space (32), which are defined as white space in the "C" locale. This list may +vary if locale-specific matching is taking place. For example, in some locales +the "non-breaking space" character (\exA0) is recognized as white space, and in +others the VT character is not. +.P +A "word" character is an underscore or any character that is a letter or digit. +By default, the definition of letters and digits is controlled by PCRE2's +low-valued character tables, and may vary if locale-specific matching is taking +place (see +.\" HTML +.\" +"Locale support" +.\" +in the +.\" HREF +\fBpcre2api\fP +.\" +page). For example, in a French locale such as "fr_FR" in Unix-like systems, +or "french" in Windows, some character codes greater than 127 are used for +accented letters, and these are then matched by \ew. The use of locales with +Unicode is discouraged. +.P +By default, characters whose code points are greater than 127 never match \ed, +\es, or \ew, and always match \eD, \eS, and \eW, although this may be different +for characters in the range 128-255 when locale-specific matching is happening. +These escape sequences retain their original meanings from before Unicode +support was available, mainly for efficiency reasons. If the PCRE2_UCP option +is set, the behaviour is changed so that Unicode properties are used to +determine character types, as follows: +.sp + \ed any character that matches \ep{Nd} (decimal digit) + \es any character that matches \ep{Z} or \eh or \ev + \ew any character that matches \ep{L}, \ep{N}, \ep{Mn}, or \ep{Pc} +.sp +The addition of \ep{Mn} (non-spacing mark) and the replacement of an explicit +test for underscore with a test for \ep{Pc} (connector punctuation) happened in +PCRE2 release 10.43. This brings PCRE2 into line with Perl. +.P +The upper case escapes match the inverse sets of characters. Note that \ed +matches only decimal digits, whereas \ew matches any Unicode digit, as well as +other character categories. Note also that PCRE2_UCP affects \eb, and +\eB because they are defined in terms of \ew and \eW. Matching these sequences +is noticeably slower when PCRE2_UCP is set. +.P +The effect of PCRE2_UCP on any one of these escape sequences can be negated by +the options PCRE2_EXTRA_ASCII_BSD, PCRE2_EXTRA_ASCII_BSS, and +PCRE2_EXTRA_ASCII_BSW, respectively. These options can be set and reset within +a pattern by means of an internal option setting +.\" HTML +.\" +(see below). +.\" +.P +The sequences \eh, \eH, \ev, and \eV, in contrast to the other sequences, which +match only ASCII characters by default, always match a specific list of code +points, whether or not PCRE2_UCP is set. The horizontal space characters are: +.sp + U+0009 Horizontal tab (HT) + U+0020 Space + U+00A0 Non-break space + U+1680 Ogham space mark + U+180E Mongolian vowel separator + U+2000 En quad + U+2001 Em quad + U+2002 En space + U+2003 Em space + U+2004 Three-per-em space + U+2005 Four-per-em space + U+2006 Six-per-em space + U+2007 Figure space + U+2008 Punctuation space + U+2009 Thin space + U+200A Hair space + U+202F Narrow no-break space + U+205F Medium mathematical space + U+3000 Ideographic space +.sp +The vertical space characters are: +.sp + U+000A Linefeed (LF) + U+000B Vertical tab (VT) + U+000C Form feed (FF) + U+000D Carriage return (CR) + U+0085 Next line (NEL) + U+2028 Line separator + U+2029 Paragraph separator +.sp +In 8-bit, non-UTF-8 mode, only the characters with code points less than 256 +are relevant. +. +. +.\" HTML +.SS "Newline sequences" +.rs +.sp +Outside a character class, by default, the escape sequence \eR matches any +Unicode newline sequence. In 8-bit non-UTF-8 mode \eR is equivalent to the +following: +.sp + (?>\er\en|\en|\ex0b|\ef|\er|\ex85) +.sp +This is an example of an "atomic group", details of which are given +.\" HTML +.\" +below. +.\" +This particular group matches either the two-character sequence CR followed by +LF, or one of the single characters LF (linefeed, U+000A), VT (vertical tab, +U+000B), FF (form feed, U+000C), CR (carriage return, U+000D), or NEL (next +line, U+0085). Because this is an atomic group, the two-character sequence is +treated as a single unit that cannot be split. +.P +In other modes, two additional characters whose code points are greater than 255 +are added: LS (line separator, U+2028) and PS (paragraph separator, U+2029). +Unicode support is not needed for these characters to be recognized. +.P +It is possible to restrict \eR to match only CR, LF, or CRLF (instead of the +complete set of Unicode line endings) by setting the option PCRE2_BSR_ANYCRLF +at compile time. (BSR is an abbreviation for "backslash R".) This can be made +the default when PCRE2 is built; if this is the case, the other behaviour can +be requested via the PCRE2_BSR_UNICODE option. It is also possible to specify +these settings by starting a pattern string with one of the following +sequences: +.sp + (*BSR_ANYCRLF) CR, LF, or CRLF only + (*BSR_UNICODE) any Unicode newline sequence +.sp +These override the default and the options given to the compiling function. +Note that these special settings, which are not Perl-compatible, are recognized +only at the very start of a pattern, and that they must be in upper case. If +more than one of them is present, the last one is used. They can be combined +with a change of newline convention; for example, a pattern can start with: +.sp + (*ANY)(*BSR_ANYCRLF) +.sp +They can also be combined with the (*UTF) or (*UCP) special sequences. Inside a +character class, \eR is treated as an unrecognized escape sequence, and causes +an error. +. +. +.\" HTML +.SS Unicode character properties +.rs +.sp +When PCRE2 is built with Unicode support (the default), three additional escape +sequences that match characters with specific properties are available. They +can be used in any mode, though in 8-bit and 16-bit non-UTF modes these +sequences are of course limited to testing characters whose code points are +less than U+0100 or U+10000, respectively. In 32-bit non-UTF mode, code points +greater than 0x10ffff (the Unicode limit) may be encountered. These are all +treated as being in the Unknown script and with an unassigned type. +.P +Matching characters by Unicode property is not fast, because PCRE2 has to do a +multistage table lookup in order to find a character's property. That is why +the traditional escape sequences such as \ed and \ew do not use Unicode +properties in PCRE2 by default, though you can make them do so by setting the +PCRE2_UCP option or by starting the pattern with (*UCP). +.P +The extra escape sequences that provide property support are: +.sp + \ep{\fIxx\fP} a character with the \fIxx\fP property + \eP{\fIxx\fP} a character without the \fIxx\fP property + \eX a Unicode extended grapheme cluster +.sp +For compatibility with Perl, negation can be specified by including a +circumflex between the opening brace and the property. For example, \ep{^Lu} is +the same as \eP{Lu}. +.P +In accordance with Unicode's "loose matching" rules, ASCII white space +characters, hyphens, and underscores are ignored in the properties represented +by \fIxx\fP above. As well as the space character, ASCII white space can be +tab, linefeed, vertical tab, formfeed, or carriage return. +.P +Some properties are specified as a name only; others as a name and a value, +separated by a colon or an equals sign. The names and values consist of ASCII +letters and digits (with one Perl-specific exception, see below). They are not +case sensitive. Note, however, that the escapes themselves, \ep and \eP, +\fIare\fP case sensitive. There are abbreviations for many names. The following +examples are all equivalent: +.sp + \ep{bidiclass=al} + \ep{BC=al} + \ep{ Bidi_Class : AL } + \ep{ Bi-di class = Al } + \eP{ ^ Bi-di class = Al } +.sp +There is support for Unicode script names, Unicode general category properties, +"Any", which matches any character (including newline), Bidi_Class, a number of +binary (yes/no) properties, and some special PCRE2 properties (described +.\" HTML +.\" +below). +.\" +Certain other Perl properties such as "InMusicalSymbols" are not supported by +PCRE2. Note that \eP{Any} does not match any characters, so always causes a +match failure. +. +. +. +.SS "Script properties for \ep and \eP" +.rs +.sp +There are three different syntax forms for matching a script. Each Unicode +character has a basic script and, optionally, a list of other scripts ("Script +Extensions") with which it is commonly used. Using the Adlam script as an +example, \ep{sc:Adlam} matches characters whose basic script is Adlam, whereas +\ep{scx:Adlam} matches, in addition, characters that have Adlam in their +extensions list. The full names "script" and "script extensions" for the +property types are recognized and, as for all property specifications, an +equals sign is an alternative to the colon. If a script name is given without a +property type, for example, \ep{Adlam}, it is treated as \ep{scx:Adlam}. Perl +changed to this interpretation at release 5.26 and PCRE2 changed at release +10.40. +.P +Unassigned characters (and in non-UTF 32-bit mode, characters with code points +greater than 0x10FFFF) are assigned the "Unknown" script. Others that are not +part of an identified script are lumped together as "Common". The current list +of recognized script names and their 4-character abbreviations can be obtained +by running this command: +.sp + pcre2test -LS +.sp +. +. +. +.SS "The general category property for \ep and \eP" +.rs +.sp +Each character has exactly one Unicode general category property, specified by +a two-letter abbreviation. If only one letter is specified with \ep or \eP, it +includes all the general category properties that start with that letter. In +this case, in the absence of negation, the curly brackets in the escape +sequence are optional; these two examples have the same effect: +.sp + \ep{L} + \epL +.sp +The following general category property codes are supported: +.sp + C Other + Cc Control + Cf Format + Cn Unassigned + Co Private use + Cs Surrogate +.sp + L Letter + Lc Cased letter + Ll Lower case letter + Lm Modifier letter + Lo Other letter + Lt Title case letter + Lu Upper case letter +.sp + M Mark + Mc Spacing mark + Me Enclosing mark + Mn Non-spacing mark +.sp + N Number + Nd Decimal number + Nl Letter number + No Other number +.sp + P Punctuation + Pc Connector punctuation + Pd Dash punctuation + Pe Close punctuation + Pf Final punctuation + Pi Initial punctuation + Po Other punctuation + Ps Open punctuation +.sp + S Symbol + Sc Currency symbol + Sk Modifier symbol + Sm Mathematical symbol + So Other symbol +.sp + Z Separator + Zl Line separator + Zp Paragraph separator + Zs Space separator +.sp +Perl originally used the name L& for the Lc property. This is still supported +by Perl, but discouraged. PCRE2 also still supports it. This property matches +any character that has the Lu, Ll, or Lt property, in other words, any letter +that is not classified as a modifier or "other". From release 10.45 of PCRE2 +the properties Lu, Ll, and Lt are all treated as Lc when case-independent +matching is set by the PCRE2_CASELESS option or (?i) within the pattern. The +other properties are not affected by caseless matching. +.P +The Cs (Surrogate) property applies only to characters whose code points are in +the range U+D800 to U+DFFF. These characters are no different to any other +character when PCRE2 is not in UTF mode (using the 16-bit or 32-bit library). +However, they are not valid in Unicode strings and so cannot be tested by PCRE2 +in UTF mode, unless UTF validity checking has been turned off (see the +discussion of PCRE2_NO_UTF_CHECK in the +.\" HREF +\fBpcre2api\fP +.\" +page). +.P +The long synonyms for property names that Perl supports (such as \ep{Letter}) +are not supported by PCRE2, nor is it permitted to prefix any of these +properties with "Is". +.P +No character that is in the Unicode table has the Cn (unassigned) property. +Instead, this property is assumed for any code point that is not in the +Unicode table. +. +. +.SS "Binary (yes/no) properties for \ep and \eP" +.rs +.sp +Unicode defines a number of binary properties, that is, properties whose only +values are true or false. You can obtain a list of those that are recognized by +\ep and \eP, along with their abbreviations, by running this command: +.sp + pcre2test -LP +.sp +. +. +.SS "The Bidi_Class property for \ep and \eP" +.rs +.sp + \ep{Bidi_Class:} matches a character with the given class + \ep{BC:} matches a character with the given class +.sp +The recognized classes are: +.sp + AL Arabic letter + AN Arabic number + B paragraph separator + BN boundary neutral + CS common separator + EN European number + ES European separator + ET European terminator + FSI first strong isolate + L left-to-right + LRE left-to-right embedding + LRI left-to-right isolate + LRO left-to-right override + NSM non-spacing mark + ON other neutral + PDF pop directional format + PDI pop directional isolate + R right-to-left + RLE right-to-left embedding + RLI right-to-left isolate + RLO right-to-left override + S segment separator + WS white space +.sp +As in all property specifications, an equals sign may be used instead of a +colon and the class names are case-insensitive. Only the short names listed +above are recognized; PCRE2 does not at present support any long alternatives. +. +. +.SS Extended grapheme clusters +.rs +.sp +The \eX escape matches any number of Unicode characters that form an "extended +grapheme cluster", and treats the sequence as an atomic group +.\" HTML +.\" +(see below). +.\" +Unicode supports various kinds of composite character by giving each character +a grapheme breaking property, and having rules that use these properties to +define the boundaries of extended grapheme clusters. The rules are defined in +Unicode Standard Annex 29, "Unicode Text Segmentation". Unicode 11.0.0 +abandoned the use of some previous properties that had been used for emojis. +Instead it introduced various emoji-specific properties. PCRE2 uses only the +Extended Pictographic property. +.P +\eX always matches at least one character. Then it decides whether to add +additional characters according to the following rules for ending a cluster: +.P +1. End at the end of the subject string. +.P +2. Do not end between CR and LF; otherwise end after any control character. +.P +3. Do not break Hangul (a Korean script) syllable sequences. Hangul characters +are of five types: L, V, T, LV, and LVT. An L character may be followed by an +L, V, LV, or LVT character; an LV or V character may be followed by a V or T +character; an LVT or T character may be followed only by a T character. +.P +4. Do not end before extending characters or spacing marks or the zero-width +joiner (ZWJ) character. Characters with the "mark" property always have the +"extend" grapheme breaking property. +.P +5. Do not end after prepend characters. +.P +6. Do not end within emoji modifier sequences or emoji ZWJ (zero-width +joiner) sequences. An emoji ZWJ sequence consists of a character with the +Extended_Pictographic property, optionally followed by one or more characters +with the Extend property, followed by the ZWJ character, followed by another +Extended_Pictographic character. +.P +7. Do not break within emoji flag sequences. That is, do not break between +regional indicator (RI) characters if there are an odd number of RI characters +before the break point. +.P +8. Otherwise, end the cluster. +. +. +.\" HTML +.SS PCRE2's additional properties +.rs +.sp +As well as the standard Unicode properties described above, PCRE2 supports four +more that make it possible to convert traditional escape sequences such as \ew +and \es to use Unicode properties. PCRE2 uses these non-standard, non-Perl +properties internally when PCRE2_UCP is set. However, they may also be used +explicitly. These properties are: +.sp + Xan Any alphanumeric character + Xps Any POSIX space character + Xsp Any Perl space character + Xwd Any Perl "word" character +.sp +Xan matches characters that have either the L (letter) or the N (number) +property. Xps matches the characters tab, linefeed, vertical tab, form feed, or +carriage return, and any other character that has the Z (separator) property +(this includes the space character). Xsp is the same as Xps; in PCRE1 it used +to exclude vertical tab, for Perl compatibility, but Perl changed. Xwd matches +the same characters as Xan, plus those that match Mn (non-spacing mark) or Pc +(connector punctuation, which includes underscore). +.P +There is another non-standard property, Xuc, which matches any character that +can be represented by a Universal Character Name in C++ and other programming +languages. These are the characters $, @, ` (grave accent), and all characters +with Unicode code points greater than or equal to U+00A0, except for the +surrogates U+D800 to U+DFFF. Note that most base (ASCII) characters are +excluded. (Universal Character Names are of the form \euHHHH or \eUHHHHHHHH +where H is a hexadecimal digit. Note that the Xuc property does not match these +sequences but the characters that they represent.) +. +. +.\" HTML +.SS "Resetting the match start" +.rs +.sp +In normal use, the escape sequence \eK causes any previously matched characters +not to be included in the final matched sequence that is returned. For example, +the pattern: +.sp + foo\eKbar +.sp +matches "foobar", but reports that it has matched "bar". \eK does not interact +with anchoring in any way. The pattern: +.sp + ^foo\eKbar +.sp +matches only when the subject begins with "foobar" (in single line mode), +though it again reports the matched string as "bar". This feature is similar to +a lookbehind assertion +.\" HTML +.\" +(described below), +.\" +but the part of the pattern that precedes \eK is not constrained to match a +limited number of characters, as is required for a lookbehind assertion. The +use of \eK does not interfere with the setting of +.\" HTML +.\" +captured substrings. +.\" +For example, when the pattern +.sp + (foo)\eKbar +.sp +matches "foobar", the first substring is still set to "foo". +.P +From version 5.32.0 Perl forbids the use of \eK in lookaround assertions. From +release 10.38 PCRE2 also forbids this by default. However, the +PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK option can be used when calling +\fBpcre2_compile()\fP to re-enable the previous behaviour. When this option is +set, \eK is acted upon when it occurs inside positive assertions, but is +ignored in negative assertions. Note that when a pattern such as (?=ab\eK) +matches, the reported start of the match can be greater than the end of the +match. Using \eK in a lookbehind assertion at the start of a pattern can also +lead to odd effects. For example, consider this pattern: +.sp + (?<=\eKfoo)bar +.sp +If the subject is "foobar", a call to \fBpcre2_match()\fP with a starting +offset of 3 succeeds and reports the matching string as "foobar", that is, the +start of the reported match is earlier than where the match started. +. +. +.\" HTML +.SS "Simple assertions" +.rs +.sp +The final use of backslash is for certain simple assertions. An assertion +specifies a condition that has to be met at a particular point in a match, +without consuming any characters from the subject string. The use of +groups for more complicated assertions is described +.\" HTML +.\" +below. +.\" +The backslashed assertions are: +.sp + \eb matches at a word boundary + \eB matches when not at a word boundary + \eA matches at the start of the subject + \eZ matches at the end of the subject + also matches before a newline at the end of the subject + \ez matches only at the end of the subject + \eG matches at the first matching position in the subject +.sp +Inside a character class, \eb has a different meaning; it matches the backspace +character. If any other of these assertions appears in a character class, an +"invalid escape sequence" error is generated. +.P +A word boundary is a position in the subject string where the current character +and the previous character do not both match \ew or \eW (i.e. one matches +\ew and the other matches \eW), or the start or end of the string if the +first or last character matches \ew, respectively. When PCRE2 is built with +Unicode support, the meanings of \ew and \eW can be changed by setting the +PCRE2_UCP option. When this is done, it also affects \eb and \eB. Neither PCRE2 +nor Perl has a separate "start of word" or "end of word" metasequence. However, +whatever follows \eb normally determines which it is. For example, the fragment +\eba matches "a" at the start of a word. +.P +The \eA, \eZ, and \ez assertions differ from the traditional circumflex and +dollar (described in the next section) in that they only ever match at the very +start and end of the subject string, whatever options are set. Thus, they are +independent of multiline mode. These three assertions are not affected by the +PCRE2_NOTBOL or PCRE2_NOTEOL options, which affect only the behaviour of the +circumflex and dollar metacharacters. However, if the \fIstartoffset\fP +argument of \fBpcre2_match()\fP is non-zero, indicating that matching is to +start at a point other than the beginning of the subject, \eA can never match. +The difference between \eZ and \ez is that \eZ matches before a newline at the +end of the string as well as at the very end, whereas \ez matches only at the +end. +.P +The \eG assertion is true only when the current matching position is at the +start point of the matching process, as specified by the \fIstartoffset\fP +argument of \fBpcre2_match()\fP. It differs from \eA when the value of +\fIstartoffset\fP is non-zero. By calling \fBpcre2_match()\fP multiple times +with appropriate arguments, you can mimic Perl's /g option, and it is in this +kind of implementation where \eG can be useful. +.P +Note, however, that PCRE2's implementation of \eG, being true at the starting +character of the matching process, is subtly different from Perl's, which +defines it as true at the end of the previous match. In Perl, these can be +different when the previously matched string was empty. Because PCRE2 does just +one match at a time, it cannot reproduce this behaviour. +.P +If all the alternatives of a pattern begin with \eG, the expression is anchored +to the starting match position, and the "anchored" flag is set in the compiled +regular expression. +. +. +.SH "CIRCUMFLEX AND DOLLAR" +.rs +.sp +The circumflex and dollar metacharacters are zero-width assertions. That is, +they test for a particular condition being true without consuming any +characters from the subject string. These two metacharacters are concerned with +matching the starts and ends of lines. If the newline convention is set so that +only the two-character sequence CRLF is recognized as a newline, isolated CR +and LF characters are treated as ordinary data characters, and are not +recognized as newlines. +.P +Outside a character class, in the default matching mode, the circumflex +character is an assertion that is true only if the current matching point is at +the start of the subject string. If the \fIstartoffset\fP argument of +\fBpcre2_match()\fP is non-zero, or if PCRE2_NOTBOL is set, circumflex can +never match if the PCRE2_MULTILINE option is unset. Inside a character class, +circumflex has an entirely different meaning +.\" HTML +.\" +(see below). +.\" +.P +Circumflex need not be the first character of the pattern if a number of +alternatives are involved, but it should be the first thing in each alternative +in which it appears if the pattern is ever to match that branch. If all +possible alternatives start with a circumflex, that is, if the pattern is +constrained to match only at the start of the subject, it is said to be an +"anchored" pattern. (There are also other constructs that can cause a pattern +to be anchored.) +.P +The dollar character is an assertion that is true only if the current matching +point is at the end of the subject string, or immediately before a newline at +the end of the string (by default), unless PCRE2_NOTEOL is set. Note, however, +that it does not actually match the newline. Dollar need not be the last +character of the pattern if a number of alternatives are involved, but it +should be the last item in any branch in which it appears. Dollar has no +special meaning in a character class. +.P +The meaning of dollar can be changed so that it matches only at the very end of +the string, by setting the PCRE2_DOLLAR_ENDONLY option at compile time. This +does not affect the \eZ assertion. +.P +The meanings of the circumflex and dollar metacharacters are changed if the +PCRE2_MULTILINE option is set. When this is the case, a dollar character +matches before any newlines in the string, as well as at the very end, and a +circumflex matches immediately after internal newlines as well as at the start +of the subject string. It does not match after a newline that ends the string, +for compatibility with Perl. However, this can be changed by setting the +PCRE2_ALT_CIRCUMFLEX option. +.P +For example, the pattern /^abc$/ matches the subject string "def\enabc" (where +\en represents a newline) in multiline mode, but not otherwise. Consequently, +patterns that are anchored in single line mode because all branches start with +^ are not anchored in multiline mode, and a match for circumflex is possible +when the \fIstartoffset\fP argument of \fBpcre2_match()\fP is non-zero. The +PCRE2_DOLLAR_ENDONLY option is ignored if PCRE2_MULTILINE is set. +.P +When the newline convention (see +.\" HTML +.\" +"Newline conventions" +.\" +below) recognizes the two-character sequence CRLF as a newline, this is +preferred, even if the single characters CR and LF are also recognized as +newlines. For example, if the newline convention is "any", a multiline mode +circumflex matches before "xyz" in the string "abc\er\enxyz" rather than after +CR, even though CR on its own is a valid newline. (It also matches at the very +start of the string, of course.) +.P +Note that the sequences \eA, \eZ, and \ez can be used to match the start and +end of the subject in both modes, and if all branches of a pattern start with +\eA it is always anchored, whether or not PCRE2_MULTILINE is set. +. +. +.\" HTML +.SH "FULL STOP (PERIOD, DOT) AND \eN" +.rs +.sp +Outside a character class, a dot in the pattern matches any one character in +the subject string except (by default) a character that signifies the end of a +line. One or more characters may be specified as line terminators (see +.\" HTML +.\" +"Newline conventions" +.\" +above). +.P +Dot never matches a single line-ending character. When the two-character +sequence CRLF is the only line ending, dot does not match CR if it is +immediately followed by LF, but otherwise it matches all characters (including +isolated CRs and LFs). When ANYCRLF is selected for line endings, no occurrences +of CR of LF match dot. When all Unicode line endings are being recognized, dot +does not match CR or LF or any of the other line ending characters. +.P +The behaviour of dot with regard to newlines can be changed. If the +PCRE2_DOTALL option is set, a dot matches any one character, without exception. +If the two-character sequence CRLF is present in the subject string, it takes +two dots to match it. +.P +The handling of dot is entirely independent of the handling of circumflex and +dollar, the only relationship being that they both involve newlines. Dot has no +special meaning in a character class. +.P +The escape sequence \eN when not followed by an opening brace behaves like a +dot, except that it is not affected by the PCRE2_DOTALL option. In other words, +it matches any character except one that signifies the end of a line. +.P +When \eN is followed by an opening brace it has a different meaning. See the +section entitled +.\" HTML +.\" +"Non-printing characters" +.\" +above for details. Perl also uses \eN{name} to specify characters by Unicode +name; PCRE2 does not support this. +. +. +.SH "MATCHING A SINGLE CODE UNIT" +.rs +.sp +Outside a character class, the escape sequence \eC matches any one code unit, +whether or not a UTF mode is set. In the 8-bit library, one code unit is one +byte; in the 16-bit library it is a 16-bit unit; in the 32-bit library it is a +32-bit unit. Unlike a dot, \eC always matches line-ending characters. The +feature is provided in Perl in order to match individual bytes in UTF-8 mode, +but it is unclear how it can usefully be used. +.P +Because \eC breaks up characters into individual code units, matching one unit +with \eC in UTF-8 or UTF-16 mode means that the rest of the string may start +with a malformed UTF character. This has undefined results, because PCRE2 +assumes that it is matching character by character in a valid UTF string (by +default it checks the subject string's validity at the start of processing +unless the PCRE2_NO_UTF_CHECK or PCRE2_MATCH_INVALID_UTF option is used). +.P +An application can lock out the use of \eC by setting the +PCRE2_NEVER_BACKSLASH_C option when compiling a pattern. It is also possible to +build PCRE2 with the use of \eC permanently disabled. +.P +PCRE2 does not allow \eC to appear in lookbehind assertions +.\" HTML +.\" +(described below) +.\" +in UTF-8 or UTF-16 modes, because this would make it impossible to calculate +the length of the lookbehind. Neither the alternative matching function +\fBpcre2_dfa_match()\fP nor the JIT optimizer support \eC in these UTF modes. +The former gives a match-time error; the latter fails to optimize and so the +match is always run using the interpreter. +.P +In the 32-bit library, however, \eC is always supported (when not explicitly +locked out) because it always matches a single code unit, whether or not UTF-32 +is specified. +.P +In general, the \eC escape sequence is best avoided. However, one way of using +it that avoids the problem of malformed UTF-8 or UTF-16 characters is to use a +lookahead to check the length of the next character, as in this pattern, which +could be used with a UTF-8 string (ignore white space and line breaks): +.sp + (?| (?=[\ex00-\ex7f])(\eC) | + (?=[\ex80-\ex{7ff}])(\eC)(\eC) | + (?=[\ex{800}-\ex{ffff}])(\eC)(\eC)(\eC) | + (?=[\ex{10000}-\ex{1fffff}])(\eC)(\eC)(\eC)(\eC)) +.sp +In this example, a group that starts with (?| resets the capturing parentheses +numbers in each alternative (see +.\" HTML +.\" +"Duplicate Group Numbers" +.\" +below). The assertions at the start of each branch check the next UTF-8 +character for values whose encoding uses 1, 2, 3, or 4 bytes, respectively. The +character's individual bytes are then captured by the appropriate number of +\eC groups. +. +. +.\" HTML +.SH "SQUARE BRACKETS AND CHARACTER CLASSES" +.rs +.sp +An opening square bracket introduces a character class, terminated by a closing +square bracket. A closing square bracket on its own is not special by default. +If a closing square bracket is required as a member of the class, it should be +the first data character in the class (after an initial circumflex, if present) +or escaped with a backslash. This means that, by default, an empty class cannot +be defined. However, if the PCRE2_ALLOW_EMPTY_CLASS option is set, a closing +square bracket at the start does end the (empty) class. +.P +A character class matches a single character in the subject. A matched +character must be in the set of characters defined by the class, unless the +first character in the class definition is a circumflex, in which case the +subject character must not be in the set defined by the class. If a circumflex +is actually required as a member of the class, ensure it is not the first +character, or escape it with a backslash. +.P +For example, the character class [aeiou] matches any lower case English vowel, +whereas [^aeiou] matches all other characters. Note that a circumflex is just a +convenient notation for specifying the characters that are in the class by +enumerating those that are not. A class that starts with a circumflex is not an +assertion; it still consumes a character from the subject string, and therefore +it fails to match if the current pointer is at the end of the string. +.P +Characters in a class may be specified by their code points using \eo, \ex, or +\eN{U+hh..} in the usual way. When caseless matching is set, any letters in a +class represent both their upper case and lower case versions, so for example, +a caseless [aeiou] matches "A" as well as "a", and a caseless [^aeiou] does not +match "A", whereas a caseful version would. Note that there are two ASCII +characters, K and S, that, in addition to their lower case ASCII equivalents, +are case-equivalent with Unicode U+212A (Kelvin sign) and U+017F (long S) +respectively when either PCRE2_UTF or PCRE2_UCP is set. If you do not want +these ASCII/non-ASCII case equivalences, you can suppress them by setting +PCRE2_EXTRA_CASELESS_RESTRICT, either as an option in a compile context, or by +including (*CASELESS_RESTRICT) or (?r) within a pattern. +.P +Characters that might indicate line breaks are never treated in any special way +when matching character classes, whatever line-ending sequence is in use, and +whatever setting of the PCRE2_DOTALL and PCRE2_MULTILINE options is used. A +class such as [^a] always matches one of these characters. +.P +The generic character type escape sequences \ed, \eD, \eh, \eH, \ep, \eP, \es, +\eS, \ev, \eV, \ew, and \eW may appear in a character class, and add the +characters that they match to the class. For example, [\edABCDEF] matches any +hexadecimal digit. In UTF modes, the PCRE2_UCP option affects the meanings of +\ed, \es, \ew and their upper case partners, just as it does when they appear +outside a character class, as described in the section entitled +.\" HTML +.\" +"Generic character types" +.\" +above. The escape sequence \eb has a different meaning inside a character +class; it matches the backspace character. The sequences \eB, \eR, and \eX are +not special inside a character class. Like any other unrecognized escape +sequences, they cause an error. The same is true for \eN when not followed by +an opening brace. +.P +The minus (hyphen) character can be used to specify a range of characters in a +character class. For example, [d-m] matches any letter between d and m, +inclusive. If a minus character is required in a class, it must be escaped with +a backslash or appear in a position where it cannot be interpreted as +indicating a range, typically as the first or last character in the class, +or immediately after a range. For example, [b-d-z] matches letters in the range +b to d, a hyphen character, or z. +.P +There is some special treatment for alphabetic ranges in EBCDIC environments; +see the section +.\" HTML +.\" +"EBCDIC environments" +.\" +below. +.P +Perl treats a hyphen as a literal if it appears before or after a POSIX class +(see below) or before or after a character type escape such as \ed or \eH. +However, unless the hyphen is the last character in the class, Perl outputs a +warning in its warning mode, as this is most likely a user error. As PCRE2 has +no facility for warning, an error is given in these cases. +.P +It is not possible to have the literal character "]" as the end character of a +range. A pattern such as [W-]46] is interpreted as a class of two characters +("W" and "-") followed by a literal string "46]", so it would match "W46]" or +"-46]". However, if the "]" is escaped with a backslash it is interpreted as +the end of a range, so [W-\e]46] is interpreted as a class containing a range +and two other characters. The octal or hexadecimal representation of "]" can +also be used to end a range. +.P +Ranges normally include all code points between the start and end characters, +inclusive. They can also be used for code points specified numerically, for +example [\e000-\e037]. Ranges can include any characters that are valid for the +current mode. In any UTF mode, the so-called "surrogate" characters (those +whose code points lie between 0xd800 and 0xdfff inclusive) may not be specified +explicitly by default (the PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES option disables +this check). However, ranges such as [\ex{d7ff}-\ex{e000}], which include the +surrogates, are always permitted. +.P +If a range that includes letters is used when caseless matching is set, it +matches the letters in either case. For example, [W-c] is equivalent to +[][\e\e^_`wxyzabc], matched caselessly, and in a non-UTF mode, if character +tables for a French locale are in use, [\exc8-\excb] matches accented E +characters in both cases. +.P +A circumflex can conveniently be used with the upper case character types to +specify a more restricted set of characters than the matching lower case type. +For example, the class [^\eW_] matches any letter or digit, but not underscore, +whereas [\ew] includes underscore. A positive character class should be read as +"something OR something OR ..." and a negative class as "NOT something AND NOT +something AND NOT ...". +.P +The metacharacters that are recognized in character classes are backslash, +hyphen (when it can be interpreted as specifying a range), circumflex +(only at the start), and the terminating closing square bracket. An opening +square bracket is also special when it can be interpreted as introducing a +POSIX class (see +.\" HTML +.\" +"Posix character classes" +.\" +below), or a special compatibility feature (see +.\" HTML +.\" +"Compatibility feature for word boundaries" +.\" +below. Escaping any non-alphanumeric character in a class turns it into a +literal, whether or not it would otherwise be a metacharacter. +. +. +.SH "PERL EXTENDED CHARACTER CLASSES" +.rs +.sp +From release 10.45 PCRE2 supports Perl's (?[...]) extended character class +syntax. This can be used to perform set operations such as intersection on +character classes. +.P +The syntax permitted within (?[...]) is quite different to ordinary character +classes. Inside the extended class, there is an expression syntax consisting of +"atoms", operators, and ordinary parentheses "()" used for grouping. Such +classes always have the Perl /xx modifier (PCRE2 option PCRE2_EXTENDED_MORE) +turned on within them. This means that literal space and tab characters are +ignored everywhere in the class. +.P +The allowed atoms are individual characters specified by escape sequences such +as \en or \ex{123}, character types such as \ed, POSIX classes such as +[:alpha:], and nested ordinary (non-extended) character classes. For example, +in (?[\ed & [...]]) the nested class [...] follows the usual rules for ordinary +character classes, in which parentheses are not metacharacters, and character +literals and ranges are permitted. +.P +Character literals and ranges may not appear outside a nested ordinary +character class because they are not atoms in the extended syntax. The extended +syntax does not introduce any additional escape sequences, so (?[\ey]) is an +unknown escape, as it would be in [\ey]. +.P +In the extended syntax, ^ does not negate a class (except within an +ordinary class nested inside an extended class); it is instead a binary +operator. +.P +The binary operators are "&" (intersection), "|" or "+" (union), "-" +(subtraction) and "^" (symmetric difference). These are left-associative and +"&" has higher (tighter) precedence, while the others have equal lower +precedence. The one prefix unary operator is "!" (complement), with highest +precedence. +. +. +.SH "UTS#18 EXTENDED CHARACTER CLASSES" +.rs +.sp +The PCRE2_ALT_EXTENDED_CLASS option enables an alternative to Perl's (?[...]) +syntax, allowing instead extended class behaviour inside ordinary [...] +character classes. This altered syntax for [...] classes is loosely described +by the Unicode standard UTS#18. The PCRE2_ALT_EXTENDED_CLASS option does not +prevent use of (?[...]) classes; it just changes the meaning of all +[...] classes that are not nested inside a Perl (?[...]) class. +.P +Firstly, in ordinary Perl [...] syntax, an expression such as "[a[]" is a +character class with two literal characters "a" and "[", but in UTS#18 extended +classes the "[" character becomes an additional metacharacter within classes, +denoting the start of a nested class, so a literal "[" must be escaped as "\e[". +.P +Secondly, within the UTS#18 extended syntax, there are operators "||", "&&", +"--" and "~~" which denote character class union, intersection, subtraction, +and symmetric difference respectively. In standard Perl syntax, these would +simply be needlessly-repeated literals (except for "--" which could be the +start or end of a range). In UTS#18 extended classes these operators can be used +in constructs such as [\ep{L}--[QW]] for "Unicode letters, other than Q and W". +A literal "-" at the start or end of a range must be escaped, so while "[--1]" +in Perl syntax is the range from hyphen to "1", it must be escaped as "[\e--1]" +in UTS#18 extended classes. +.P +Unlike Perl's (?[...]) extended classes, the PCRE2_EXTENDED_MORE option to +ignore space and tab characters is not automatically enabled for UTS#18 +extended classes, but it is honoured if set. +.P +Extended UTS#18 classes can be nested, and nested classes are themselves +extended classes (unlike Perl, where nested classes must be simple classes). +For example, [\ep{L}&&[\ep{Thai}||\ep{Greek}]] matches any letter that is in +the Thai or Greek scripts. Note that this means that no special grouping +characters (such as the parentheses used in Perl's (?[...]) class syntax) are +needed. +.P +Individual class items (literal characters, literal ranges, properties such as +\ed or \ep{...}, and nested classes) can be combined by juxtaposition or by an +operator. Juxtaposition is the implicit union operator, and binds more tightly +than any explicit operator. Thus a sequence of literals and/or ranges behaves +as if it is enclosed in square brackets. For example, [A-Z0-9&&[^E8]] is the +same as [[A-Z0-9]&&[^E8]], which matches any upper case alphanumeric character +except "E" or "8". +.P +Precedence between the explicit operators is not defined, so mixing operators +is a syntax error. For example, [A&&B--C] is an error, but [A&&[B--C]] is +valid. +.P +This is an emerging syntax which is being adopted gradually across the regex +ecosystem: for example JavaScript adopted the "/v" flag in ECMAScript 2024; +Python's "re" module reserves the syntax for future use with a FutureWarning +for unescaped use of "[" as a literal within character classes. Due to UTS#18 +providing insufficient guidance, engines interpret the syntax differently. +Rust's "regex" crate and Python's "regex" PyPi module both implement UTS#18 +extended classes, but with slight incompatibilities ([A||B&&C] is parsed as +[A||[B&&C]] in Python's "regex" but as [[A||B]&&C] in Rust's "regex"). +.P +PCRE2's syntax adds syntax restrictions similar to ECMASCript's /v flag, so +that all the UTS#18 extended classes accepted as valid by PCRE2 have the +property that they are interpreted either with the same behaviour, or as +invalid, by all other major engines. Please file an issue if you are aware of +cross-engine differences in behaviour between PCRE2 and another major engine. +. +. +.\" HTML +.SH "POSIX CHARACTER CLASSES" +.rs +.sp +Perl supports the POSIX notation for character classes. This uses names +enclosed by [: and :] within the enclosing square brackets. PCRE2 also supports +this notation, in both ordinary and extended classes. For example, +.sp + [01[:alpha:]%] +.sp +matches "0", "1", any alphabetic character, or "%". The supported class names +are: +.sp + alnum letters and digits + alpha letters + ascii character codes 0 - 127 + blank space or tab only + cntrl control characters + digit decimal digits (same as \ed) + graph printing characters, excluding space + lower lower case letters + print printing characters, including space + punct printing characters, excluding letters and digits and space + space white space (the same as \es from PCRE2 8.34) + upper upper case letters + word "word" characters (same as \ew) + xdigit hexadecimal digits +.sp +The default "space" characters are HT (9), LF (10), VT (11), FF (12), CR (13), +and space (32). If locale-specific matching is taking place, the list of space +characters may be different; there may be fewer or more of them. "Space" and +\es match the same set of characters, as do "word" and \ew. +.P +The name "word" is a Perl extension, and "blank" is a GNU extension from Perl +5.8. Another Perl extension is negation, which is indicated by a ^ character +after the colon. For example, +.sp + [12[:^digit:]] +.sp +matches "1", "2", or any non-digit. PCRE2 (and Perl) also recognize the POSIX +syntax [.ch.] and [=ch=] where "ch" is a "collating element", but these are not +supported, and an error is given if they are encountered. +.P +By default, characters with values greater than 127 do not match any of the +POSIX character classes, although this may be different for characters in the +range 128-255 when locale-specific matching is happening. However, in UCP mode, +unless certain options are set (see below), some of the classes are changed so +that Unicode character properties are used. This is achieved by replacing +POSIX classes with other sequences, as follows: +.sp + [:alnum:] becomes \ep{Xan} + [:alpha:] becomes \ep{L} + [:blank:] becomes \eh + [:cntrl:] becomes \ep{Cc} + [:digit:] becomes \ep{Nd} + [:lower:] becomes \ep{Ll} + [:space:] becomes \ep{Xps} + [:upper:] becomes \ep{Lu} + [:word:] becomes \ep{Xwd} +.sp +Negated versions, such as [:^alpha:] use \eP instead of \ep. Four other POSIX +classes are handled specially in UCP mode: +.TP 10 +[:graph:] +This matches characters that have glyphs that mark the page when printed. In +Unicode property terms, it matches all characters with the L, M, N, P, S, or Cf +properties, except for: +.sp + U+061C Arabic Letter Mark + U+180E Mongolian Vowel Separator + U+2066 - U+2069 Various "isolate"s +.sp +.TP 10 +[:print:] +This matches the same characters as [:graph:] plus space characters that are +not controls, that is, characters with the Zs property. +.TP 10 +[:punct:] +This matches all characters that have the Unicode P (punctuation) property, +plus those characters with code points less than 256 that have the S (Symbol) +property. +.TP 10 +[:xdigit:] +In addition to the ASCII hexadecimal digits, this also matches the "fullwidth" +versions of those characters, whose Unicode code points start at U+FF10. This +is a change that was made in PCRE2 release 10.43 for Perl compatibility. +.P +The other POSIX classes are unchanged by PCRE2_UCP, and match only characters +with code points less than 256. +.P +There are two options that can be used to restrict the POSIX classes to ASCII +characters when PCRE2_UCP is set. The option PCRE2_EXTRA_ASCII_DIGIT affects +just [:digit:] and [:xdigit:]. Within a pattern, this can be set and unset by +(?aT) and (?-aT). The PCRE2_EXTRA_ASCII_POSIX option disables UCP processing +for all POSIX classes, including [:digit:] and [:xdigit:]. Within a pattern, +(?aP) and (?-aP) set and unset both these options for consistency. +. +. +.\" HTML +.SH "COMPATIBILITY FEATURE FOR WORD BOUNDARIES" +.rs +.sp +In the POSIX.2 compliant library that was included in 4.4BSD Unix, the ugly +syntax [[:<:]] and [[:>:]] is used for matching "start of word" and "end of +word". PCRE2 treats these items as follows: +.sp + [[:<:]] is converted to \eb(?=\ew) + [[:>:]] is converted to \eb(?<=\ew) +.sp +Only these exact character sequences are recognized. A sequence such as +[a[:<:]b] provokes error for an unrecognized POSIX class name. This support is +not compatible with Perl. It is provided to help migrations from other +environments, and is best not used in any new patterns. Note that \eb matches +at the start and the end of a word (see +.\" HTML +.\" +"Simple assertions" +.\" +above), and in a Perl-style pattern the preceding or following character +normally shows which is wanted, without the need for the assertions that are +used above in order to give exactly the POSIX behaviour. Note also that the +PCRE2_UCP option changes the meaning of \ew (and therefore \eb) by default, so +it also affects these POSIX sequences. +. +. +.SH "VERTICAL BAR" +.rs +.sp +Vertical bar characters are used to separate alternative patterns. For example, +the pattern +.sp + gilbert|sullivan +.sp +matches either "gilbert" or "sullivan". Any number of alternatives may appear, +and an empty alternative is permitted (matching the empty string). The matching +process tries each alternative in turn, from left to right, and the first one +that succeeds is used. If the alternatives are within a group +.\" HTML +.\" +(defined below), +.\" +"succeeds" means matching the rest of the main pattern as well as the +alternative in the group. +. +. +.\" HTML +.SH "INTERNAL OPTION SETTING" +.rs +.sp +The settings of several options can be changed within a pattern by a sequence +of letters enclosed between "(?" and ")". The following are Perl-compatible, +and are described in detail in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. The option letters are: +.sp + i for PCRE2_CASELESS + m for PCRE2_MULTILINE + n for PCRE2_NO_AUTO_CAPTURE + s for PCRE2_DOTALL + x for PCRE2_EXTENDED + xx for PCRE2_EXTENDED_MORE +.sp +For example, (?im) sets caseless, multiline matching. It is also possible to +unset these options by preceding the relevant letters with a hyphen, for +example (?-im). The two "extended" options are not independent; unsetting +either one cancels the effects of both of them. +.P +A combined setting and unsetting such as (?im-sx), which sets PCRE2_CASELESS +and PCRE2_MULTILINE while unsetting PCRE2_DOTALL and PCRE2_EXTENDED, is also +permitted. Only one hyphen may appear in the options string. If a letter +appears both before and after the hyphen, the option is unset. An empty options +setting "(?)" is allowed. Needless to say, it has no effect. +.P +If the first character following (? is a circumflex, it causes all of the above +options to be unset. Letters may follow the circumflex to cause some options to +be re-instated, but a hyphen may not appear. +.P +Some PCRE2-specific options can be changed by the same mechanism using these +pairs or individual letters: +.sp + aD for PCRE2_EXTRA_ASCII_BSD + aS for PCRE2_EXTRA_ASCII_BSS + aW for PCRE2_EXTRA_ASCII_BSW + aP for PCRE2_EXTRA_ASCII_POSIX and PCRE2_EXTRA_ASCII_DIGIT + aT for PCRE2_EXTRA_ASCII_DIGIT + r for PCRE2_EXTRA_CASELESS_RESTRICT + J for PCRE2_DUPNAMES + U for PCRE2_UNGREEDY +.sp +However, except for 'r', these are not unset by (?^), which is equivalent to +(?-imnrsx). If 'a' is not followed by any of the upper case letters shown +above, it sets (or unsets) all the ASCII options. +.P +PCRE2_EXTRA_ASCII_DIGIT has no additional effect when PCRE2_EXTRA_ASCII_POSIX +is set, but including it in (?aP) means that (?-aP) suppresses all ASCII +restrictions for POSIX classes. +.P +When one of these option changes occurs at top level (that is, not inside group +parentheses), the change applies until a subsequent change, or the end of the +pattern. An option change within a group (see below for a description of +groups) affects only that part of the group that follows it. At the end of the +group these options are reset to the state they were before the group. For +example, +.sp + (a(?i)b)c +.sp +matches abc and aBc and no other strings (assuming PCRE2_CASELESS is not set +externally). Any changes made in one alternative do carry on into subsequent +branches within the same group. For example, +.sp + (a(?i)b|c) +.sp +matches "ab", "aB", "c", and "C", even though when matching "C" the first +branch is abandoned before the option setting. This is because the effects of +option settings happen at compile time. There would be some very weird +behaviour otherwise. +.P +As a convenient shorthand, if any option settings are required at the start of +a non-capturing group (see the next section), the option letters may +appear between the "?" and the ":". Thus the two patterns +.sp + (?i:saturday|sunday) + (?:(?i)saturday|sunday) +.sp +match exactly the same set of strings. +.P +\fBNote:\fP There are other PCRE2-specific options, applying to the whole +pattern, which can be set by the application when the compiling function is +called. In addition, the pattern can contain special leading sequences such as +(*CRLF) to override what the application has set or what has been defaulted. +Details are given in the section entitled +.\" HTML +.\" +"Newline sequences" +.\" +above. There are also the (*UTF) and (*UCP) leading sequences that can be used +to set UTF and Unicode property modes; they are equivalent to setting the +PCRE2_UTF and PCRE2_UCP options, respectively. However, the application can set +the PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options, which lock out the use of the +(*UTF) and (*UCP) sequences. +. +. +.\" HTML +.SH GROUPS +.rs +.sp +Groups are delimited by parentheses (round brackets), which can be nested. +Turning part of a pattern into a group does two things: +.sp +1. It localizes a set of alternatives. For example, the pattern +.sp + cat(aract|erpillar|) +.sp +matches "cataract", "caterpillar", or "cat". Without the parentheses, it would +match "cataract", "erpillar" or an empty string. +.sp +2. It creates a "capture group". This means that, when the whole pattern +matches, the portion of the subject string that matched the group is passed +back to the caller, separately from the portion that matched the whole pattern. +(This applies only to the traditional matching function; the DFA matching +function does not support capturing.) +.P +Opening parentheses are counted from left to right (starting from 1) to obtain +numbers for capture groups. For example, if the string "the red king" is +matched against the pattern +.sp + the ((red|white) (king|queen)) +.sp +the captured substrings are "red king", "red", and "king", and are numbered 1, +2, and 3, respectively. +.P +The fact that plain parentheses fulfil two functions is not always helpful. +There are often times when grouping is required without capturing. If an +opening parenthesis is followed by a question mark and a colon, the group +does not do any capturing, and is not counted when computing the number of any +subsequent capture groups. For example, if the string "the white queen" +is matched against the pattern +.sp + the ((?:red|white) (king|queen)) +.sp +the captured substrings are "white queen" and "queen", and are numbered 1 and +2. The maximum number of capture groups is 65535. +.P +As a convenient shorthand, if any option settings are required at the start of +a non-capturing group, the option letters may appear between the "?" and the +":". Thus the two patterns +.sp + (?i:saturday|sunday) + (?:(?i)saturday|sunday) +.sp +match exactly the same set of strings. Because alternative branches are tried +from left to right, and options are not reset until the end of the group is +reached, an option setting in one branch does affect subsequent branches, so +the above patterns match "SUNDAY" as well as "Saturday". +. +. +.\" HTML +.SH "DUPLICATE GROUP NUMBERS" +.rs +.sp +Perl 5.10 introduced a feature whereby each alternative in a group uses the +same numbers for its capturing parentheses. Such a group starts with (?| and is +itself a non-capturing group. For example, consider this pattern: +.sp + (?|(Sat)ur|(Sun))day +.sp +Because the two alternatives are inside a (?| group, both sets of capturing +parentheses are numbered one. Thus, when the pattern matches, you can look +at captured substring number one, whichever alternative matched. This construct +is useful when you want to capture part, but not all, of one of a number of +alternatives. Inside a (?| group, parentheses are numbered as usual, but the +number is reset at the start of each branch. The numbers of any capturing +parentheses that follow the whole group start after the highest number used in +any branch. The following example is taken from the Perl documentation. The +numbers underneath show in which buffer the captured content will be stored. +.sp + # before ---------------branch-reset----------- after + / ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x + # 1 2 2 3 2 3 4 +.sp +A backreference to a capture group uses the most recent value that is set for +the group. The following pattern matches "abcabc" or "defdef": +.sp + /(?|(abc)|(def))\e1/ +.sp +In contrast, a subroutine call to a capture group always refers to the +first one in the pattern with the given number. The following pattern matches +"abcabc" or "defabc": +.sp + /(?|(abc)|(def))(?1)/ +.sp +A relative reference such as (?-1) is no different: it is just a convenient way +of computing an absolute group number. +.P +If a +.\" HTML +.\" +condition test +.\" +for a group's having matched refers to a non-unique number, the test is +true if any group with that number has matched. +.P +An alternative approach to using this "branch reset" feature is to use +duplicate named groups, as described in the next section. +. +. +.SH "NAMED CAPTURE GROUPS" +.rs +.sp +Identifying capture groups by number is simple, but it can be very hard to keep +track of the numbers in complicated patterns. Furthermore, if an expression is +modified, the numbers may change. To help with this difficulty, PCRE2 supports +the naming of capture groups. This feature was not added to Perl until release +5.10. Python had the feature earlier, and PCRE1 introduced it at release 4.0, +using the Python syntax. PCRE2 supports both the Perl and the Python syntax. +.P +In PCRE2, a capture group can be named in one of three ways: (?...) or +(?'name'...) as in Perl, or (?P...) as in Python. Names may be up to 128 +code units long. When PCRE2_UTF is not set, they may contain only ASCII +alphanumeric characters and underscores, but must start with a non-digit. When +PCRE2_UTF is set, the syntax of group names is extended to allow any Unicode +letter or Unicode decimal digit. In other words, group names must match one of +these patterns: +.sp + ^[_A-Za-z][_A-Za-z0-9]*\ez when PCRE2_UTF is not set + ^[_\ep{L}][_\ep{L}\ep{Nd}]*\ez when PCRE2_UTF is set +.sp +References to capture groups from other parts of the pattern, such as +.\" HTML +.\" +backreferences, +.\" +.\" HTML +.\" +recursion, +.\" +and +.\" HTML +.\" +conditions, +.\" +can all be made by name as well as by number. +.P +Named capture groups are allocated numbers as well as names, exactly as +if the names were not present. In both PCRE2 and Perl, capture groups +are primarily identified by numbers; any names are just aliases for these +numbers. The PCRE2 API provides function calls for extracting the complete +name-to-number translation table from a compiled pattern, as well as +convenience functions for extracting captured substrings by name. +.P +\fBWarning:\fP When more than one capture group has the same number, as +described in the previous section, a name given to one of them applies to all +of them. Perl allows identically numbered groups to have different names. +Consider this pattern, where there are two capture groups, both numbered 1: +.sp + (?|(?aa)|(?bb)) +.sp +Perl allows this, with both names AA and BB as aliases of group 1. Thus, after +a successful match, both names yield the same value (either "aa" or "bb"). +.P +In an attempt to reduce confusion, PCRE2 does not allow the same group number +to be associated with more than one name. The example above provokes a +compile-time error. However, there is still scope for confusion. Consider this +pattern: +.sp + (?|(?aa)|(bb)) +.sp +Although the second group number 1 is not explicitly named, the name AA is +still an alias for any group 1. Whether the pattern matches "aa" or "bb", a +reference by name to group AA yields the matched string. +.P +By default, a name must be unique within a pattern, except that duplicate names +are permitted for groups with the same number, for example: +.sp + (?|(?aa)|(?bb)) +.sp +The duplicate name constraint can be disabled by setting the PCRE2_DUPNAMES +option at compile time, or by the use of (?J) within the pattern, as described +in the section entitled +.\" HTML +.\" +"Internal Option Setting" +.\" +above. +.P +Duplicate names can be useful for patterns where only one instance of the named +capture group can match. Suppose you want to match the name of a weekday, +either as a 3-letter abbreviation or as the full name, and in both cases you +want to extract the abbreviation. This pattern (ignoring the line breaks) does +the job: +.sp + (?J) + (?Mon|Fri|Sun)(?:day)?| + (?Tue)(?:sday)?| + (?Wed)(?:nesday)?| + (?Thu)(?:rsday)?| + (?Sat)(?:urday)? +.sp +There are five capture groups, but only one is ever set after a match. The +convenience functions for extracting the data by name returns the substring for +the first (and in this example, the only) group of that name that matched. This +saves searching to find which numbered group it was. (An alternative way of +solving this problem is to use a "branch reset" group, as described in the +previous section.) +.P +If you make a backreference to a non-unique named group from elsewhere in the +pattern, the groups to which the name refers are checked in the order in which +they appear in the overall pattern. The first one that is set is used for the +reference. For example, this pattern matches both "foofoo" and "barbar" but not +"foobar" or "barfoo": +.sp + (?J)(?:(?foo)|(?bar))\ek +.sp +.P +If you make a subroutine call to a non-unique named group, the one that +corresponds to the first occurrence of the name is used. In the absence of +duplicate numbers this is the one with the lowest number. +.P +If you use a named reference in a condition +test (see the +.\" +.\" HTML +.\" +section about conditions +.\" +below), either to check whether a capture group has matched, or to check for +recursion, all groups with the same name are tested. If the condition is true +for any one of them, the overall condition is true. This is the same behaviour +as testing by number. For further details of the interfaces for handling named +capture groups, see the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +. +. +.SH REPETITION +.rs +.sp +Repetition is specified by quantifiers, which may follow any one of these +items: +.sp + a literal data character + the dot metacharacter + the \eC escape sequence + the \eR escape sequence + the \eX escape sequence + any escape sequence that matches a single character + a character class + a backreference + a parenthesized group (including lookaround assertions) + a subroutine call (recursive or otherwise) +.sp +If a quantifier does not follow a repeatable item, an error occurs. The +general repetition quantifier specifies a minimum and maximum number of +permitted matches by giving two numbers in curly brackets (braces), separated +by a comma. The numbers must be less than 65536, and the first must be less +than or equal to the second. For example, +.sp + z{2,4} +.sp +matches "zz", "zzz", or "zzzz". A closing brace on its own is not a special +character. If the second number is omitted, but the comma is present, there is +no upper limit; if the second number and the comma are both omitted, the +quantifier specifies an exact number of required matches. Thus +.sp + [aeiou]{3,} +.sp +matches at least 3 successive vowels, but may match many more, whereas +.sp + \ed{8} +.sp +matches exactly 8 digits. If the first number is omitted, the lower limit is +taken as zero; in this case the upper limit must be present. +.sp + X{,4} is interpreted as X{0,4} +.sp +This is a change in behaviour that happened in Perl 5.34.0 and PCRE2 10.43. In +earlier versions such a sequence was not interpreted as a quantifier. Other +regular expression engines may behave either way. +.P +If the characters that follow an opening brace do not match the syntax of a +quantifier, the brace is taken as a literal character. In particular, this +means that {,} is a literal string of three characters. +.P +Note that not every opening brace is potentially the start of a quantifier +because braces are used in other items such as \eN{U+345} or \ek{name}. +.P +In UTF modes, quantifiers apply to characters rather than to individual code +units. Thus, for example, \ex{100}{2} matches two characters, each of +which is represented by a two-byte sequence in a UTF-8 string. Similarly, +\eX{3} matches three Unicode extended grapheme clusters, each of which may be +several code units long (and they may be of different lengths). +.P +The quantifier {0} is permitted, causing the expression to behave as if the +previous item and the quantifier were not present. This may be useful for +capture groups that are referenced as +.\" HTML +.\" +subroutines +.\" +from elsewhere in the pattern (but see also the section entitled +.\" HTML +.\" +"Defining capture groups for use by reference only" +.\" +below). Except for parenthesized groups, items that have a {0} quantifier are +omitted from the compiled pattern. +.P +For convenience, the three most common quantifiers have single-character +abbreviations: +.sp + * is equivalent to {0,} + + is equivalent to {1,} + ? is equivalent to {0,1} +.sp +It is possible to construct infinite loops by following a group that can match +no characters with a quantifier that has no upper limit, for example: +.sp + (a?)* +.sp +Earlier versions of Perl and PCRE1 used to give an error at compile time for +such patterns. However, because there are cases where this can be useful, such +patterns are now accepted, but whenever an iteration of such a group matches no +characters, matching moves on to the next item in the pattern instead of +repeatedly matching an empty string. This does not prevent backtracking into +any of the iterations if a subsequent item fails to match. +.P +By default, quantifiers are "greedy", that is, they match as much as possible +(up to the maximum number of permitted repetitions), without causing the rest +of the pattern to fail. The classic example of where this gives problems is in +trying to match comments in C programs. These appear between /* and */ and +within the comment, individual * and / characters may appear. An attempt to +match C comments by applying the pattern +.sp + /\e*.*\e*/ +.sp +to the string +.sp + /* first comment */ not comment /* second comment */ +.sp +fails, because it matches the entire string owing to the greediness of the .* +item. However, if a quantifier is followed by a question mark, it ceases to be +greedy, and instead matches the minimum number of times possible, so the +pattern +.sp + /\e*.*?\e*/ +.sp +does the right thing with C comments. The meaning of the various quantifiers is +not otherwise changed, just the preferred number of matches. Do not confuse +this use of question mark with its use as a quantifier in its own right. +Because it has two uses, it can sometimes appear doubled, as in +.sp + \ed??\ed +.sp +which matches one digit by preference, but can match two if that is the only +way the rest of the pattern matches. +.P +If the PCRE2_UNGREEDY option is set (an option that is not available in Perl), +the quantifiers are not greedy by default, but individual ones can be made +greedy by following them with a question mark. In other words, it inverts the +default behaviour. +.P +When a parenthesized group is quantified with a minimum repeat count that +is greater than 1 or with a limited maximum, more memory is required for the +compiled pattern, in proportion to the size of the minimum or maximum. +.P +If a pattern starts with .* or .{0,} and the PCRE2_DOTALL option (equivalent +to Perl's /s) is set, thus allowing the dot to match newlines, the pattern is +implicitly anchored, because whatever follows will be tried against every +character position in the subject string, so there is no point in retrying the +overall match at any position after the first. PCRE2 normally treats such a +pattern as though it were preceded by \eA. +.P +In cases where it is known that the subject string contains no newlines, it is +worth setting PCRE2_DOTALL in order to obtain this optimization, or +alternatively, using ^ to indicate anchoring explicitly. +.P +However, there are some cases where the optimization cannot be used. When .* +is inside capturing parentheses that are the subject of a backreference +elsewhere in the pattern, a match at the start may fail where a later one +succeeds. Consider, for example: +.sp + (.*)abc\e1 +.sp +If the subject is "xyz123abc123" the match point is the fourth character. For +this reason, such a pattern is not implicitly anchored. +.P +Another case where implicit anchoring is not applied is when the leading .* is +inside an atomic group. Once again, a match at the start may fail where a later +one succeeds. Consider this pattern: +.sp + (?>.*?a)b +.sp +It matches "ab" in the subject "aab". The use of the backtracking control verbs +(*PRUNE) and (*SKIP) also disable this optimization. To do so explicitly, +either pass the compile option PCRE2_NO_DOTSTAR_ANCHOR, or call +\fBpcre2_set_optimize()\fP with a PCRE2_DOTSTAR_ANCHOR_OFF directive. +.P +When a capture group is repeated, the value captured is the substring that +matched the final iteration. For example, after +.sp + (tweedle[dume]{3}\es*)+ +.sp +has matched "tweedledum tweedledee" the value of the captured substring is +"tweedledee". However, if there are nested capture groups, the corresponding +captured values may have been set in previous iterations. For example, after +.sp + (a|(b))+ +.sp +matches "aba" the value of the second captured substring is "b". +. +. +.\" HTML +.SH "ATOMIC GROUPING AND POSSESSIVE QUANTIFIERS" +.rs +.sp +With both maximizing ("greedy") and minimizing ("ungreedy" or "lazy") +repetition, failure of what follows normally causes the repeated item to be +re-evaluated to see if a different number of repeats allows the rest of the +pattern to match. Sometimes it is useful to prevent this, either to change the +nature of the match, or to cause it fail earlier than it otherwise might, when +the author of the pattern knows there is no point in carrying on. +.P +Consider, for example, the pattern \ed+foo when applied to the subject line +.sp + 123456bar +.sp +After matching all 6 digits and then failing to match "foo", the normal +action of the matcher is to try again with only 5 digits matching the \ed+ +item, and then with 4, and so on, before ultimately failing. "Atomic grouping" +(a term taken from Jeffrey Friedl's book) provides the means for specifying +that once a group has matched, it is not to be re-evaluated in this way. +.P +If we use atomic grouping for the previous example, the matcher gives up +immediately on failing to match "foo" the first time. The notation is a kind of +special parenthesis, starting with (?> as in this example: +.sp + (?>\ed+)foo +.sp +Perl 5.28 introduced an experimental alphabetic form starting with (* which may +be easier to remember: +.sp + (*atomic:\ed+)foo +.sp +This kind of parenthesized group "locks up" the part of the pattern it contains +once it has matched, and a failure further into the pattern is prevented from +backtracking into it. Backtracking past it to previous items, however, works as +normal. +.P +An alternative description is that a group of this type matches exactly the +string of characters that an identical standalone pattern would match, if +anchored at the current point in the subject string. +.P +Atomic groups are not capture groups. Simple cases such as the above example +can be thought of as a maximizing repeat that must swallow everything it can. +So, while both \ed+ and \ed+? are prepared to adjust the number of digits they +match in order to make the rest of the pattern match, (?>\ed+) can only match +an entire sequence of digits. +.P +Atomic groups in general can of course contain arbitrarily complicated +expressions, and can be nested. However, when the contents of an atomic +group is just a single repeated item, as in the example above, a simpler +notation, called a "possessive quantifier" can be used. This consists of an +additional + character following a quantifier. Using this notation, the +previous example can be rewritten as +.sp + \ed++foo +.sp +Note that a possessive quantifier can be used with an entire group, for +example: +.sp + (abc|xyz){2,3}+ +.sp +Possessive quantifiers are always greedy; the setting of the PCRE2_UNGREEDY +option is ignored. They are a convenient notation for the simpler forms of +atomic group. However, there is no difference in the meaning of a possessive +quantifier and the equivalent atomic group, though there may be a performance +difference; possessive quantifiers should be slightly faster. +.P +The possessive quantifier syntax is an extension to the Perl 5.8 syntax. +Jeffrey Friedl originated the idea (and the name) in the first edition of his +book. Mike McCloskey liked it, so implemented it when he built Sun's Java +package, and PCRE1 copied it from there. It found its way into Perl at release +5.10. +.P +PCRE2 has an optimization that automatically "possessifies" certain simple +pattern constructs. For example, the sequence A+B is treated as A++B because +there is no point in backtracking into a sequence of A's when B must follow. +This feature can be disabled by the PCRE2_NO_AUTO_POSSESS option, by calling +\fBpcre2_set_optimize()\fP with a PCRE2_AUTO_POSSESS_OFF directive, or by +starting the pattern with (*NO_AUTO_POSSESS). +.P +When a pattern contains an unlimited repeat inside a group that can itself be +repeated an unlimited number of times, the use of an atomic group is the only +way to avoid some failing matches taking a very long time indeed. The pattern +.sp + (\eD+|<\ed+>)*[!?] +.sp +matches an unlimited number of substrings that either consist of non-digits, or +digits enclosed in <>, followed by either ! or ?. When it matches, it runs +quickly. However, if it is applied to +.sp + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +.sp +it takes a long time before reporting failure. This is because the string can +be divided between the internal \eD+ repeat and the external * repeat in a +large number of ways, and all have to be tried. (The example uses [!?] rather +than a single character at the end, because both PCRE2 and Perl have an +optimization that allows for fast failure when a single character is used. They +remember the last single character that is required for a match, and fail early +if it is not present in the string.) If the pattern is changed so that it uses +an atomic group, like this: +.sp + ((?>\eD+)|<\ed+>)*[!?] +.sp +sequences of non-digits cannot be broken, and failure happens quickly. +. +. +.\" HTML +.SH "BACKREFERENCES" +.rs +.sp +Outside a character class, a backslash followed by a digit greater than 0 (and +possibly further digits) is a backreference to a capture group earlier (that +is, to its left) in the pattern, provided there have been that many previous +capture groups. +.P +However, if the decimal number following the backslash is less than 8, it is +always taken as a backreference, and causes an error only if there are not that +many capture groups in the entire pattern. In other words, the group that is +referenced need not be to the left of the reference for numbers less than 8. A +"forward backreference" of this type can make sense when a repetition is +involved and the group to the right has participated in an earlier iteration. +.P +It is not possible to have a numerical "forward backreference" to a group whose +number is 8 or more using this syntax because a sequence such as \e50 is +interpreted as a character defined in octal. See the subsection entitled +"Non-printing characters" +.\" HTML +.\" +above +.\" +for further details of the handling of digits following a backslash. Other +forms of backreferencing do not suffer from this restriction. In particular, +there is no problem when named capture groups are used (see below). +.P +Another way of avoiding the ambiguity inherent in the use of digits following a +backslash is to use the \eg escape sequence. This escape must be followed by a +signed or unsigned number, optionally enclosed in braces. These examples are +all identical: +.sp + (ring), \e1 + (ring), \eg1 + (ring), \eg{1} +.sp +An unsigned number specifies an absolute reference without the ambiguity that +is present in the older syntax. It is also useful when literal digits follow +the reference. A signed number is a relative reference. Consider this example: +.sp + (abc(def)ghi)\eg{-1} +.sp +The sequence \eg{-1} is a reference to the capture group whose number is one +less than the number of the next group to be started, so in this example (where +the next group would be numbered 3) is it equivalent to \e2, and \eg{-2} would +be equivalent to \e1. Note that if this construct is inside a capture group, +that group is included in the count, so in this example \eg{-2} also refers to +group 1: +.sp + (A)(\eg{-2}B) +.sp +The use of relative references can be helpful in long patterns, and also in +patterns that are created by joining together fragments that contain references +within themselves. +.P +The sequence \eg{+1} is a reference to the next capture group that is started +after this item, and \eg{+2} refers to the one after that, and so on. This kind +of forward reference can be useful in patterns that repeat. Perl does not +support the use of + in this way. +.P +A backreference matches whatever actually most recently matched the capture +group in the current subject string, rather than anything at all that matches +the group (see +.\" HTML +.\" +"Groups as subroutines" +.\" +below for a way of doing that). So the pattern +.sp + (sens|respons)e and \e1ibility +.sp +matches "sense and sensibility" and "response and responsibility", but not +"sense and responsibility". If caseful matching is in force at the time of the +backreference, the case of letters is relevant. For example, +.sp + ((?i)rah)\es+\e1 +.sp +matches "rah rah" and "RAH RAH", but not "RAH rah", even though the original +capture group is matched caselessly. +.P +There are several different ways of writing backreferences to named capture +groups. The .NET syntax is \ek{name}, the Python syntax is (?=name), and the +original Perl syntax is \ek or \ek'name'. All of these are now supported +by both Perl and PCRE2. Perl 5.10's unified backreference syntax, in which \eg +can be used for both numeric and named references, is also supported by PCRE2. +We could rewrite the above example in any of the following ways: +.sp + (?(?i)rah)\es+\ek + (?'p1'(?i)rah)\es+\ek{p1} + (?P(?i)rah)\es+(?P=p1) + (?(?i)rah)\es+\eg{p1} +.sp +A capture group that is referenced by name may appear in the pattern before or +after the reference. +.P +There may be more than one backreference to the same group. If a group has not +actually been used in a particular match, backreferences to it always fail by +default. For example, the pattern +.sp + (a|(bc))\e2 +.sp +always fails if it starts to match "a" rather than "bc". However, if the +PCRE2_MATCH_UNSET_BACKREF option is set at compile time, a backreference to an +unset value matches an empty string. +.P +Because there may be many capture groups in a pattern, all digits following a +backslash are taken as part of a potential backreference number. If the pattern +continues with a digit character, some delimiter must be used to terminate the +backreference. If the PCRE2_EXTENDED or PCRE2_EXTENDED_MORE option is set, this +can be white space. Otherwise, the \eg{} syntax or an empty comment (see +.\" HTML +.\" +"Comments" +.\" +below) can be used. +. +. +.SS "Recursive backreferences" +.rs +.sp +A backreference that occurs inside the group to which it refers fails when the +group is first used, so, for example, (a\e1) never matches. However, such +references can be useful inside repeated groups. For example, the pattern +.sp + (a|b\e1)+ +.sp +matches any number of "a"s and also "aba", "ababbaa" etc. At each iteration of +the group, the backreference matches the character string corresponding to the +previous iteration. In order for this to work, the pattern must be such that +the first iteration does not need to match the backreference. This can be done +using alternation, as in the example above, or by a quantifier with a minimum +of zero. +.P +For versions of PCRE2 less than 10.25, backreferences of this type used to +cause the group that they reference to be treated as an +.\" HTML +.\" +atomic group. +.\" +This restriction no longer applies, and backtracking into such groups can occur +as normal. +. +. +.\" HTML +.SH ASSERTIONS +.rs +.sp +An assertion is a test that does not consume any characters. The test must +succeed for the match to continue. The simple assertions coded as \eb, \eB, +\eA, \eG, \eZ, \ez, ^ and $ are described +.\" HTML +.\" +above. +.\" +.P +More complicated assertions are coded as parenthesized groups. If matching such +a group succeeds, matching continues after it, but with the matching position +in the subject string reset to what it was before the assertion was processed. +.P +A special kind of assertion, called a "scan substring" assertion, matches a +subpattern against a previously captured substring. This is described in the +section entitled +.\" HTML +.\" +"Scan substring assertions" +.\" +below. It is a PCRE2 extension, not compatible with Perl. +.P +The other goup-based assertions are of two kinds: those that look ahead of the +current position in the subject string, and those that look behind it, and in +each case an assertion may be positive (must match for the assertion to be +true) or negative (must not match for the assertion to be true). +.P +The Perl-compatible lookaround assertions are atomic. If an assertion is true, +but there is a subsequent matching failure, there is no backtracking into the +assertion. However, there are some cases where non-atomic assertions can be +useful. PCRE2 has some support for these, described in the section entitled +.\" HTML +.\" +"Non-atomic assertions" +.\" +below, but they are not Perl-compatible. +.P +A lookaround assertion may appear as the condition in a +.\" HTML +.\" +conditional group +.\" +(see below). In this case, the result of matching the assertion determines +which branch of the condition is followed. +.P +Assertion groups are not capture groups. If an assertion contains capture +groups within it, these are counted for the purposes of numbering the capture +groups in the whole pattern. Within each branch of an assertion, locally +captured substrings may be referenced in the usual way. For example, a sequence +such as (.)\eg{-1} can be used to check that two adjacent characters are the +same. +.P +When a branch within an assertion fails to match, any substrings that were +captured are discarded (as happens with any pattern branch that fails to +match). A negative assertion is true only when all its branches fail to match; +this means that no captured substrings are ever retained after a successful +negative assertion. When an assertion contains a matching branch, what happens +depends on the type of assertion. +.P +For a positive assertion, internally captured substrings in the successful +branch are retained, and matching continues with the next pattern item after +the assertion. For a negative assertion, a matching branch means that the +assertion is not true. If such an assertion is being used as a condition in a +.\" HTML +.\" +conditional group +.\" +(see below), captured substrings are retained, because matching continues with +the "no" branch of the condition. For other failing negative assertions, +control passes to the previous backtracking point, thus discarding any captured +strings within the assertion. +.P +Most assertion groups may be repeated; though it makes no sense to assert the +same thing several times, the side effect of capturing in positive assertions +may occasionally be useful. However, an assertion that forms the condition for +a conditional group may not be quantified. PCRE2 used to restrict the +repetition of assertions, but from release 10.35 the only restriction is that +an unlimited maximum repetition is changed to be one more than the minimum. For +example, {3,} is treated as {3,4}. +. +. +.SS "Alphabetic assertion names" +.rs +.sp +Traditionally, symbolic sequences such as (?= and (?<= have been used to +specify lookaround assertions. Perl 5.28 introduced some experimental +alphabetic alternatives which might be easier to remember. They all start with +(* instead of (? and must be written using lower case letters. PCRE2 supports +the following synonyms: +.sp + (*positive_lookahead: or (*pla: is the same as (?= + (*negative_lookahead: or (*nla: is the same as (?! + (*positive_lookbehind: or (*plb: is the same as (?<= + (*negative_lookbehind: or (*nlb: is the same as (? +.SS "Lookbehind assertions" +.rs +.sp +Lookbehind assertions start with (?<= for positive assertions and (? +.\" +(see above) +.\" +can be used instead of a lookbehind assertion at the start of a pattern to get +round the length limit restriction. +.P +In UTF-8 and UTF-16 modes, PCRE2 does not allow the \eC escape (which matches a +single code unit even in a UTF mode) to appear in lookbehind assertions, +because it makes it impossible to calculate the length of the lookbehind. The +\eX and \eR escapes, which can match different numbers of code units, are never +permitted in lookbehinds. +.P +.\" HTML +.\" +"Subroutine" +.\" +calls (see below) such as (?2) or (?&X) are permitted in lookbehinds, as long +as the called capture group matches a limited-length string. However, +.\" HTML +.\" +recursion, +.\" +that is, a "subroutine" call into a group that is already active, +is not supported. +.P +PCRE2 supports backreferences in lookbehinds, but only if certain conditions +are met. The PCRE2_MATCH_UNSET_BACKREF option must not be set, there must be no +use of (?| in the pattern (it creates duplicate group numbers), and if the +backreference is by name, the name must be unique. Of course, the referenced +group must itself match a limited length substring. The following pattern +matches words containing at least two characters that begin and end with the +same character: +.sp + \eb(\ew)\ew++(?<=\e1) +.P +Possessive quantifiers can be used in conjunction with lookbehind assertions to +specify efficient matching at the end of subject strings. Consider a simple +pattern such as +.sp + abcd$ +.sp +when applied to a long string that does not match. Because matching proceeds +from left to right, PCRE2 will look for each "a" in the subject and then see if +what follows matches the rest of the pattern. If the pattern is specified as +.sp + ^.*abcd$ +.sp +the initial .* matches the entire string at first, but when this fails (because +there is no following "a"), it backtracks to match all but the last character, +then all but the last two characters, and so on. Once again the search for "a" +covers the entire string, from right to left, so we are no better off. However, +if the pattern is written as +.sp + ^.*+(?<=abcd) +.sp +there can be no backtracking for the .*+ item because of the possessive +quantifier; it can match only the entire string. The subsequent lookbehind +assertion does a single test on the last four characters. If it fails, the +match fails immediately. For long strings, this approach makes a significant +difference to the processing time. +. +. +.SS "Using multiple assertions" +.rs +.sp +Several assertions (of any sort) may occur in succession. For example, +.sp + (?<=\ed{3})(? +.SH "NON-ATOMIC ASSERTIONS" +.rs +.sp +Traditional lookaround assertions are atomic. That is, if an assertion is true, +but there is a subsequent matching failure, there is no backtracking into the +assertion. However, there are some cases where non-atomic positive assertions +can be useful. PCRE2 provides these using the following syntax: +.sp + (*non_atomic_positive_lookahead: or (*napla: or (?* + (*non_atomic_positive_lookbehind: or (*naplb: or (?<* +.sp +Consider the problem of finding the right-most word in a string that also +appears earlier in the string, that is, it must appear at least twice in total. +This pattern returns the required result as captured substring 1: +.sp + ^(?x)(*napla: .* \eb(\ew++)) (?> .*? \eb\e1\eb ){2} +.sp +For a subject such as "word1 word2 word3 word2 word3 word4" the result is +"word3". How does it work? At the start, ^(?x) anchors the pattern and sets the +"x" option, which causes white space (introduced for readability) to be +ignored. Inside the assertion, the greedy .* at first consumes the entire +string, but then has to backtrack until the rest of the assertion can match a +word, which is captured by group 1. In other words, when the assertion first +succeeds, it captures the right-most word in the string. +.P +The current matching point is then reset to the start of the subject, and the +rest of the pattern match checks for two occurrences of the captured word, +using an ungreedy .*? to scan from the left. If this succeeds, we are done, but +if the last word in the string does not occur twice, this part of the pattern +fails. If a traditional atomic lookahead (?= or (*pla: had been used, the +assertion could not be re-entered, and the whole match would fail. The pattern +would succeed only if the very last word in the subject was found twice. +.P +Using a non-atomic lookahead, however, means that when the last word does not +occur twice in the string, the lookahead can backtrack and find the second-last +word, and so on, until either the match succeeds, or all words have been +tested. +.P +Two conditions must be met for a non-atomic assertion to be useful: the +contents of one or more capturing groups must change after a backtrack into the +assertion, and there must be a backreference to a changed group later in the +pattern. If this is not the case, the rest of the pattern match fails exactly +as before because nothing has changed, so using a non-atomic assertion just +wastes resources. +.P +There is one exception to backtracking into a non-atomic assertion. If an +(*ACCEPT) control verb is triggered, the assertion succeeds atomically. That +is, a subsequent match failure cannot backtrack into the assertion. +.P +Non-atomic assertions are not supported by the alternative matching function +\fBpcre2_dfa_match()\fP. They are supported by JIT, but only if they do not +contain any control verbs such as (*ACCEPT). (This may change in future). Note +that assertions that appear as conditions for +.\" HTML +.\" +conditional groups +.\" +(see below) must be atomic. +. +. +.\" HTML +.SH "SCAN SUBSTRING ASSERTIONS" +.rs +.sp +A special kind of assertion, not compatible with Perl, makes it possible to +check the contents of a captured substring by matching it with a subpattern. +Because this involves capturing, this feature is not supported by +\fBpcre2_dfa_match()\fP. +.P +A scan substring assertion starts with the sequence (*scan_substring: or +(*scs: which is followed by a list of substring numbers (absolute or relative) +and/or substring names enclosed in single quotes or angle brackets, all within +parentheses. The rest of the item is the subpattern that is applied to the +substring, as shown in these examples: +.sp + (*scan_substring:(1)...) + (*scs:(-2)...) + (*scs:('AB')...) + (*scs:(1,'AB',-2)...) +.sp +The list of groups is checked in the order they are given, and it is the +contents of the first one that is found to be set that are scanned. When +PCRE2_DUPNAMES is set and there are ambiguous group names, all groups with the +same name are checked in numerical order. A scan substring assertion fails if +none of the groups it references have been set. +.P +The pattern match on the substring is always anchored, that is, it must match +from the start of the substring. There is no "bumpalong" if it does not match +at the start. The end of the subject is temporarily reset to be the end of the +substring, so \eZ, \ez, and $ will match there. However, the start of the +subject is \fInot\fP reset. This means that ^ matches only if the substring is +actually at the start of the main subject, but it also means that lookbehind +assertions into what precedes the substring are possible. +.P +Here is a very simple example: find a word that contains the rare (in English) +sequence of letters "rh" not at the start: +.sp + \eb(\ew++)(*scs:(1).+rh) +.sp +The first group captures a word which is then scanned by the second group. +This example does not actually need this heavyweight feature; the same match +can be achieved with: +.sp + \eb\ew+?rh\ew*\eb +.sp +When things are more complicated, however, scanning a captured substring can be +a useful way to describe the required match. For exmple, there is a rather +complicated pattern in the PCRE2 test data that checks an entire subject string +for a palindrome, that is, the sequence of letters is the same in both +directions. Suppose you want to search for individual words of two or more +characters such as "level" that are palindromes: +.sp + (\eb\ew{2,}+\eb)(*scs:(1)...palindrome-matching-pattern...) +.sp +Within a substring scanning subpattern, references to other groups work as +normal. Capturing groups may appear, and will retain their values during +ongoing matching if the assertion succeeds. +. +. +.SH "SCRIPT RUNS" +.rs +.sp +In concept, a script run is a sequence of characters that are all from the same +Unicode script such as Latin or Greek. However, because some scripts are +commonly used together, and because some diacritical and other marks are used +with multiple scripts, it is not that simple. There is a full description of +the rules that PCRE2 uses in the section entitled +.\" HTML +.\" +"Script Runs" +.\" +in the +.\" HREF +\fBpcre2unicode\fP +.\" +documentation. +.P +If part of a pattern is enclosed between (*script_run: or (*sr: and a closing +parenthesis, it fails if the sequence of characters that it matches are not a +script run. After a failure, normal backtracking occurs. Script runs can be +used to detect spoofing attacks using characters that look the same, but are +from different scripts. The string "paypal.com" is an infamous example, where +the letters could be a mixture of Latin and Cyrillic. This pattern ensures that +the matched characters in a sequence of non-spaces that follow white space are +a script run: +.sp + \es+(*sr:\eS+) +.sp +To be sure that they are all from the Latin script (for example), a lookahead +can be used: +.sp + \es+(?=\ep{Latin})(*sr:\eS+) +.sp +This works as long as the first character is expected to be a character in that +script, and not (for example) punctuation, which is allowed with any script. If +this is not the case, a more creative lookahead is needed. For example, if +digits, underscore, and dots are permitted at the start: +.sp + \es+(?=[0-9_.]*\ep{Latin})(*sr:\eS+) +.sp +.P +In many cases, backtracking into a script run pattern fragment is not +desirable. The script run can employ an atomic group to prevent this. Because +this is a common requirement, a shorthand notation is provided by +(*atomic_script_run: or (*asr: +.sp + (*asr:...) is the same as (*sr:(?>...)) +.sp +Note that the atomic group is inside the script run. Putting it outside would +not prevent backtracking into the script run pattern. +.P +Support for script runs is not available if PCRE2 is compiled without Unicode +support. A compile-time error is given if any of the above constructs is +encountered. Script runs are not supported by the alternate matching function, +\fBpcre2_dfa_match()\fP because they use the same mechanism as capturing +parentheses. +.P +\fBWarning:\fP The (*ACCEPT) control verb +.\" HTML +.\" +(see below) +.\" +should not be used within a script run group, because it causes an immediate +exit from the group, bypassing the script run checking. +. +. +.\" HTML +.SH "CONDITIONAL GROUPS" +.rs +.sp +It is possible to cause the matching process to obey a pattern fragment +conditionally or to choose between two alternative fragments, depending on +the result of an assertion, or whether a specific capture group has +already been matched. The two possible forms of conditional group are: +.sp + (?(condition)yes-pattern) + (?(condition)yes-pattern|no-pattern) +.sp +If the condition is satisfied, the yes-pattern is used; otherwise the +no-pattern (if present) is used. An absent no-pattern is equivalent to an empty +string (it always matches). If there are more than two alternatives in the +group, a compile-time error occurs. Each of the two alternatives may itself +contain nested groups of any form, including conditional groups; the +restriction to two alternatives applies only at the level of the condition +itself. This pattern fragment is an example where the alternatives are complex: +.sp + (?(1) (A|B|C) | (D | (?(2)E|F) | E) ) +.sp +.P +There are five kinds of condition: references to capture groups, references to +recursion, two pseudo-conditions called DEFINE and VERSION, and assertions. +. +. +.SS "Checking for a used capture group by number" +.rs +.sp +If the text between the parentheses consists of a sequence of digits, the +condition is true if a capture group of that number has previously matched. If +there is more than one capture group with the same number (see the earlier +.\" +.\" HTML +.\" +section about duplicate group numbers), +.\" +the condition is true if any of them have matched. An alternative notation, +which is a PCRE2 extension, not supported by Perl, is to precede the digits +with a plus or minus sign. In this case, the group number is relative rather +than absolute. The most recently opened capture group (which could be enclosing +this condition) can be referenced by (?(-1), the next most recent by (?(-2), +and so on. Inside loops it can also make sense to refer to subsequent groups. +The next capture group to be opened can be referenced as (?(+1), and so on. The +value zero in any of these forms is not used; it provokes a compile-time error. +.P +Consider the following pattern, which contains non-significant white space to +make it more readable (assume the PCRE2_EXTENDED option) and to divide it into +three parts for ease of discussion: +.sp + ( \e( )? [^()]+ (?(1) \e) ) +.sp +The first part matches an optional opening parenthesis, and if that +character is present, sets it as the first captured substring. The second part +matches one or more characters that are not parentheses. The third part is a +conditional group that tests whether or not the first capture group +matched. If it did, that is, if subject started with an opening parenthesis, +the condition is true, and so the yes-pattern is executed and a closing +parenthesis is required. Otherwise, since no-pattern is not present, the +conditional group matches nothing. In other words, this pattern matches a +sequence of non-parentheses, optionally enclosed in parentheses. +.P +If you were embedding this pattern in a larger one, you could use a relative +reference: +.sp + ...other stuff... ( \e( )? [^()]+ (?(-1) \e) ) ... +.sp +This makes the fragment independent of the parentheses in the larger pattern. +. +. +.SS "Checking for a used capture group by name" +.rs +.sp +Perl uses the syntax (?()...) or (?('name')...) to test for a used +capture group by name. For compatibility with earlier versions of PCRE1, which +had this facility before Perl, the syntax (?(name)...) is also recognized. +Note, however, that undelimited names consisting of the letter R followed by +digits are ambiguous (see the following section). Rewriting the above example +to use a named group gives this: +.sp + (? \e( )? [^()]+ (?() \e) ) +.sp +If the name used in a condition of this kind is a duplicate, the test is +applied to all groups of the same name, and is true if any one of them has +matched. +. +. +.SS "Checking for pattern recursion" +.rs +.sp +"Recursion" in this sense refers to any subroutine-like call from one part of +the pattern to another, whether or not it is actually recursive. See the +sections entitled +.\" HTML +.\" +"Recursive patterns" +.\" +and +.\" HTML +.\" +"Groups as subroutines" +.\" +below for details of recursion and subroutine calls. +.P +If a condition is the string (R), and there is no capture group with the name +R, the condition is true if matching is currently in a recursion or subroutine +call to the whole pattern or any capture group. If digits follow the letter R, +and there is no group with that name, the condition is true if the most recent +call is into a group with the given number, which must exist somewhere in the +overall pattern. This is a contrived example that is equivalent to a+b: +.sp + ((?(R1)a+|(?1)b)) +.sp +However, in both cases, if there is a capture group with a matching name, the +condition tests for its being set, as described in the section above, instead +of testing for recursion. For example, creating a group with the name R1 by +adding (?) to the above pattern completely changes its meaning. +.P +If a name preceded by ampersand follows the letter R, for example: +.sp + (?(R&name)...) +.sp +the condition is true if the most recent recursion is into a group of that name +(which must exist within the pattern). +.P +This condition does not check the entire recursion stack. It tests only the +current level. If the name used in a condition of this kind is a duplicate, the +test is applied to all groups of the same name, and is true if any one of +them is the most recent recursion. +.P +At "top level", all these recursion test conditions are false. +. +. +.\" HTML +.SS "Defining capture groups for use by reference only" +.rs +.sp +If the condition is the string (DEFINE), the condition is always false, even if +there is a group with the name DEFINE. In this case, there may be only one +alternative in the rest of the conditional group. It is always skipped if +control reaches this point in the pattern; the idea of DEFINE is that it can be +used to define subroutines that can be referenced from elsewhere. (The use of +.\" HTML +.\" +subroutines +.\" +is described below.) For example, a pattern to match an IPv4 address such as +"192.168.23.245" could be written like this (ignore white space and line +breaks): +.sp + (?(DEFINE) (? 2[0-4]\ed | 25[0-5] | 1\ed\ed | [1-9]?\ed) ) + \eb (?&byte) (\e.(?&byte)){3} \eb +.sp +The first part of the pattern is a DEFINE group inside which another group +named "byte" is defined. This matches an individual component of an IPv4 +address (a number less than 256). When matching takes place, this part of the +pattern is skipped because DEFINE acts like a false condition. The rest of the +pattern uses references to the named group to match the four dot-separated +components of an IPv4 address, insisting on a word boundary at each end. +. +. +.SS "Checking the PCRE2 version" +.rs +.sp +Programs that link with a PCRE2 library can check the version by calling +\fBpcre2_config()\fP with appropriate arguments. Users of applications that do +not have access to the underlying code cannot do this. A special "condition" +called VERSION exists to allow such users to discover which version of PCRE2 +they are dealing with by using this condition to match a string such as +"yesno". VERSION must be followed either by "=" or ">=" and a version number. +For example: +.sp + (?(VERSION>=10.4)yes|no) +.sp +This pattern matches "yes" if the PCRE2 version is greater or equal to 10.4, or +"no" otherwise. The fractional part of the version number may not contain more +than two digits. +. +. +.SS "Assertion conditions" +.rs +.sp +If the condition is not in any of the above formats, it must be a parenthesized +assertion. This may be a positive or negative lookahead or lookbehind +assertion. However, it must be a traditional atomic assertion, not one of the +.\" HTML +.\" +non-atomic assertions. +.\" +.P +Consider this pattern, again containing non-significant white space, and with +the two alternatives on the second line: +.sp + (?(?=[^a-z]*[a-z]) + \ed{2}-[a-z]{3}-\ed{2} | \ed{2}-\ed{2}-\ed{2} ) +.sp +The condition is a positive lookahead assertion that matches an optional +sequence of non-letters followed by a letter. In other words, it tests for the +presence of at least one letter in the subject. If a letter is found, the +subject is matched against the first alternative; otherwise it is matched +against the second. This pattern matches strings in one of the two forms +dd-aaa-dd or dd-dd-dd, where aaa are letters and dd are digits. +.P +When an assertion that is a condition contains capture groups, any +capturing that occurs in a matching branch is retained afterwards, for both +positive and negative assertions, because matching always continues after the +assertion, whether it succeeds or fails. (Compare non-conditional assertions, +for which captures are retained only for positive assertions that succeed.) +. +. +.\" HTML +.SH COMMENTS +.rs +.sp +There are two ways of including comments in patterns that are processed by +PCRE2. In both cases, the start of the comment must not be in a character +class, nor in the middle of any other sequence of related characters such as +(?: or a group name or number or a Unicode property name. The characters that +make up a comment play no part in the pattern matching. +.P +The sequence (?# marks the start of a comment that continues up to the next +closing parenthesis. Nested parentheses are not permitted. If the +PCRE2_EXTENDED or PCRE2_EXTENDED_MORE option is set, an unescaped # character +also introduces a comment, which in this case continues to immediately after +the next newline character or character sequence in the pattern. Which +characters are interpreted as newlines is controlled by an option passed to the +compiling function or by a special sequence at the start of the pattern, as +described in the section entitled +.\" HTML +.\" +"Newline conventions" +.\" +above. Note that the end of this type of comment is a literal newline sequence +in the pattern; escape sequences that happen to represent a newline do not +count. For example, consider this pattern when PCRE2_EXTENDED is set, and the +default newline convention (a single linefeed character) is in force: +.sp + abc #comment \en still comment +.sp +On encountering the # character, \fBpcre2_compile()\fP skips along, looking for +a newline in the pattern. The sequence \en is still literal at this stage, so +it does not terminate the comment. Only an actual character with the code value +0x0a (the default newline) does so. +. +. +.\" HTML +.SH "RECURSIVE PATTERNS" +.rs +.sp +Consider the problem of matching a string in parentheses, allowing for +unlimited nested parentheses. Without the use of recursion, the best that can +be done is to use a pattern that matches up to some fixed depth of nesting. It +is not possible to handle an arbitrary nesting depth. +.P +For some time, Perl has provided a facility that allows regular expressions to +recurse (amongst other things). It does this by interpolating Perl code in the +expression at run time, and the code can refer to the expression itself. A Perl +pattern using code interpolation to solve the parentheses problem can be +created like this: +.sp + $re = qr{\e( (?: (?>[^()]+) | (?p{$re}) )* \e)}x; +.sp +The (?p{...}) item interpolates Perl code at run time, and in this case refers +recursively to the pattern in which it appears. +.P +Obviously, PCRE2 cannot support the interpolation of Perl code. Instead, it +supports special syntax for recursion of the entire pattern, and also for +individual capture group recursion. After its introduction in PCRE1 and Python, +this kind of recursion was subsequently introduced into Perl at release 5.10. +.P +A special item that consists of (? followed by a number greater than zero and a +closing parenthesis is a recursive subroutine call of the capture group of the +given number, provided that it occurs inside that group. (If not, it is a +.\" HTML +.\" +non-recursive subroutine +.\" +call, which is described in the next section.) The special item (?R) or (?0) is +a recursive call of the entire regular expression. +.P +This PCRE2 pattern solves the nested parentheses problem (assume the +PCRE2_EXTENDED option is set so that white space is ignored): +.sp + \e( ( [^()]++ | (?R) )* \e) +.sp +First it matches an opening parenthesis. Then it matches any number of +substrings which can either be a sequence of non-parentheses, or a recursive +match of the pattern itself (that is, a correctly parenthesized substring). +Finally there is a closing parenthesis. Note the use of a possessive quantifier +to avoid backtracking into sequences of non-parentheses. +.P +If this were part of a larger pattern, you would not want to recurse the entire +pattern, so instead you could use this: +.sp + ( \e( ( [^()]++ | (?1) )* \e) ) +.sp +We have put the pattern into parentheses, and caused the recursion to refer to +them instead of the whole pattern. +.P +In a larger pattern, keeping track of parenthesis numbers can be tricky. This +is made easier by the use of relative references. Instead of (?1) in the +pattern above you can write (?-2) to refer to the second most recently opened +parentheses preceding the recursion. In other words, a negative number counts +capturing parentheses leftwards from the point at which it is encountered. +.P +Be aware however, that if +.\" HTML +.\" +duplicate capture group numbers +.\" +are in use, relative references refer to the earliest group with the +appropriate number. Consider, for example: +.sp + (?|(a)|(b)) (c) (?-2) +.sp +The first two capture groups (a) and (b) are both numbered 1, and group (c) +is number 2. When the reference (?-2) is encountered, the second most recently +opened parentheses has the number 1, but it is the first such group (the (a) +group) to which the recursion refers. This would be the same if an absolute +reference (?1) was used. In other words, relative references are just a +shorthand for computing a group number. +.P +It is also possible to refer to subsequent capture groups, by writing +references such as (?+2). However, these cannot be recursive because the +reference is not inside the parentheses that are referenced. They are always +.\" HTML +.\" +non-recursive subroutine +.\" +calls, as described in the next section. +.P +An alternative approach is to use named parentheses. The Perl syntax for this +is (?&name); PCRE1's earlier syntax (?P>name) is also supported. We could +rewrite the above example as follows: +.sp + (? \e( ( [^()]++ | (?&pn) )* \e) ) +.sp +If there is more than one group with the same name, the earliest one is +used. +.P +The example pattern that we have been looking at contains nested unlimited +repeats, and so the use of a possessive quantifier for matching strings of +non-parentheses is important when applying the pattern to strings that do not +match. For example, when this pattern is applied to +.sp + (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa() +.sp +it yields "no match" quickly. However, if a possessive quantifier is not used, +the match runs for a very long time indeed because there are so many different +ways the + and * repeats can carve up the subject, and all have to be tested +before failure can be reported. +.P +At the end of a match, the values of capturing parentheses are those from +the outermost level. If you want to obtain intermediate values, a callout +function can be used (see below and the +.\" HREF +\fBpcre2callout\fP +.\" +documentation). If the pattern above is matched against +.sp + (ab(cd)ef) +.sp +the value for the inner capturing parentheses (numbered 2) is "ef", which is +the last value taken on at the top level. If a capture group is not matched at +the top level, its final captured value is unset, even if it was (temporarily) +set at a deeper level during the matching process. +.P +Do not confuse the (?R) item with the condition (R), which tests for recursion. +Consider this pattern, which matches text in angle brackets, allowing for +arbitrary nesting. Only digits are allowed in nested brackets (that is, when +recursing), whereas any characters are permitted at the outer level. +.sp + < (?: (?(R) \ed++ | [^<>]*+) | (?R)) * > +.sp +In this pattern, (?(R) is the start of a conditional group, with two different +alternatives for the recursive and non-recursive cases. The (?R) item is the +actual recursive call. +. +. +.\" HTML +.SS "Differences in recursion processing between PCRE2 and Perl" +.rs +.sp +Some former differences between PCRE2 and Perl no longer exist. +.P +Before release 10.30, recursion processing in PCRE2 differed from Perl in that +a recursive subroutine call was always treated as an atomic group. That is, +once it had matched some of the subject string, it was never re-entered, even +if it contained untried alternatives and there was a subsequent matching +failure. (Historical note: PCRE implemented recursion before Perl did.) +.P +Starting with release 10.30, recursive subroutine calls are no longer treated +as atomic. That is, they can be re-entered to try unused alternatives if there +is a matching failure later in the pattern. This is now compatible with the way +Perl works. If you want a subroutine call to be atomic, you must explicitly +enclose it in an atomic group. +.P +Supporting backtracking into recursions simplifies certain types of recursive +pattern. For example, this pattern matches palindromic strings: +.sp + ^((.)(?1)\e2|.?)$ +.sp +The second branch in the group matches a single central character in the +palindrome when there are an odd number of characters, or nothing when there +are an even number of characters, but in order to work it has to be able to try +the second case when the rest of the pattern match fails. If you want to match +typical palindromic phrases, the pattern has to ignore all non-word characters, +which can be done like this: +.sp + ^\eW*+((.)\eW*+(?1)\eW*+\e2|\eW*+.?)\eW*+$ +.sp +If run with the PCRE2_CASELESS option, this pattern matches phrases such as "A +man, a plan, a canal: Panama!". Note the use of the possessive quantifier *+ to +avoid backtracking into sequences of non-word characters. Without this, PCRE2 +takes a great deal longer (ten times or more) to match typical phrases, and +Perl takes so long that you think it has gone into a loop. +.P +Another way in which PCRE2 and Perl used to differ in their recursion +processing is in the handling of captured values. Formerly in Perl, when a +group was called recursively or as a subroutine (see the next section), it +had no access to any values that were captured outside the recursion, whereas +in PCRE2 these values can be referenced. Consider this pattern: +.sp + ^(.)(\e1|a(?2)) +.sp +This pattern matches "bab". The first capturing parentheses match "b", then in +the second group, when the backreference \e1 fails to match "b", the second +alternative matches "a" and then recurses. In the recursion, \e1 does now match +"b" and so the whole match succeeds. This match used to fail in Perl, but in +later versions (I tried 5.024) it now works. +. +. +.\" HTML +.SH "GROUPS AS SUBROUTINES" +.rs +.sp +If the syntax for a recursive group call (either by number or by name) is used +outside the parentheses to which it refers, it operates a bit like a subroutine +in a programming language. More accurately, PCRE2 treats the referenced group +as an independent subpattern which it tries to match at the current matching +position. The called group may be defined before or after the reference. A +numbered reference can be absolute or relative, as in these examples: +.sp + (...(absolute)...)...(?2)... + (...(relative)...)...(?-1)... + (...(?+1)...(relative)... +.sp +An earlier example pointed out that the pattern +.sp + (sens|respons)e and \e1ibility +.sp +matches "sense and sensibility" and "response and responsibility", but not +"sense and responsibility". If instead the pattern +.sp + (sens|respons)e and (?1)ibility +.sp +is used, it does match "sense and responsibility" as well as the other two +strings. Another example is given in the discussion of DEFINE above. +.P +Like recursions, subroutine calls used to be treated as atomic, but this +changed at PCRE2 release 10.30, so backtracking into subroutine calls can now +occur. However, any capturing parentheses that are set during the subroutine +call revert to their previous values afterwards. +.P +Processing options such as case-independence are fixed when a group is +defined, so if it is used as a subroutine, such options cannot be changed for +different calls. For example, consider this pattern: +.sp + (abc)(?i:(?-1)) +.sp +It matches "abcabc". It does not match "abcABC" because the change of +processing option does not affect the called group. +.P +The behaviour of +.\" HTML +.\" +backtracking control verbs +.\" +in groups when called as subroutines is described in the section entitled +.\" HTML +.\" +"Backtracking verbs in subroutines" +.\" +below. +. +. +.\" HTML +.SH "ONIGURUMA SUBROUTINE SYNTAX" +.rs +.sp +For compatibility with Oniguruma, the non-Perl syntax \eg followed by a name or +a number enclosed either in angle brackets or single quotes, is an alternative +syntax for calling a group as a subroutine, possibly recursively. Here are two +of the examples used above, rewritten using this syntax: +.sp + (? \e( ( (?>[^()]+) | \eg )* \e) ) + (sens|respons)e and \eg'1'ibility +.sp +PCRE2 supports an extension to Oniguruma: if a number is preceded by a +plus or a minus sign it is taken as a relative reference. For example: +.sp + (abc)(?i:\eg<-1>) +.sp +Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP +synonymous. The former is a backreference; the latter is a subroutine call. +. +. +.SH CALLOUTS +.rs +.sp +Perl has a feature whereby using the sequence (?{...}) causes arbitrary Perl +code to be obeyed in the middle of matching a regular expression. This makes it +possible, amongst other things, to extract different substrings that match the +same pair of parentheses when there is a repetition. +.P +PCRE2 provides a similar feature, but of course it cannot obey arbitrary Perl +code. The feature is called "callout". The caller of PCRE2 provides an external +function by putting its entry point in a match context using the function +\fBpcre2_set_callout()\fP, and then passing that context to \fBpcre2_match()\fP +or \fBpcre2_dfa_match()\fP. If no match context is passed, or if the callout +entry point is set to NULL, callout points will be passed over silently during +matching. To disallow callouts in the pattern syntax, you may use the +PCRE2_EXTRA_NEVER_CALLOUT option. +.P +Within a regular expression, (?C) indicates a point at which the external +function is to be called. There are two kinds of callout: those with a +numerical argument and those with a string argument. (?C) on its own with no +argument is treated as (?C0). A numerical argument allows the application to +distinguish between different callouts. String arguments were added for release +10.20 to make it possible for script languages that use PCRE2 to embed short +scripts within patterns in a similar way to Perl. +.P +During matching, when PCRE2 reaches a callout point, the external function is +called. It is provided with the number or string argument of the callout, the +position in the pattern, and one item of data that is also set in the match +block. The callout function may cause matching to proceed, to backtrack, or to +fail. +.P +By default, PCRE2 implements a number of optimizations at matching time, and +one side-effect is that sometimes callouts are skipped. If you need all +possible callouts to happen, you need to set options that disable the relevant +optimizations. More details, including a complete description of the +programming interface to the callout function, are given in the +.\" HREF +\fBpcre2callout\fP +.\" +documentation. +. +. +.SS "Callouts with numerical arguments" +.rs +.sp +If you just want to have a means of identifying different callout points, put a +number less than 256 after the letter C. For example, this pattern has two +callout points: +.sp + (?C1)abc(?C2)def +.sp +If the PCRE2_AUTO_CALLOUT flag is passed to \fBpcre2_compile()\fP, numerical +callouts are automatically installed before each item in the pattern. They are +all numbered 255. If there is a conditional group in the pattern whose +condition is an assertion, an additional callout is inserted just before the +condition. An explicit callout may also be set at this position, as in this +example: +.sp + (?(?C9)(?=a)abc|def) +.sp +Note that this applies only to assertion conditions, not to other types of +condition. +. +. +.SS "Callouts with string arguments" +.rs +.sp +A delimited string may be used instead of a number as a callout argument. The +starting delimiter must be one of ` ' " ^ % # $ { and the ending delimiter is +the same as the start, except for {, where the ending delimiter is }. If the +ending delimiter is needed within the string, it must be doubled. For +example: +.sp + (?C'ab ''c'' d')xyz(?C{any text})pqr +.sp +The doubling is removed before the string is passed to the callout function. +. +. +.\" HTML +.SH "BACKTRACKING CONTROL" +.rs +.sp +There are a number of special "Backtracking Control Verbs" (to use Perl's +terminology) that modify the behaviour of backtracking during matching. They +are generally of the form (*VERB) or (*VERB:NAME). Some verbs take either form, +and may behave differently depending on whether or not a name argument is +present. The names are not required to be unique within the pattern. +.P +By default, for compatibility with Perl, a name is any sequence of characters +that does not include a closing parenthesis. The name is not processed in +any way, and it is not possible to include a closing parenthesis in the name. +This can be changed by setting the PCRE2_ALT_VERBNAMES option, but the result +is no longer Perl-compatible. +.P +When PCRE2_ALT_VERBNAMES is set, backslash processing is applied to verb names +and only an unescaped closing parenthesis terminates the name. However, the +only backslash items that are permitted are \eQ, \eE, and sequences such as +\ex{100} that define character code points. Character type escapes such as \ed +are faulted. +.P +A closing parenthesis can be included in a name either as \e) or between \eQ +and \eE. In addition to backslash processing, if the PCRE2_EXTENDED or +PCRE2_EXTENDED_MORE option is also set, unescaped whitespace in verb names is +skipped, and #-comments are recognized, exactly as in the rest of the pattern. +PCRE2_EXTENDED and PCRE2_EXTENDED_MORE do not affect verb names unless +PCRE2_ALT_VERBNAMES is also set. +.P +The maximum length of a name is 255 in the 8-bit library and 65535 in the +16-bit and 32-bit libraries. If the name is empty, that is, if the closing +parenthesis immediately follows the colon, the effect is as if the colon were +not there. Any number of these verbs may occur in a pattern. Except for +(*ACCEPT), they may not be quantified. +.P +Since these verbs are specifically related to backtracking, most of them can be +used only when the pattern is to be matched using the traditional matching +function or JIT, because they use backtracking algorithms. With the exception +of (*FAIL), which behaves like a failing negative assertion, the backtracking +control verbs cause an error if encountered by the DFA matching function. +.P +The behaviour of these verbs in +.\" HTML +.\" +repeated groups, +.\" +.\" HTML +.\" +assertions, +.\" +and in +.\" HTML +.\" +capture groups called as subroutines +.\" +(whether or not recursively) is documented below. +. +. +.\" HTML +.SS "Optimizations that affect backtracking verbs" +.rs +.sp +PCRE2 contains some optimizations that are used to speed up matching by running +some checks at the start of each match attempt. For example, it may know the +minimum length of matching subject, or that a particular character must be +present. When one of these optimizations bypasses the running of a match, any +included backtracking verbs will not, of course, be processed. You can suppress +the start-of-match optimizations by setting the PCRE2_NO_START_OPTIMIZE option +when calling \fBpcre2_compile()\fP, by calling \fBpcre2_set_optimize()\fP with a +PCRE2_START_OPTIMIZE_OFF directive, or by starting the pattern with +(*NO_START_OPT). There is more discussion of this option in the section +entitled +.\" HTML +.\" +"Compiling a pattern" +.\" +in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +.P +Experiments with Perl suggest that it too has similar optimizations, and like +PCRE2, turning them off can change the result of a match. +. +. +.\" HTML +.SS "Verbs that act immediately" +.rs +.sp +The following verbs act as soon as they are encountered. +.sp + (*ACCEPT) or (*ACCEPT:NAME) +.sp +This verb causes the match to end successfully, skipping the remainder of the +pattern. However, when it is inside a capture group that is called as a +subroutine, only that group is ended successfully. Matching then continues +at the outer level. If (*ACCEPT) in triggered in a positive assertion, the +assertion succeeds; in a negative assertion, the assertion fails. +.P +If (*ACCEPT) is inside capturing parentheses, the data so far is captured. For +example: +.sp + A((?:A|B(*ACCEPT)|C)D) +.sp +This matches "AB", "AAD", or "ACD"; when it matches "AB", "B" is captured by +the outer parentheses. +.P +(*ACCEPT) is the only backtracking verb that is allowed to be quantified +because an ungreedy quantification with a minimum of zero acts only when a +backtrack happens. Consider, for example, +.sp + (A(*ACCEPT)??B)C +.sp +where A, B, and C may be complex expressions. After matching "A", the matcher +processes "BC"; if that fails, causing a backtrack, (*ACCEPT) is triggered and +the match succeeds. In both cases, all but C is captured. Whereas (*COMMIT) +(see below) means "fail on backtrack", a repeated (*ACCEPT) of this type means +"succeed on backtrack". +.P +\fBWarning:\fP (*ACCEPT) should not be used within a script run group, because +it causes an immediate exit from the group, bypassing the script run checking. +.sp + (*FAIL) or (*FAIL:NAME) +.sp +This verb causes a matching failure, forcing backtracking to occur. It may be +abbreviated to (*F). It is equivalent to (?!) but easier to read. The Perl +documentation notes that it is probably useful only when combined with (?{}) or +(??{}). Those are, of course, Perl features that are not present in PCRE2. The +nearest equivalent is the callout feature, as for example in this pattern: +.sp + a+(?C)(*FAIL) +.sp +A match with the string "aaaa" always fails, but the callout is taken before +each backtrack happens (in this example, 10 times). +.P +(*ACCEPT:NAME) and (*FAIL:NAME) behave the same as (*MARK:NAME)(*ACCEPT) and +(*MARK:NAME)(*FAIL), respectively, that is, a (*MARK) is recorded just before +the verb acts. +. +. +.SS "Recording which path was taken" +.rs +.sp +There is one verb whose main purpose is to track how a match was arrived at, +though it also has a secondary use in conjunction with advancing the match +starting point (see (*SKIP) below). +.sp + (*MARK:NAME) or (*:NAME) +.sp +A name is always required with this verb. For all the other backtracking +control verbs, a NAME argument is optional. +.P +When a match succeeds, the name of the last-encountered mark name on the +matching path is passed back to the caller as described in the section entitled +.\" HTML +.\" +"Other information about the match" +.\" +in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. This applies to all instances of (*MARK) and other verbs, +including those inside assertions and atomic groups. However, there are +differences in those cases when (*MARK) is used in conjunction with (*SKIP) as +described below. +.P +The mark name that was last encountered on the matching path is passed back. A +verb without a NAME argument is ignored for this purpose. Here is an example of +\fBpcre2test\fP output, where the "mark" modifier requests the retrieval and +outputting of (*MARK) data: +.sp + re> /X(*MARK:A)Y|X(*MARK:B)Z/mark + data> XY + 0: XY + MK: A + XZ + 0: XZ + MK: B +.sp +The (*MARK) name is tagged with "MK:" in this output, and in this example it +indicates which of the two alternatives matched. This is a more efficient way +of obtaining this information than putting each alternative in its own +capturing parentheses. +.P +If a verb with a name is encountered in a positive assertion that is true, the +name is recorded and passed back if it is the last-encountered. This does not +happen for negative assertions or failing positive assertions. +.P +After a partial match or a failed match, the last encountered name in the +entire match process is returned. For example: +.sp + re> /X(*MARK:A)Y|X(*MARK:B)Z/mark + data> XP + No match, mark = B +.sp +Note that in this unanchored example the mark is retained from the match +attempt that started at the letter "X" in the subject. Subsequent match +attempts starting at "P" and then with an empty string do not get as far as the +(*MARK) item, but nevertheless do not reset it. +.P +If you are interested in (*MARK) values after failed matches, you should +probably either set the PCRE2_NO_START_OPTIMIZE option or call +\fBpcre2_set_optimize()\fP with a PCRE2_START_OPTIMIZE_OFF directive +.\" HTML +.\" +(see above) +.\" +to ensure that the match is always attempted. +. +. +.SS "Verbs that act after backtracking" +.rs +.sp +The following verbs do nothing when they are encountered. Matching continues +with what follows, but if there is a subsequent match failure, causing a +backtrack to the verb, a failure is forced. That is, backtracking cannot pass +to the left of the verb. However, when one of these verbs appears inside an +atomic group or in an atomic lookaround assertion that is true, its effect is +confined to that group, because once the group has been matched, there is never +any backtracking into it. Backtracking from beyond an atomic assertion or group +ignores the entire group, and seeks a preceding backtracking point. +.P +These verbs differ in exactly what kind of failure occurs when backtracking +reaches them. The behaviour described below is what happens when the verb is +not in a subroutine or an assertion. Subsequent sections cover these special +cases. +.sp + (*COMMIT) or (*COMMIT:NAME) +.sp +This verb causes the whole match to fail outright if there is a later matching +failure that causes backtracking to reach it. Even if the pattern is +unanchored, no further attempts to find a match by advancing the starting point +take place. If (*COMMIT) is the only backtracking verb that is encountered, +once it has been passed \fBpcre2_match()\fP is committed to finding a match at +the current starting point, or not at all. For example: +.sp + a+(*COMMIT)b +.sp +This matches "xxaab" but not "aacaab". It can be thought of as a kind of +dynamic anchor, or "I've started, so I must finish." +.P +The behaviour of (*COMMIT:NAME) is not the same as (*MARK:NAME)(*COMMIT). It is +like (*MARK:NAME) in that the name is remembered for passing back to the +caller. However, (*SKIP:NAME) searches only for names that are set with +(*MARK), ignoring those set by any of the other backtracking verbs. +.P +If there is more than one backtracking verb in a pattern, a different one that +follows (*COMMIT) may be triggered first, so merely passing (*COMMIT) during a +match does not always guarantee that a match must be at this starting point. +.P +Note that (*COMMIT) at the start of a pattern is not the same as an anchor, +unless PCRE2's start-of-match optimizations are turned off, as shown in this +output from \fBpcre2test\fP: +.sp + re> /(*COMMIT)abc/ + data> xyzabc + 0: abc + data> + re> /(*COMMIT)abc/no_start_optimize + data> xyzabc + No match +.sp +For the first pattern, PCRE2 knows that any match must start with "a", so the +optimization skips along the subject to "a" before applying the pattern to the +first set of data. The match attempt then succeeds. The second pattern disables +the optimization that skips along to the first character. The pattern is now +applied starting at "x", and so the (*COMMIT) causes the match to fail without +trying any other starting points. +.sp + (*PRUNE) or (*PRUNE:NAME) +.sp +This verb causes the match to fail at the current starting position in the +subject if there is a later matching failure that causes backtracking to reach +it. If the pattern is unanchored, the normal "bumpalong" advance to the next +starting character then happens. Backtracking can occur as usual to the left of +(*PRUNE), before it is reached, or when matching to the right of (*PRUNE), but +if there is no match to the right, backtracking cannot cross (*PRUNE). In +simple cases, the use of (*PRUNE) is just an alternative to an atomic group or +possessive quantifier, but there are some uses of (*PRUNE) that cannot be +expressed in any other way. In an anchored pattern (*PRUNE) has the same effect +as (*COMMIT). +.P +The behaviour of (*PRUNE:NAME) is not the same as (*MARK:NAME)(*PRUNE). It is +like (*MARK:NAME) in that the name is remembered for passing back to the +caller. However, (*SKIP:NAME) searches only for names set with (*MARK), +ignoring those set by other backtracking verbs. +.sp + (*SKIP) +.sp +This verb, when given without a name, is like (*PRUNE), except that if the +pattern is unanchored, the "bumpalong" advance is not to the next character, +but to the position in the subject where (*SKIP) was encountered. (*SKIP) +signifies that whatever text was matched leading up to it cannot be part of a +successful match if there is a later mismatch. Consider: +.sp + a+(*SKIP)b +.sp +If the subject is "aaaac...", after the first match attempt fails (starting at +the first character in the string), the starting point skips on to start the +next attempt at "c". Note that a possessive quantifier does not have the same +effect as this example; although it would suppress backtracking during the +first match attempt, the second attempt would start at the second character +instead of skipping on to "c". +.P +If (*SKIP) is used to specify a new starting position that is the same as the +starting position of the current match, or (by being inside a lookbehind) +earlier, the position specified by (*SKIP) is ignored, and instead the normal +"bumpalong" occurs. +.sp + (*SKIP:NAME) +.sp +When (*SKIP) has an associated name, its behaviour is modified. When such a +(*SKIP) is triggered, the previous path through the pattern is searched for the +most recent (*MARK) that has the same name. If one is found, the "bumpalong" +advance is to the subject position that corresponds to that (*MARK) instead of +to where (*SKIP) was encountered. If no (*MARK) with a matching name is found, +the (*SKIP) is ignored. +.P +The search for a (*MARK) name uses the normal backtracking mechanism, which +means that it does not see (*MARK) settings that are inside atomic groups or +assertions, because they are never re-entered by backtracking. Compare the +following \fBpcre2test\fP examples: +.sp + re> /a(?>(*MARK:X))(*SKIP:X)(*F)|(.)/ + data: abc + 0: a + 1: a + data: + re> /a(?:(*MARK:X))(*SKIP:X)(*F)|(.)/ + data: abc + 0: b + 1: b +.sp +In the first example, the (*MARK) setting is in an atomic group, so it is not +seen when (*SKIP:X) triggers, causing the (*SKIP) to be ignored. This allows +the second branch of the pattern to be tried at the first character position. +In the second example, the (*MARK) setting is not in an atomic group. This +allows (*SKIP:X) to find the (*MARK) when it backtracks, and this causes a new +matching attempt to start at the second character. This time, the (*MARK) is +never seen because "a" does not match "b", so the matcher immediately jumps to +the second branch of the pattern. +.P +Note that (*SKIP:NAME) searches only for names set by (*MARK:NAME). It ignores +names that are set by other backtracking verbs. +.sp + (*THEN) or (*THEN:NAME) +.sp +This verb causes a skip to the next innermost alternative when backtracking +reaches it. That is, it cancels any further backtracking within the current +alternative. Its name comes from the observation that it can be used for a +pattern-based if-then-else block: +.sp + ( COND1 (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ ) ... +.sp +If the COND1 pattern matches, FOO is tried (and possibly further items after +the end of the group if FOO succeeds); on failure, the matcher skips to the +second alternative and tries COND2, without backtracking into COND1. If that +succeeds and BAR fails, COND3 is tried. If subsequently BAZ fails, there are no +more alternatives, so there is a backtrack to whatever came before the entire +group. If (*THEN) is not inside an alternation, it acts like (*PRUNE). +.P +The behaviour of (*THEN:NAME) is not the same as (*MARK:NAME)(*THEN). It is +like (*MARK:NAME) in that the name is remembered for passing back to the +caller. However, (*SKIP:NAME) searches only for names set with (*MARK), +ignoring those set by other backtracking verbs. +.P +A group that does not contain a | character is just a part of the enclosing +alternative; it is not a nested alternation with only one alternative. The +effect of (*THEN) extends beyond such a group to the enclosing alternative. +Consider this pattern, where A, B, etc. are complex pattern fragments that do +not contain any | characters at this level: +.sp + A (B(*THEN)C) | D +.sp +If A and B are matched, but there is a failure in C, matching does not +backtrack into A; instead it moves to the next alternative, that is, D. +However, if the group containing (*THEN) is given an alternative, it +behaves differently: +.sp + A (B(*THEN)C | (*FAIL)) | D +.sp +The effect of (*THEN) is now confined to the inner group. After a failure in C, +matching moves to (*FAIL), which causes the whole group to fail because there +are no more alternatives to try. In this case, matching does backtrack into A. +.P +Note that a conditional group is not considered as having two alternatives, +because only one is ever used. In other words, the | character in a conditional +group has a different meaning. Ignoring white space, consider: +.sp + ^.*? (?(?=a) a | b(*THEN)c ) +.sp +If the subject is "ba", this pattern does not match. Because .*? is ungreedy, +it initially matches zero characters. The condition (?=a) then fails, the +character "b" is matched, but "c" is not. At this point, matching does not +backtrack to .*? as might perhaps be expected from the presence of the | +character. The conditional group is part of the single alternative that +comprises the whole pattern, and so the match fails. (If there was a backtrack +into .*?, allowing it to match "b", the match would succeed.) +.P +The verbs just described provide four different "strengths" of control when +subsequent matching fails. (*THEN) is the weakest, carrying on the match at the +next alternative. (*PRUNE) comes next, failing the match at the current +starting position, but allowing an advance to the next character (for an +unanchored pattern). (*SKIP) is similar, except that the advance may be more +than one character. (*COMMIT) is the strongest, causing the entire match to +fail. +. +. +.SS "More than one backtracking verb" +.rs +.sp +If more than one backtracking verb is present in a pattern, the one that is +backtracked onto first acts. For example, consider this pattern, where A, B, +etc. are complex pattern fragments: +.sp + (A(*COMMIT)B(*THEN)C|ABD) +.sp +If A matches but B fails, the backtrack to (*COMMIT) causes the entire match to +fail. However, if A and B match, but C fails, the backtrack to (*THEN) causes +the next alternative (ABD) to be tried. This behaviour is consistent, but is +not always the same as Perl's. It means that if two or more backtracking verbs +appear in succession, all but the last of them has no effect. Consider this +example: +.sp + ...(*COMMIT)(*PRUNE)... +.sp +If there is a matching failure to the right, backtracking onto (*PRUNE) causes +it to be triggered, and its action is taken. There can never be a backtrack +onto (*COMMIT). +. +. +.\" HTML +.SS "Backtracking verbs in repeated groups" +.rs +.sp +PCRE2 sometimes differs from Perl in its handling of backtracking verbs in +repeated groups. For example, consider: +.sp + /(a(*COMMIT)b)+ac/ +.sp +If the subject is "abac", Perl matches unless its optimizations are disabled, +but PCRE2 always fails because the (*COMMIT) in the second repeat of the group +acts. +. +. +.\" HTML +.SS "Backtracking verbs in assertions" +.rs +.sp +(*FAIL) in any assertion has its normal effect: it forces an immediate +backtrack. The behaviour of the other backtracking verbs depends on whether or +not the assertion is standalone or acting as the condition in a conditional +group. +.P +(*ACCEPT) in a standalone positive assertion causes the assertion to succeed +without any further processing; captured strings and a mark name (if set) are +retained. In a standalone negative assertion, (*ACCEPT) causes the assertion to +fail without any further processing; captured substrings and any mark name are +discarded. +.P +If the assertion is a condition, (*ACCEPT) causes the condition to be true for +a positive assertion and false for a negative one; captured substrings are +retained in both cases. +.P +The remaining verbs act only when a later failure causes a backtrack to +reach them. This means that, for the Perl-compatible assertions, their effect +is confined to the assertion, because Perl lookaround assertions are atomic. A +backtrack that occurs after such an assertion is complete does not jump back +into the assertion. Note in particular that a (*MARK) name that is set in an +assertion is not "seen" by an instance of (*SKIP:NAME) later in the pattern. +.P +PCRE2 now supports non-atomic positive assertions and also "scan substring" +assertions, as described in the sections entitled +.\" HTML +.\" +"Non-atomic assertions" +.\" +and +.\" HTML +.\" +"Scan substring assertions" +.\" +above. These assertions must be standalone (not used as conditions). They are +not Perl-compatible. For these assertions, a later backtrack does jump back +into the assertion, and therefore verbs such as (*COMMIT) can be triggered by +backtracks from later in the pattern. +.P +The effect of (*THEN) is not allowed to escape beyond an assertion. If there +are no more branches to try, (*THEN) causes a positive assertion to be false, +and a negative assertion to be true. This behaviour differs from Perl when the +assertion has only one branch. +.P +The other backtracking verbs are not treated specially if they appear in a +standalone positive assertion. In a conditional positive assertion, +backtracking (from within the assertion) into (*COMMIT), (*SKIP), or (*PRUNE) +causes the condition to be false. However, for both standalone and conditional +negative assertions, backtracking into (*COMMIT), (*SKIP), or (*PRUNE) causes +the assertion to be true, without considering any further alternative branches. +. +. +.\" HTML +.SS "Backtracking verbs in subroutines" +.rs +.sp +These behaviours occur whether or not the group is called recursively. +.P +(*ACCEPT) in a group called as a subroutine causes the subroutine match to +succeed without any further processing. Matching then continues after the +subroutine call. Perl documents this behaviour. Perl's treatment of the other +verbs in subroutines is different in some cases. +.P +(*FAIL) in a group called as a subroutine has its normal effect: it forces +an immediate backtrack. +.P +(*COMMIT), (*SKIP), and (*PRUNE) cause the subroutine match to fail when +triggered by being backtracked to in a group called as a subroutine. There is +then a backtrack at the outer level. +.P +(*THEN), when triggered, skips to the next alternative in the innermost +enclosing group that has alternatives (its normal behaviour). However, if there +is no such group within the subroutine's group, the subroutine match fails and +there is a backtrack at the outer level. +. +. +.\" HTML +.SH "EBCDIC ENVIRONMENTS" +.rs +.sp +Differences in the way PCRE behaves when it is running in an EBCDIC environment +are covered in this section. +. +. +.SS "Escape sequences" +.rs +.sp +When PCRE2 is compiled in EBCDIC mode, \eN{U+hhh..} is not supported. \ea, \ee, +\ef, \en, \er, and \et generate the appropriate EBCDIC code values. The \ec +escape is processed as specified for Perl in the \fBperlebcdic\fP document. The +only characters that are allowed after \ec are A-Z, a-z, or one of @, [, \e, ], +^, _, or ?. Any other character provokes a compile-time error. The sequence +\ec@ encodes character code 0; after \ec the letters (in either case) encode +characters 1-26 (hex 01 to hex 1A); [, \e, ], ^, and _ encode characters 27-31 +(hex 1B to hex 1F), and \ec? becomes either 255 (hex FF) or 95 (hex 5F). +.P +Thus, apart from \ec?, these escapes generate the same character code values as +they do in an ASCII or Unicode environment, though the meanings of the values +mostly differ. For example, \ecG always generates code value 7, which is BEL in +ASCII but DEL in EBCDIC. +.P +The sequence \ec? generates DEL (127, hex 7F) in an ASCII environment, but +because 127 is not a control character in EBCDIC, Perl makes it generate the +APC character. Unfortunately, there are several variants of EBCDIC. In most of +them the APC character has the value 255 (hex FF), but in the one Perl calls +POSIX-BC its value is 95 (hex 5F). If certain other characters have POSIX-BC +values, PCRE2 makes \ec? generate 95; otherwise it generates 255. +. +. +.SS "Character classes" +.rs +.sp +In character classes there is a special case in EBCDIC environments for ranges +whose end points are both specified as literal letters in the same case. For +compatibility with Perl, EBCDIC code points within the range that are not +letters are omitted. For example, [h-k] matches only four characters, even +though the EBCDIC codes for h and k are 0x88 and 0x92, a range of 11 code +points. However, if the range is specified numerically, for example, +[\ex88-\ex92] or [h-\ex92], all code points are included. +. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre2api\fP(3), \fBpcre2callout\fP(3), \fBpcre2matching\fP(3), +\fBpcre2syntax\fP(3), \fBpcre2\fP(3). +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 27 November 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2perform.3 b/miniconda3/share/man/man3/pcre2perform.3 new file mode 100644 index 0000000000000000000000000000000000000000..2d3e33bb0fda1c65da7b98c219a762d86d9b1b5f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2perform.3 @@ -0,0 +1,260 @@ +.TH PCRE2PERFORM 3 "06 December 2022" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 PERFORMANCE" +.rs +.sp +Two aspects of performance are discussed below: memory usage and processing +time. The way you express your pattern as a regular expression can affect both +of them. +. +.SH "COMPILED PATTERN MEMORY USAGE" +.rs +.sp +Patterns are compiled by PCRE2 into a reasonably efficient interpretive code, +so that most simple patterns do not use much memory for storing the compiled +version. However, there is one case where the memory usage of a compiled +pattern can be unexpectedly large. If a parenthesized group has a quantifier +with a minimum greater than 1 and/or a limited maximum, the whole group is +repeated in the compiled code. For example, the pattern +.sp + (abc|def){2,4} +.sp +is compiled as if it were +.sp + (abc|def)(abc|def)((abc|def)(abc|def)?)? +.sp +(Technical aside: It is done this way so that backtrack points within each of +the repetitions can be independently maintained.) +.P +For regular expressions whose quantifiers use only small numbers, this is not +usually a problem. However, if the numbers are large, and particularly if such +repetitions are nested, the memory usage can become an embarrassment. For +example, the very simple pattern +.sp + ((ab){1,1000}c){1,3} +.sp +uses over 50KiB when compiled using the 8-bit library. When PCRE2 is +compiled with its default internal pointer size of two bytes, the size limit on +a compiled pattern is 65535 code units in the 8-bit and 16-bit libraries, and +this is reached with the above pattern if the outer repetition is increased +from 3 to 4. PCRE2 can be compiled to use larger internal pointers and thus +handle larger compiled patterns, but it is better to try to rewrite your +pattern to use less memory if you can. +.P +One way of reducing the memory usage for such patterns is to make use of +PCRE2's +.\" HTML +.\" +"subroutine" +.\" +facility. Re-writing the above pattern as +.sp + ((ab)(?2){0,999}c)(?1){0,2} +.sp +reduces the memory requirements to around 16KiB, and indeed it remains under +20KiB even with the outer repetition increased to 100. However, this kind of +pattern is not always exactly equivalent, because any captures within +subroutine calls are lost when the subroutine completes. If this is not a +problem, this kind of rewriting will allow you to process patterns that PCRE2 +cannot otherwise handle. The matching performance of the two different versions +of the pattern are roughly the same. (This applies from release 10.30 - things +were different in earlier releases.) +. +. +.SH "STACK AND HEAP USAGE AT RUN TIME" +.rs +.sp +From release 10.30, the interpretive (non-JIT) version of \fBpcre2_match()\fP +uses very little system stack at run time. In earlier releases recursive +function calls could use a great deal of stack, and this could cause problems, +but this usage has been eliminated. Backtracking positions are now explicitly +remembered in memory frames controlled by the code. +.P +The size of each frame depends on the size of pointer variables and the number +of capturing parenthesized groups in the pattern being matched. On a 64-bit +system the frame size for a pattern with no captures is 128 bytes. For each +capturing group the size increases by 16 bytes. +.P +Until release 10.41, an initial 20KiB frames vector was allocated on the system +stack, but this still caused some issues for multi-thread applications where +each thread has a very small stack. From release 10.41 backtracking memory +frames are always held in heap memory. An initial heap allocation is obtained +the first time any match data block is passed to \fBpcre2_match()\fP. This is +remembered with the match data block and re-used if that block is used for +another match. It is freed when the match data block itself is freed. +.P +The size of the initial block is the larger of 20KiB or ten times the pattern's +frame size, unless the heap limit is less than this, in which case the heap +limit is used. If the initial block proves to be too small during matching, it +is replaced by a larger block, subject to the heap limit. The heap limit is +checked only when a new block is to be allocated. Reducing the heap limit +between calls to \fBpcre2_match()\fP with the same match data block does not +affect the saved block. +.P +In contrast to \fBpcre2_match()\fP, \fBpcre2_dfa_match()\fP does use recursive +function calls, but only for processing atomic groups, lookaround assertions, +and recursion within the pattern. The original version of the code used to +allocate quite large internal workspace vectors on the stack, which caused some +problems for some patterns in environments with small stacks. From release +10.32 the code for \fBpcre2_dfa_match()\fP has been re-factored to use heap +memory when necessary for internal workspace when recursing, though recursive +function calls are still used. +.P +The "match depth" parameter can be used to limit the depth of function +recursion, and the "match heap" parameter to limit heap memory in +\fBpcre2_dfa_match()\fP. +. +. +.SH "PROCESSING TIME" +.rs +.sp +Certain items in regular expression patterns are processed more efficiently +than others. It is more efficient to use a character class like [aeiou] than a +set of single-character alternatives such as (a|e|i|o|u). In general, the +simplest construction that provides the required behaviour is usually the most +efficient. Jeffrey Friedl's book contains a lot of useful general discussion +about optimizing regular expressions for efficient performance. This document +contains a few observations about PCRE2. +.P +Using Unicode character properties (the \ep, \eP, and \eX escapes) is slow, +because PCRE2 has to use a multi-stage table lookup whenever it needs a +character's property. If you can find an alternative pattern that does not use +character properties, it will probably be faster. +.P +By default, the escape sequences \eb, \ed, \es, and \ew, and the POSIX +character classes such as [:alpha:] do not use Unicode properties, partly for +backwards compatibility, and partly for performance reasons. However, you can +set the PCRE2_UCP option or start the pattern with (*UCP) if you want Unicode +character properties to be used. This can double the matching time for items +such as \ed, when matched with \fBpcre2_match()\fP; the performance loss is +less with a DFA matching function, and in both cases there is not much +difference for \eb. +.P +When a pattern begins with .* not in atomic parentheses, nor in parentheses +that are the subject of a backreference, and the PCRE2_DOTALL option is set, +the pattern is implicitly anchored by PCRE2, since it can match only at the +start of a subject string. If the pattern has multiple top-level branches, they +must all be anchorable. The optimization can be disabled by the +PCRE2_NO_DOTSTAR_ANCHOR option, and is automatically disabled if the pattern +contains (*PRUNE) or (*SKIP). +.P +If PCRE2_DOTALL is not set, PCRE2 cannot make this optimization, because the +dot metacharacter does not then match a newline, and if the subject string +contains newlines, the pattern may match from the character immediately +following one of them instead of from the very start. For example, the pattern +.sp + .*second +.sp +matches the subject "first\enand second" (where \en stands for a newline +character), with the match starting at the seventh character. In order to do +this, PCRE2 has to retry the match starting after every newline in the subject. +.P +If you are using such a pattern with subject strings that do not contain +newlines, the best performance is obtained by setting PCRE2_DOTALL, or starting +the pattern with ^.* or ^.*? to indicate explicit anchoring. That saves PCRE2 +from having to scan along the subject looking for a newline to restart at. +.P +Beware of patterns that contain nested indefinite repeats. These can take a +long time to run when applied to a string that does not match. Consider the +pattern fragment +.sp + ^(a+)* +.sp +This can match "aaaa" in 16 different ways, and this number increases very +rapidly as the string gets longer. (The * repeat can match 0, 1, 2, 3, or 4 +times, and for each of those cases other than 0 or 4, the + repeats can match +different numbers of times.) When the remainder of the pattern is such that the +entire match is going to fail, PCRE2 has in principle to try every possible +variation, and this can take an extremely long time, even for relatively short +strings. +.P +An optimization catches some of the more simple cases such as +.sp + (a+)*b +.sp +where a literal character follows. Before embarking on the standard matching +procedure, PCRE2 checks that there is a "b" later in the subject string, and if +there is not, it fails the match immediately. However, when there is no +following literal this optimization cannot be used. You can see the difference +by comparing the behaviour of +.sp + (a+)*\ed +.sp +with the pattern above. The former gives a failure almost instantly when +applied to a whole line of "a" characters, whereas the latter takes an +appreciable time with strings longer than about 20 characters. +.P +In many cases, the solution to this kind of performance issue is to use an +atomic group or a possessive quantifier. This can often reduce memory +requirements as well. As another example, consider this pattern: +.sp + ([^<]|<(?!inet))+ +.sp +It matches from wherever it starts until it encounters " +.\" +"The match context" +.\" +in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +.P +The \fBpcre2test\fP test program has a modifier called "find_limits" which, if +applied to a subject line, causes it to find the smallest limits that allow a +pattern to match. This is done by repeatedly matching with different limits. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 06 December 2022 +Copyright (c) 1997-2022 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2posix.3 b/miniconda3/share/man/man3/pcre2posix.3 new file mode 100644 index 0000000000000000000000000000000000000000..4eceda1c4098e3e7a1322194ee9bc544e1bfe750 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2posix.3 @@ -0,0 +1,348 @@ +.TH PCRE2POSIX 3 "27 November 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "SYNOPSIS" +.rs +.sp +.B #include +.PP +.nf +.B int pcre2_regcomp(regex_t *\fIpreg\fP, const char *\fIpattern\fP, +.B " int \fIcflags\fP);" +.sp +.B int pcre2_regexec(const regex_t *\fIpreg\fP, const char *\fIstring\fP, +.B " size_t \fInmatch\fP, regmatch_t \fIpmatch\fP[], int \fIeflags\fP);" +.sp +.B "size_t pcre2_regerror(int \fIerrcode\fP, const regex_t *\fIpreg\fP," +.B " char *\fIerrbuf\fP, size_t \fIerrbuf_size\fP);" +.sp +.B void pcre2_regfree(regex_t *\fIpreg\fP); +.fi +. +.SH DESCRIPTION +.rs +.sp +This set of functions provides a POSIX-style API for the PCRE2 regular +expression 8-bit library. There are no POSIX-style wrappers for PCRE2's 16-bit +and 32-bit libraries. See the +.\" HREF +\fBpcre2api\fP +.\" +documentation for a description of PCRE2's native API, which contains much +additional functionality. +.P +\fBIMPORTANT NOTE\fP: The functions described here are NOT thread-safe, and +should not be used in multi-threaded applications. They are also limited to +processing subjects that are not bigger than 2GB. Use the native API instead. +.P +These functions are wrapper functions that ultimately call the PCRE2 native +API. Their prototypes are defined in the \fBpcre2posix.h\fP header file, and +they all have unique names starting with \fBpcre2_\fP. However, the +\fBpcre2posix.h\fP header also contains macro definitions that convert the +standard POSIX names such \fBregcomp()\fP into \fBpcre2_regcomp()\fP etc. This +means that a program can use the usual POSIX names without running the risk of +accidentally linking with POSIX functions from a different library. +.P +On Unix-like systems the PCRE2 POSIX library is called \fBlibpcre2-posix\fP, so +can be accessed by adding \fB-lpcre2-posix\fP to the command for linking an +application. Because the POSIX functions call the native ones, it is also +necessary to add \fB-lpcre2-8\fP. +.P +On Windows systems, if you are linking to a DLL version of the library, it is +recommended that \fBPCRE2POSIX_SHARED\fP is defined before including the +\fBpcre2posix.h\fP header, as it will allow for a more efficient way to +invoke the functions by adding the \fB__declspec(dllimport)\fP decorator. +.P +Although they were not defined as prototypes in \fBpcre2posix.h\fP, releases +10.33 to 10.36 of the library contained functions with the POSIX names +\fBregcomp()\fP etc. These simply passed their arguments to the PCRE2 +functions. These functions were provided for backwards compatibility with +earlier versions of PCRE2, which had only POSIX names. However, this has proved +troublesome in situations where a program links with several libraries, some of +which use PCRE2's POSIX interface while others use the real POSIX functions. +For this reason, the POSIX names have been removed since release 10.37. +.P +Calling the header file \fBpcre2posix.h\fP avoids any conflict with other POSIX +libraries. It can, of course, be renamed or aliased as \fBregex.h\fP, which is +the "correct" name, if there is no clash. It provides two structure types, +\fIregex_t\fP for compiled internal forms, and \fIregmatch_t\fP for returning +captured substrings. It also defines some constants whose names start with +"REG_"; these are used for setting options and identifying error codes. +. +. +.SH "USING THE POSIX FUNCTIONS" +.rs +.sp +Note that these functions are just POSIX-style wrappers for PCRE2's native API. +They do not give POSIX regular expression behaviour, and they are not +thread-safe or even POSIX compatible. +.P +Those POSIX option bits that can reasonably be mapped to PCRE2 native options +have been implemented. In addition, the option REG_EXTENDED is defined with the +value zero. This has no effect, but since programs that are written to the +POSIX interface often use it, this makes it easier to slot in PCRE2 as a +replacement library. Other POSIX options are not even defined. +.P +There are also some options that are not defined by POSIX. These have been +added at the request of users who want to make use of certain PCRE2-specific +features via the POSIX calling interface or to add BSD or GNU functionality. +.P +When PCRE2 is called via these functions, it is only the API that is POSIX-like +in style. The syntax and semantics of the regular expressions themselves are +still those of Perl, subject to the setting of various PCRE2 options, as +described below. "POSIX-like in style" means that the API approximates to the +POSIX definition; it is not fully POSIX-compatible, and in multi-unit encoding +domains it is probably even less compatible. +.P +The descriptions below use the actual names of the functions, but, as described +above, the standard POSIX names (without the \fBpcre2_\fP prefix) may also be +used. +. +. +.SH "COMPILING A PATTERN" +.rs +.sp +The function \fBpcre2_regcomp()\fP is called to compile a pattern into an +internal form. By default, the pattern is a C string terminated by a binary +zero (but see REG_PEND below). The \fIpreg\fP argument is a pointer to a +\fBregex_t\fP structure that is used as a base for storing information about +the compiled regular expression. It is also used for input when REG_PEND is +set. The \fBregex_t\fP structure used by \fBpcre2_regcomp()\fP is defined in +\fBpcre2posix.h\fP and is not the same as the structure used by other libraries +that provide POSIX-style matching. +.P +The argument \fIcflags\fP is either zero, or contains one or more of the bits +defined by the following macros: +.sp + REG_DOTALL +.sp +The PCRE2_DOTALL option is set when the regular expression is passed for +compilation to the native function. Note that REG_DOTALL is not part of the +POSIX standard. +.sp + REG_ICASE +.sp +The PCRE2_CASELESS option is set when the regular expression is passed for +compilation to the native function. +.sp + REG_NEWLINE +.sp +The PCRE2_MULTILINE option is set when the regular expression is passed for +compilation to the native function. Note that this does \fInot\fP mimic the +defined POSIX behaviour for REG_NEWLINE (see the following section). +.sp + REG_NOSPEC +.sp +The PCRE2_LITERAL option is set when the regular expression is passed for +compilation to the native function. This disables all meta characters in the +pattern, causing it to be treated as a literal string. The only other options +that are allowed with REG_NOSPEC are REG_ICASE, REG_NOSUB, REG_PEND, and +REG_UTF. Note that REG_NOSPEC is not part of the POSIX standard. +.sp + REG_NOSUB +.sp +When a pattern that is compiled with this flag is passed to +\fBpcre2_regexec()\fP for matching, the \fInmatch\fP and \fIpmatch\fP arguments +are ignored, and no captured strings are returned. Versions of the PCRE2 library +prior to 10.22 used to set the PCRE2_NO_AUTO_CAPTURE compile option, but this +no longer happens because it disables the use of backreferences. +.sp + REG_PEND +.sp +If this option is set, the \fBreg_endp\fP field in the \fIpreg\fP structure +(which has the type const char *) must be set to point to the character beyond +the end of the pattern before calling \fBpcre2_regcomp()\fP. The pattern itself +may now contain binary zeros, which are treated as data characters. Without +REG_PEND, a binary zero terminates the pattern and the \fBre_endp\fP field is +ignored. This is a GNU extension to the POSIX standard and should be used with +caution in software intended to be portable to other systems. +.sp + REG_UCP +.sp +The PCRE2_UCP option is set when the regular expression is passed for +compilation to the native function. This causes PCRE2 to use Unicode properties +when matching \ed, \ew, etc., instead of just recognizing ASCII values. Note +that REG_UCP is not part of the POSIX standard. +.sp + REG_UNGREEDY +.sp +The PCRE2_UNGREEDY option is set when the regular expression is passed for +compilation to the native function. Note that REG_UNGREEDY is not part of the +POSIX standard. +.sp + REG_UTF +.sp +The PCRE2_UTF option is set when the regular expression is passed for +compilation to the native function. This causes the pattern itself and all data +strings used for matching it to be treated as UTF-8 strings. Note that REG_UTF +is not part of the POSIX standard. +.P +In the absence of these flags, no options are passed to the native function. +This means that the regex is compiled with PCRE2 default semantics. In +particular, the way it handles newline characters in the subject string is the +Perl way, not the POSIX way. Note that setting PCRE2_MULTILINE has only +\fIsome\fP of the effects specified for REG_NEWLINE. It does not affect the way +newlines are matched by the dot metacharacter (they are not) or by a negative +class such as [^a] (they are). +.P +The yield of \fBpcre2_regcomp()\fP is zero on success, and non-zero otherwise. +The \fIpreg\fP structure is filled in on success, and one other member of the +structure (as well as \fIre_endp\fP) is public: \fIre_nsub\fP contains the +number of capturing subpatterns in the regular expression. Various error codes +are defined in the header file. +.P +NOTE: If the yield of \fBpcre2_regcomp()\fP is non-zero, you must not attempt +to use the contents of the \fIpreg\fP structure. If, for example, you pass it +to \fBpcre2_regexec()\fP, the result is undefined and your program is likely to +crash. +. +. +.SH "MATCHING NEWLINE CHARACTERS" +.rs +.sp +This area is not simple, because POSIX and Perl take different views of things. +It is not possible to get PCRE2 to obey POSIX semantics, but then PCRE2 was +never intended to be a POSIX engine. The following table lists the different +possibilities for matching newline characters in Perl and PCRE2: +.sp + Default Change with +.sp + . matches newline no PCRE2_DOTALL + newline matches [^a] yes not changeable + $ matches \en at end yes PCRE2_DOLLAR_ENDONLY + $ matches \en in middle no PCRE2_MULTILINE + ^ matches \en in middle no PCRE2_MULTILINE +.sp +This is the equivalent table for a POSIX-compatible pattern matcher: +.sp + Default Change with +.sp + . matches newline yes REG_NEWLINE + newline matches [^a] yes REG_NEWLINE + $ matches \en at end no REG_NEWLINE + $ matches \en in middle no REG_NEWLINE + ^ matches \en in middle no REG_NEWLINE +.sp +This behaviour is not what happens when PCRE2 is called via its POSIX +API. By default, PCRE2's behaviour is the same as Perl's, except that there is +no equivalent for PCRE2_DOLLAR_ENDONLY in Perl. In both PCRE2 and Perl, there +is no way to stop newline from matching [^a]. +.P +Default POSIX newline handling can be obtained by setting PCRE2_DOTALL and +PCRE2_DOLLAR_ENDONLY when calling \fBpcre2_compile()\fP directly, but there is +no way to make PCRE2 behave exactly as for the REG_NEWLINE action. When using +the POSIX API, passing REG_NEWLINE to PCRE2's \fBpcre2_regcomp()\fP function +causes PCRE2_MULTILINE to be passed to \fBpcre2_compile()\fP, and REG_DOTALL +passes PCRE2_DOTALL. There is no way to pass PCRE2_DOLLAR_ENDONLY. +. +. +.SH "MATCHING A PATTERN" +.rs +.sp +The function \fBpcre2_regexec()\fP is called to match a compiled pattern +\fIpreg\fP against a given \fIstring\fP, which is by default terminated by a +zero byte (but see REG_STARTEND below), subject to the options in \fIeflags\fP. +These can be: +.sp + REG_NOTBOL +.sp +The PCRE2_NOTBOL option is set when calling the underlying PCRE2 matching +function. +.sp + REG_NOTEMPTY +.sp +The PCRE2_NOTEMPTY option is set when calling the underlying PCRE2 matching +function. Note that REG_NOTEMPTY is not part of the POSIX standard. However, +setting this option can give more POSIX-like behaviour in some situations. +.sp + REG_NOTEOL +.sp +The PCRE2_NOTEOL option is set when calling the underlying PCRE2 matching +function. +.sp + REG_STARTEND +.sp +When this option is set, the subject string starts at \fIstring\fP + +\fIpmatch[0].rm_so\fP and ends at \fIstring\fP + \fIpmatch[0].rm_eo\fP, which +should point to the first character beyond the string. There may be binary +zeros within the subject string, and indeed, using REG_STARTEND is the only +way to pass a subject string that contains a binary zero. +.P +Whatever the value of \fIpmatch[0].rm_so\fP, the offsets of the matched string +and any captured substrings are still given relative to the start of +\fIstring\fP itself. (Before PCRE2 release 10.30 these were given relative to +\fIstring\fP + \fIpmatch[0].rm_so\fP, but this differs from other +implementations.) +.P +This is a BSD extension, compatible with but not specified by IEEE Standard +1003.2 (POSIX.2), and should be used with caution in software intended to be +portable to other systems. Note that a non-zero \fIrm_so\fP does not imply +REG_NOTBOL; REG_STARTEND affects only the location and length of the string, +not how it is matched. Setting REG_STARTEND and passing \fIpmatch\fP as NULL +are mutually exclusive; the error REG_INVARG is returned. +.P +If the pattern was compiled with the REG_NOSUB flag, no data about any matched +strings is returned. The \fInmatch\fP and \fIpmatch\fP arguments of +\fBpcre2_regexec()\fP are ignored (except possibly as input for REG_STARTEND). +.P +The value of \fInmatch\fP may be zero, and the value \fIpmatch\fP may be NULL +(unless REG_STARTEND is set); in both these cases no data about any matched +strings is returned. +.P +Otherwise, the portion of the string that was matched, and also any captured +substrings, are returned via the \fIpmatch\fP argument, which points to an +array of \fInmatch\fP structures of type \fIregmatch_t\fP, containing the +members \fIrm_so\fP and \fIrm_eo\fP. These contain the byte offset to the first +character of each substring and the offset to the first character after the end +of each substring, respectively. The 0th element of the vector relates to the +entire portion of \fIstring\fP that was matched; subsequent elements relate to +the capturing subpatterns of the regular expression. Unused entries in the +array have both structure members set to -1. +.P +\fIregmatch_t\fP as well as the \fIregoff_t\fP typedef it uses are defined in +\fBpcre2posix.h\fP and are not warranted to have the same size or layout as other +similarly named types from other libraries that provide POSIX-style matching. +.P +A successful match yields a zero return; various error codes are defined in the +header file, of which REG_NOMATCH is the "expected" failure code. +. +. +.SH "ERROR MESSAGES" +.rs +.sp +The \fBpcre2_regerror()\fP function maps a non-zero errorcode from either +\fBpcre2_regcomp()\fP or \fBpcre2_regexec()\fP to a printable message. If +\fIpreg\fP is not NULL, the error should have arisen from the use of that +structure. A message terminated by a binary zero is placed in \fIerrbuf\fP. If +the buffer is too short, only the first \fIerrbuf_size\fP - 1 characters of the +error message are used. The yield of the function is the size of buffer needed +to hold the whole message, including the terminating zero. This value is +greater than \fIerrbuf_size\fP if the message was truncated. +. +. +.SH MEMORY USAGE +.rs +.sp +Compiling a regular expression causes memory to be allocated and associated +with the \fIpreg\fP structure. The function \fBpcre2_regfree()\fP frees all +such memory, after which \fIpreg\fP may no longer be used as a compiled +expression. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 27 November 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2sample.3 b/miniconda3/share/man/man3/pcre2sample.3 new file mode 100644 index 0000000000000000000000000000000000000000..a55b79523cf1a530fb32745171dffb0ceb8ce86f --- /dev/null +++ b/miniconda3/share/man/man3/pcre2sample.3 @@ -0,0 +1,99 @@ +.TH PCRE2SAMPLE 3 "14 November 2023" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 SAMPLE PROGRAM" +.rs +.sp +A simple, complete demonstration program to get you started with using PCRE2 is +supplied in the file \fIpcre2demo.c\fP in the \fBsrc\fP directory in the PCRE2 +distribution. A listing of this program is given in the +.\" HREF +\fBpcre2demo\fP +.\" +documentation. If you do not have a copy of the PCRE2 distribution, you can +save this listing to re-create the contents of \fIpcre2demo.c\fP. +.P +The demonstration program compiles the regular expression that is its +first argument, and matches it against the subject string in its second +argument. No PCRE2 options are set, and default character tables are used. If +matching succeeds, the program outputs the portion of the subject that matched, +together with the contents of any captured substrings. +.P +If the -g option is given on the command line, the program then goes on to +check for further matches of the same regular expression in the same subject +string. The logic is a little bit tricky because of the possibility of matching +an empty string. Comments in the code explain what is going on. +.P +The code in \fBpcre2demo.c\fP is an 8-bit program that uses the PCRE2 8-bit +library. It handles strings and characters that are stored in 8-bit code units. +By default, one character corresponds to one code unit, but if the pattern +starts with "(*UTF)", both it and the subject are treated as UTF-8 strings, +where characters may occupy multiple code units. +.P +If PCRE2 is installed in the standard include and library directories for your +operating system, you should be able to compile the demonstration program using +a command like this: +.sp + cc -o pcre2demo pcre2demo.c -lpcre2-8 +.sp +If PCRE2 is installed elsewhere, you may need to add additional options to the +command line. For example, on a Unix-like system that has PCRE2 installed in +\fI/usr/local\fP, you can compile the demonstration program using a command +like this: +.sp +.\" JOINSH + cc -o pcre2demo -I/usr/local/include pcre2demo.c \e + -L/usr/local/lib -lpcre2-8 +.sp +Once you have built the demonstration program, you can run simple tests like +this: +.sp + ./pcre2demo 'cat|dog' 'the cat sat on the mat' + ./pcre2demo -g 'cat|dog' 'the dog sat on the cat' +.sp +Note that there is a much more comprehensive test program, called +.\" HREF +\fBpcre2test\fP, +.\" +which supports many more facilities for testing regular expressions using all +three PCRE2 libraries (8-bit, 16-bit, and 32-bit, though not all three need be +installed). The +.\" HREF +\fBpcre2demo\fP +.\" +program is provided as a relatively simple coding example. +.P +If you try to run +.\" HREF +\fBpcre2demo\fP +.\" +when PCRE2 is not installed in the standard library directory, you may get an +error like this on some operating systems (e.g. Solaris): +.sp + ld.so.1: pcre2demo: fatal: libpcre2-8.so.0: open failed: No such file or directory +.sp +This is caused by the way shared library support works on those systems. You +need to add +.sp + -R/usr/local/lib +.sp +(for example) to the compile command to get round this problem. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 14 November 2023 +Copyright (c) 1997-2016 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2serialize.3 b/miniconda3/share/man/man3/pcre2serialize.3 new file mode 100644 index 0000000000000000000000000000000000000000..4de8e303138cb2a87ccc322cf96f00c505c08967 --- /dev/null +++ b/miniconda3/share/man/man3/pcre2serialize.3 @@ -0,0 +1,198 @@ +.TH PCRE2SERIALIZE 3 "19 January 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "SAVING AND RE-USING PRECOMPILED PCRE2 PATTERNS" +.rs +.sp +.nf +.B int32_t pcre2_serialize_decode(pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, const uint8_t *\fIbytes\fP," +.B " pcre2_general_context *\fIgcontext\fP);" +.sp +.B int32_t pcre2_serialize_encode(const pcre2_code **\fIcodes\fP, +.B " int32_t \fInumber_of_codes\fP, uint8_t **\fIserialized_bytes\fP," +.B " PCRE2_SIZE *\fIserialized_size\fP, pcre2_general_context *\fIgcontext\fP);" +.sp +.B void pcre2_serialize_free(uint8_t *\fIbytes\fP); +.sp +.B int32_t pcre2_serialize_get_number_of_codes(const uint8_t *\fIbytes\fP); +.fi +.sp +If you are running an application that uses a large number of regular +expression patterns, it may be useful to store them in a precompiled form +instead of having to compile them every time the application is run. However, +if you are using the just-in-time optimization feature, it is not possible to +save and reload the JIT data, because it is position-dependent. The host on +which the patterns are reloaded must be running the same version of PCRE2, with +the same code unit width, and must also have the same endianness, pointer width +and PCRE2_SIZE type. For example, patterns compiled on a 32-bit system using +PCRE2's 16-bit library cannot be reloaded on a 64-bit system, nor can they be +reloaded using the 8-bit library. +.P +Note that "serialization" in PCRE2 does not convert compiled patterns to an +abstract format like Java or .NET serialization. The serialized output is +really just a bytecode dump, which is why it can only be reloaded in the same +environment as the one that created it. Hence the restrictions mentioned above. +Applications that are not statically linked with a fixed version of PCRE2 must +be prepared to recompile patterns from their sources, in order to be immune to +PCRE2 upgrades. +. +. +.SH "SECURITY CONCERNS" +.rs +.sp +The facility for saving and restoring compiled patterns is intended for use +within individual applications. As such, the data supplied to +\fBpcre2_serialize_decode()\fP is expected to be trusted data, not data from +arbitrary external sources. There is only some simple consistency checking, not +complete validation of what is being re-loaded. Corrupted data may cause +undefined results. For example, if the length field of a pattern in the +serialized data is corrupted, the deserializing code may read beyond the end of +the byte stream that is passed to it. +. +. +.SH "SAVING COMPILED PATTERNS" +.rs +.sp +Before compiled patterns can be saved they must be serialized, which in PCRE2 +means converting the pattern to a stream of bytes. A single byte stream may +contain any number of compiled patterns, but they must all use the same +character tables. A single copy of the tables is included in the byte stream +(its size is 1088 bytes). For more details of character tables, see the +.\" HTML +.\" +section on locale support +.\" +in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +.P +The function \fBpcre2_serialize_encode()\fP creates a serialized byte stream +from a list of compiled patterns. Its first two arguments specify the list, +being a pointer to a vector of pointers to compiled patterns, and the length of +the vector. The third and fourth arguments point to variables which are set to +point to the created byte stream and its length, respectively. The final +argument is a pointer to a general context, which can be used to specify custom +memory management functions. If this argument is NULL, \fBmalloc()\fP is used +to obtain memory for the byte stream. The yield of the function is the number +of serialized patterns, or one of the following negative error codes: +.sp + PCRE2_ERROR_BADDATA the number of patterns is zero or less + PCRE2_ERROR_BADMAGIC mismatch of id bytes in one of the patterns + PCRE2_ERROR_NOMEMORY memory allocation failed + PCRE2_ERROR_MIXEDTABLES the patterns do not all use the same tables + PCRE2_ERROR_NULL the 1st, 3rd, or 4th argument is NULL +.sp +PCRE2_ERROR_BADMAGIC means either that a pattern's code has been corrupted, or +that a slot in the vector does not point to a compiled pattern. +.P +Once a set of patterns has been serialized you can save the data in any +appropriate manner. Here is sample code that compiles two patterns and writes +them to a file. It assumes that the variable \fIfd\fP refers to a file that is +open for output. The error checking that should be present in a real +application has been omitted for simplicity. +.sp + int errorcode; + uint8_t *bytes; + PCRE2_SIZE erroroffset; + PCRE2_SIZE bytescount; + pcre2_code *list_of_codes[2]; + list_of_codes[0] = pcre2_compile("first pattern", + PCRE2_ZERO_TERMINATED, 0, &errorcode, &erroroffset, NULL); + list_of_codes[1] = pcre2_compile("second pattern", + PCRE2_ZERO_TERMINATED, 0, &errorcode, &erroroffset, NULL); + errorcode = pcre2_serialize_encode(list_of_codes, 2, &bytes, + &bytescount, NULL); + errorcode = fwrite(bytes, 1, bytescount, fd); +.sp +Note that the serialized data is binary data that may contain any of the 256 +possible byte values. On systems that make a distinction between binary and +non-binary data, be sure that the file is opened for binary output. +.P +Serializing a set of patterns leaves the original data untouched, so they can +still be used for matching. Their memory must eventually be freed in the usual +way by calling \fBpcre2_code_free()\fP. When you have finished with the byte +stream, it too must be freed by calling \fBpcre2_serialize_free()\fP. If this +function is called with a NULL argument, it returns immediately without doing +anything. +. +. +.SH "RE-USING PRECOMPILED PATTERNS" +.rs +.sp +In order to re-use a set of saved patterns you must first make the serialized +byte stream available in main memory (for example, by reading from a file). The +management of this memory block is up to the application. You can use the +\fBpcre2_serialize_get_number_of_codes()\fP function to find out how many +compiled patterns are in the serialized data without actually decoding the +patterns: +.sp + uint8_t *bytes = ; + int32_t number_of_codes = pcre2_serialize_get_number_of_codes(bytes); +.sp +The \fBpcre2_serialize_decode()\fP function reads a byte stream and recreates +the compiled patterns in new memory blocks, setting pointers to them in a +vector. The first two arguments are a pointer to a suitable vector and its +length, and the third argument points to a byte stream. The final argument is a +pointer to a general context, which can be used to specify custom memory +management functions for the decoded patterns. If this argument is NULL, +\fBmalloc()\fP and \fBfree()\fP are used. After deserialization, the byte +stream is no longer needed and can be discarded. +.sp + pcre2_code *list_of_codes[2]; + uint8_t *bytes = ; + int32_t number_of_codes = + pcre2_serialize_decode(list_of_codes, 2, bytes, NULL); +.sp +If the vector is not large enough for all the patterns in the byte stream, it +is filled with those that fit, and the remainder are ignored. The yield of the +function is the number of decoded patterns, or one of the following negative +error codes: +.sp + PCRE2_ERROR_BADDATA second argument is zero or less + PCRE2_ERROR_BADMAGIC mismatch of id bytes in the data + PCRE2_ERROR_BADMODE mismatch of code unit size or PCRE2 version + PCRE2_ERROR_BADSERIALIZEDDATA other sanity check failure + PCRE2_ERROR_MEMORY memory allocation failed + PCRE2_ERROR_NULL first or third argument is NULL +.sp +PCRE2_ERROR_BADMAGIC may mean that the data is corrupt, or that it was compiled +on a system with different endianness. +.P +Decoded patterns can be used for matching in the usual way, and must be freed +by calling \fBpcre2_code_free()\fP. However, be aware that there is a potential +race issue if you are using multiple patterns that were decoded from a single +byte stream in a multithreaded application. A single copy of the character +tables is used by all the decoded patterns and a reference count is used to +arrange for its memory to be automatically freed when the last pattern is +freed, but there is no locking on this reference count. Therefore, if you want +to call \fBpcre2_code_free()\fP for these patterns in different threads, you +must arrange your own locking, and ensure that \fBpcre2_code_free()\fP cannot +be called by two threads at the same time. +.P +If a pattern was processed by \fBpcre2_jit_compile()\fP before being +serialized, the JIT data is discarded and so is no longer available after a +save/restore cycle. You can, however, process a restored pattern with +\fBpcre2_jit_compile()\fP if you wish. +. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 19 January 2024 +Copyright (c) 1997-2018 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2syntax.3 b/miniconda3/share/man/man3/pcre2syntax.3 new file mode 100644 index 0000000000000000000000000000000000000000..0fb37d9719915b7097faa15881b0f59ae56a39ae --- /dev/null +++ b/miniconda3/share/man/man3/pcre2syntax.3 @@ -0,0 +1,736 @@ +.TH PCRE2SYNTAX 3 "27 November 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "PCRE2 REGULAR EXPRESSION SYNTAX SUMMARY" +.rs +.sp +The full syntax and semantics of the regular expression patterns that are +supported by PCRE2 are described in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. This document contains a quick-reference summary of the pattern +syntax followed by the syntax of replacement strings in substitution function. +The full description of the latter is in the +.\" HREF +\fBpcre2api\fP +.\" +documentation. +. +.SH "QUOTING" +.rs +.sp + \ex where x is non-alphanumeric is a literal x + \eQ...\eE treat enclosed characters as literal +.sp +Note that white space inside \eQ...\eE is always treated as literal, even if +PCRE2_EXTENDED is set, causing most other white space to be ignored. Note also +that PCRE2's handling of \eQ...\eE has some differences from Perl's. See the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation for details. +. +. +.SH "BRACED ITEMS" +.rs +.sp +With one exception, wherever brace characters { and } are required to enclose +data for constructions such as \eg{2} or \ek{name}, space and/or horizontal tab +characters that follow { or precede } are allowed and are ignored. In the case +of quantifiers, they may also appear before or after the comma. The exception +is \eu{...} which is not Perl-compatible and is recognized only when +PCRE2_EXTRA_ALT_BSUX is set. This is an ECMAScript compatibility feature, and +follows ECMAScript's behaviour. +. +. +.SH "ESCAPED CHARACTERS" +.rs +.sp +This table applies to ASCII and Unicode environments. An unrecognized escape +sequence causes an error. +.sp + \ea alarm, that is, the BEL character (hex 07) + \ecx "control-x", where x is a non-control ASCII character + \ee escape (hex 1B) + \ef form feed (hex 0C) + \en newline (hex 0A) + \er carriage return (hex 0D) + \et tab (hex 09) + \e0dd character with octal code 0dd + \eddd character with octal code ddd, or backreference + \eo{ddd..} character with octal code ddd.. + \eN{U+hh..} character with Unicode code point hh.. (Unicode mode only) + \exhh character with hex code hh + \ex{hh..} character with hex code hh.. +.sp +\eN{U+hh..} is synonymous with \ex{hh..} but is not supported in environments +that use EBCDIC code (mainly IBM mainframes). Note that \eN not followed by an +opening curly bracket has a different meaning (see below). +.P +If PCRE2_ALT_BSUX or PCRE2_EXTRA_ALT_BSUX is set ("ALT_BSUX mode"), the +following are also recognized: +.sp + \eU the character "U" + \euhhhh character with hex code hhhh + \eu{hh..} character with hex code hh.. but only for EXTRA_ALT_BSUX +.sp +When \ex is not followed by {, one or two hexadecimal digits are read, +but in ALT_BSUX mode \ex must be followed by two hexadecimal digits to be +recognized as a hexadecimal escape; otherwise it matches a literal "x". +Likewise, if \eu (in ALT_BSUX mode) is not followed by four hexadecimal digits +or (in EXTRA_ALT_BSUX mode) a sequence of hex digits in curly brackets, it +matches a literal "u". +.P +Note that \e0dd is always an octal code. The treatment of backslash followed by +a non-zero digit is complicated; for details see the section +.\" HTML +.\" +"Non-printing characters" +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation, where details of escape processing in EBCDIC environments are +also given. +. +. +.SH "CHARACTER TYPES" +.rs +.sp + . any character except newline; + in dotall mode, any character whatsoever + \eC one code unit, even in UTF mode (best avoided) + \ed a decimal digit + \eD a character that is not a decimal digit + \eh a horizontal white space character + \eH a character that is not a horizontal white space character + \eN a character that is not a newline + \ep{\fIxx\fP} a character with the \fIxx\fP property + \eP{\fIxx\fP} a character without the \fIxx\fP property + \eR a newline sequence + \es a white space character + \eS a character that is not a white space character + \ev a vertical white space character + \eV a character that is not a vertical white space character + \ew a "word" character + \eW a "non-word" character + \eX a Unicode extended grapheme cluster +.sp +\eC is dangerous because it may leave the current matching point in the middle +of a UTF-8 or UTF-16 character. The application can lock out the use of \eC by +setting the PCRE2_NEVER_BACKSLASH_C option. It is also possible to build PCRE2 +with the use of \eC permanently disabled. +.P +By default, \ed, \es, and \ew match only ASCII characters, even in UTF-8 mode +or in the 16-bit and 32-bit libraries. However, if locale-specific matching is +happening, \es and \ew may also match characters with code points in the range +128-255. If the PCRE2_UCP option is set, the behaviour of these escape +sequences is changed to use Unicode properties and they match many more +characters, but there are some option settings that can restrict individual +sequences to matching only ASCII characters. +.P +Property descriptions in \ep and \eP are matched caselessly; hyphens, +underscores, and ASCII white space characters are ignored, in accordance with +Unicode's "loose matching" rules. For example, \ep{Bidi_Class=al} is the same +as \ep{ bidi class = AL }. +. +. +.SH "GENERAL CATEGORY PROPERTIES FOR \ep and \eP" +.rs +.sp + C Other + Cc Control + Cf Format + Cn Unassigned + Co Private use + Cs Surrogate +.sp + L Letter + Lc Cased letter, the union of Ll, Lu, and Lt + L& Synonym of Lc + Ll Lower case letter + Lm Modifier letter + Lo Other letter + Lt Title case letter + Lu Upper case letter +.sp + M Mark + Mc Spacing mark + Me Enclosing mark + Mn Non-spacing mark +.sp + N Number + Nd Decimal number + Nl Letter number + No Other number +.sp + P Punctuation + Pc Connector punctuation + Pd Dash punctuation + Pe Close punctuation + Pf Final punctuation + Pi Initial punctuation + Po Other punctuation + Ps Open punctuation +.sp + S Symbol + Sc Currency symbol + Sk Modifier symbol + Sm Mathematical symbol + So Other symbol +.sp + Z Separator + Zl Line separator + Zp Paragraph separator + Zs Space separator +.sp +From release 10.45, when caseless matching is set, Ll, Lu, and Lt are all +equivalent to Lc. +. +. +.SH "PCRE2 SPECIAL CATEGORY PROPERTIES FOR \ep and \eP" +.rs +.sp + Xan Alphanumeric: union of properties L and N + Xps POSIX space: property Z or tab, NL, VT, FF, CR + Xsp Perl space: property Z or tab, NL, VT, FF, CR + Xuc Universally-named character: one that can be + represented by a Universal Character Name + Xwd Perl word: property Xan or underscore +.sp +Perl and POSIX space are now the same. Perl added VT to its space character set +at release 5.18. +. +. +.SH "BINARY PROPERTIES FOR \ep AND \eP" +.rs +.sp +Unicode defines a number of binary properties, that is, properties whose only +values are true or false. You can obtain a list of those that are recognized by +\ep and \eP, along with their abbreviations, by running this command: +.sp + pcre2test -LP +. +. +. +.SH "SCRIPT MATCHING WITH \ep AND \eP" +.rs +.sp +Many script names and their 4-letter abbreviations are recognized in +\ep{sc:...} or \ep{scx:...} items, or on their own with \ep (and also \eP of +course). You can obtain a list of these scripts by running this command: +.sp + pcre2test -LS +. +. +. +.SH "THE BIDI_CLASS PROPERTY FOR \ep AND \eP" +.rs +.sp + \ep{Bidi_Class:} matches a character with the given class + \ep{BC:} matches a character with the given class +.sp +The recognized classes are: +.sp + AL Arabic letter + AN Arabic number + B paragraph separator + BN boundary neutral + CS common separator + EN European number + ES European separator + ET European terminator + FSI first strong isolate + L left-to-right + LRE left-to-right embedding + LRI left-to-right isolate + LRO left-to-right override + NSM non-spacing mark + ON other neutral + PDF pop directional format + PDI pop directional isolate + R right-to-left + RLE right-to-left embedding + RLI right-to-left isolate + RLO right-to-left override + S segment separator + WS white space +. +. +.SH "CHARACTER CLASSES" +.rs +.sp + [...] positive character class + [^...] negative character class + [x-y] range (can be used for hex characters) + [[:xxx:]] positive POSIX named set + [[:^xxx:]] negative POSIX named set +.sp + alnum alphanumeric + alpha alphabetic + ascii 0-127 + blank space or tab + cntrl control character + digit decimal digit + graph printing, excluding space + lower lower case letter + print printing, including space + punct printing, excluding alphanumeric + space white space + upper upper case letter + word same as \ew + xdigit hexadecimal digit +.sp +In PCRE2, POSIX character set names recognize only ASCII characters by default, +but some of them use Unicode properties if PCRE2_UCP is set. You can use +\eQ...\eE inside a character class. +.P +When PCRE2_ALT_EXTENDED_CLASS is set, UTS#18 extended character classes may be +used, allowing nested character classes, combined using set operators. +.sp + [x&&[^y]] UTS#18 extended character class +.sp + x||y set union (OR) + x&&y set intersection (AND) + x--y set difference (AND NOT) + x~~y set symmetric difference (XOR) +.sp +. +. +.SH "PERL EXTENDED CHARACTER CLASSES" +.rs +.sp + (?[...]) Perl extended character class + (?[\ep{Thai} & \ep{Nd}]) operators; whitespace ignored + (?[(x - y) & z]) parentheses for grouping +.sp + (?[ [^3] & \ep{Nd} ]) [...] is a nested ordinary class + (?[ [:alpha:] - [z] ]) POSIX set is allowed outside [...] + (?[ \ed - [3] ]) backslash-escaped set is allowed outside [...] + (?[ !\en & [:ascii:] ]) backslash-escaped character is allowed outside [...] + all other characters or ranges must be enclosed in [...] +.sp + x|y, x+y set union (OR) + x&y set intersection (AND) + x-y set difference (AND NOT) + x^y set symmetric difference (XOR) + !x set complement (NOT) +.sp +Inside a Perl extended character class, [...] switches mode to be interpreted +as an ordinary character class. Outside of a nested [...], the only items +permitted are backslash-escapes, POSIX sets, operators, and parentheses. Inside +a nested ordinary class, ^ has its usual meaning (inverts the class when used +as the first character); outside of a nested class, ^ is the XOR operator. +. +. +.SH "QUANTIFIERS" +.rs +.sp + ? 0 or 1, greedy + ?+ 0 or 1, possessive + ?? 0 or 1, lazy + * 0 or more, greedy + *+ 0 or more, possessive + *? 0 or more, lazy + + 1 or more, greedy + ++ 1 or more, possessive + +? 1 or more, lazy + {n} exactly n + {n,m} at least n, no more than m, greedy + {n,m}+ at least n, no more than m, possessive + {n,m}? at least n, no more than m, lazy + {n,} n or more, greedy + {n,}+ n or more, possessive + {n,}? n or more, lazy + {,m} zero up to m, greedy + {,m}+ zero up to m, possessive + {,m}? zero up to m, lazy +. +. +.SH "ANCHORS AND SIMPLE ASSERTIONS" +.rs +.sp + \eb word boundary + \eB not a word boundary + ^ start of subject + also after an internal newline in multiline mode + (after any newline if PCRE2_ALT_CIRCUMFLEX is set) + \eA start of subject + $ end of subject + also before newline at end of subject + also before internal newline in multiline mode + \eZ end of subject + also before newline at end of subject + \ez end of subject + \eG first matching position in subject +. +. +.SH "REPORTED MATCH POINT SETTING" +.rs +.sp + \eK set reported start of match +.sp +From release 10.38 \eK is not permitted by default in lookaround assertions, +for compatibility with Perl. However, if the PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK +option is set, the previous behaviour is re-enabled. When this option is set, +\eK is honoured in positive assertions, but ignored in negative ones. +. +. +.SH "ALTERNATION" +.rs +.sp + expr|expr|expr... +. +. +.SH "CAPTURING" +.rs +.sp + (...) capture group + (?...) named capture group (Perl) + (?'name'...) named capture group (Perl) + (?P...) named capture group (Python) + (?:...) non-capture group + (?|...) non-capture group; reset group numbers for + capture groups in each alternative +.sp +In non-UTF modes, names may contain underscores and ASCII letters and digits; +in UTF modes, any Unicode letters and Unicode decimal digits are permitted. In +both cases, a name must not start with a digit. +. +. +.SH "ATOMIC GROUPS" +.rs +.sp + (?>...) atomic non-capture group + (*atomic:...) atomic non-capture group +. +. +.SH "COMMENT" +.rs +.sp + (?#....) comment (not nestable) +. +. +.SH "OPTION SETTING" +.rs +Changes of these options within a group are automatically cancelled at the end +of the group. +.sp + (?a) all ASCII options + (?aD) restrict \ed to ASCII in UCP mode + (?aS) restrict \es to ASCII in UCP mode + (?aW) restrict \ew to ASCII in UCP mode + (?aP) restrict all POSIX classes to ASCII in UCP mode + (?aT) restrict POSIX digit classes to ASCII in UCP mode + (?i) caseless + (?J) allow duplicate named groups + (?m) multiline + (?n) no auto capture + (?r) restrict caseless to either ASCII or non-ASCII + (?s) single line (dotall) + (?U) default ungreedy (lazy) + (?x) ignore white space except in classes or \eQ...\eE + (?xx) as (?x) but also ignore space and tab in classes + (?-...) unset the given option(s) + (?^) unset imnrsx options +.sp +(?aP) implies (?aT) as well, though this has no additional effect. However, it +means that (?-aP) also implies (?-aT) and disables all ASCII restrictions for +POSIX classes. +.P +Unsetting x or xx unsets both. Several options may be set at once, and a +mixture of setting and unsetting such as (?i-x) is allowed, but there may be +only one hyphen. Setting (but no unsetting) is allowed after (?^ for example +(?^in). An option setting may appear at the start of a non-capture group, for +example (?i:...). +.P +The following are recognized only at the very start of a pattern or after one +of the newline or \eR sequences or options with similar syntax. More than one +of them may appear. For the first three, d is a decimal number. +.sp + (*LIMIT_DEPTH=d) set the backtracking limit to d + (*LIMIT_HEAP=d) set the heap size limit to d * 1024 bytes + (*LIMIT_MATCH=d) set the match limit to d + (*CASELESS_RESTRICT) set PCRE2_EXTRA_CASELESS_RESTRICT when matching + (*NOTEMPTY) set PCRE2_NOTEMPTY when matching + (*NOTEMPTY_ATSTART) set PCRE2_NOTEMPTY_ATSTART when matching + (*NO_AUTO_POSSESS) no auto-possessification (PCRE2_NO_AUTO_POSSESS) + (*NO_DOTSTAR_ANCHOR) no .* anchoring (PCRE2_NO_DOTSTAR_ANCHOR) + (*NO_JIT) disable JIT optimization + (*NO_START_OPT) no start-match optimization (PCRE2_NO_START_OPTIMIZE) + (*TURKISH_CASING) set PCRE2_EXTRA_TURKISH_CASING when matching + (*UTF) set appropriate UTF mode for the library in use + (*UCP) set PCRE2_UCP (use Unicode properties for \ed etc) +.sp +Note that LIMIT_DEPTH, LIMIT_HEAP, and LIMIT_MATCH can only reduce the value of +the limits set by the caller of \fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP, +not increase them. LIMIT_RECURSION is an obsolete synonym for LIMIT_DEPTH. The +application can lock out the use of (*UTF) and (*UCP) by setting the +PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options, respectively, at compile time. +. +. +.SH "NEWLINE CONVENTION" +.rs +.sp +These are recognized only at the very start of the pattern or after option +settings with a similar syntax. +.sp + (*CR) carriage return only + (*LF) linefeed only + (*CRLF) carriage return followed by linefeed + (*ANYCRLF) all three of the above + (*ANY) any Unicode newline sequence + (*NUL) the NUL character (binary zero) +. +. +.SH "WHAT \eR MATCHES" +.rs +.sp +These are recognized only at the very start of the pattern or after option +setting with a similar syntax. +.sp + (*BSR_ANYCRLF) CR, LF, or CRLF + (*BSR_UNICODE) any Unicode newline sequence +. +. +.SH "LOOKAHEAD AND LOOKBEHIND ASSERTIONS" +.rs +.sp + (?=...) ) + (*pla:...) ) positive lookahead + (*positive_lookahead:...) ) +.sp + (?!...) ) + (*nla:...) ) negative lookahead + (*negative_lookahead:...) ) +.sp + (?<=...) ) + (*plb:...) ) positive lookbehind + (*positive_lookbehind:...) ) +.sp + (? name + 'name' name +.sp +. +. +.SH "SCRIPT RUNS" +.rs +.sp + (*script_run:...) ) script run, can be backtracked into + (*sr:...) ) +.sp + (*atomic_script_run:...) ) atomic script run + (*asr:...) ) +. +. +.SH "BACKREFERENCES" +.rs +.sp + \en reference by number (can be ambiguous) + \egn reference by number + \eg{n} reference by number + \eg+n relative reference by number (PCRE2 extension) + \eg-n relative reference by number + \eg{+n} relative reference by number (PCRE2 extension) + \eg{-n} relative reference by number + \ek reference by name (Perl) + \ek'name' reference by name (Perl) + \eg{name} reference by name (Perl) + \ek{name} reference by name (.NET) + (?P=name) reference by name (Python) +. +. +.SH "SUBROUTINE REFERENCES (POSSIBLY RECURSIVE)" +.rs +.sp + (?R) recurse whole pattern + (?n) call subroutine by absolute number + (?+n) call subroutine by relative number + (?-n) call subroutine by relative number + (?&name) call subroutine by name (Perl) + (?P>name) call subroutine by name (Python) + \eg call subroutine by name (Oniguruma) + \eg'name' call subroutine by name (Oniguruma) + \eg call subroutine by absolute number (Oniguruma) + \eg'n' call subroutine by absolute number (Oniguruma) + \eg<+n> call subroutine by relative number (PCRE2 extension) + \eg'+n' call subroutine by relative number (PCRE2 extension) + \eg<-n> call subroutine by relative number (PCRE2 extension) + \eg'-n' call subroutine by relative number (PCRE2 extension) +. +. +.SH "CONDITIONAL PATTERNS" +.rs +.sp + (?(condition)yes-pattern) + (?(condition)yes-pattern|no-pattern) +.sp + (?(n) absolute reference condition + (?(+n) relative reference condition (PCRE2 extension) + (?(-n) relative reference condition (PCRE2 extension) + (?() named reference condition (Perl) + (?('name') named reference condition (Perl) + (?(name) named reference condition (PCRE2, deprecated) + (?(R) overall recursion condition + (?(Rn) specific numbered group recursion condition + (?(R&name) specific named group recursion condition + (?(DEFINE) define groups for reference + (?(VERSION[>]=n.m) test PCRE2 version + (?(assert) assertion condition +.sp +Note the ambiguity of (?(R) and (?(Rn) which might be named reference +conditions or recursion tests. Such a condition is interpreted as a reference +condition if the relevant named group exists. +. +. +.SH "BACKTRACKING CONTROL" +.rs +.sp +All backtracking control verbs may be in the form (*VERB:NAME). For (*MARK) the +name is mandatory, for the others it is optional. (*SKIP) changes its behaviour +if :NAME is present. The others just set a name for passing back to the caller, +but this is not a name that (*SKIP) can see. The following act immediately they +are reached: +.sp + (*ACCEPT) force successful match + (*FAIL) force backtrack; synonym (*F) + (*MARK:NAME) set name to be passed back; synonym (*:NAME) +.sp +The following act only when a subsequent match failure causes a backtrack to +reach them. They all force a match failure, but they differ in what happens +afterwards. Those that advance the start-of-match point do so only if the +pattern is not anchored. +.sp + (*COMMIT) overall failure, no advance of starting point + (*PRUNE) advance to next starting character + (*SKIP) advance to current matching position + (*SKIP:NAME) advance to position corresponding to an earlier + (*MARK:NAME); if not found, the (*SKIP) is ignored + (*THEN) local failure, backtrack to next alternation +.sp +The effect of one of these verbs in a group called as a subroutine is confined +to the subroutine call. +. +. +.SH "CALLOUTS" +.rs +.sp + (?C) callout (assumed number 0) + (?Cn) callout with numerical data n + (?C"text") callout with string data +.sp +The allowed string delimiters are ` ' " ^ % # $ (which are the same for the +start and the end), and the starting delimiter { matched with the ending +delimiter }. To encode the ending delimiter within the string, double it. +. +. +.SH "REPLACEMENT STRINGS" +.rs +.sp +If the PCRE2_SUBSTITUTE_LITERAL option is set, a replacement string for +\fBpcre2_substitute()\fP is not interpreted. Otherwise, by default, the only +special character is the dollar character in one of the following forms: +.sp + $$ insert a dollar character + $n or ${n} insert the contents of group \fIn\fP + $ insert the contents of named group + $0 or $& insert the entire matched substring + $` insert the substring that precedes the match + $' insert the substring that follows the match + $_ insert the entire input string + $*MARK or ${*MARK} insert a control verb name +.sp +For ${n}, n can be a name or a number. If PCRE2_SUBSTITUTE_EXTENDED is set, +there is additional interpretation: +.P +1. Backslash is an escape character, and the forms described in "ESCAPED +CHARACTERS" above are recognized. Also: +.sp + \eQ...\eE can be used to suppress interpretation + \el force the next character to lower case + \eu force the next character to upper case + \eL force subsequent characters to lower case + \eU force subsequent characters to upper case + \eu\eL force next character to upper case, then all lower + \el\eU force next character to lower case, then all upper + \eE end \eL or \eU case forcing + \eb backspace character (note: as in character class in pattern) + \ev vertical tab character (note: not the same as in a pattern) +.sp +2. The Python form \eg, where the angle brackets are part of the syntax and +\fIn\fP is either a group name or a number, is recognized as an alternative way +of inserting the contents of a group, for example \eg<3>. +.P +3. Capture substitution supports the following additional forms: +.sp + ${n:-string} default for unset group + ${n:+string1:string2} values for set/unset group +.sp +The substitution strings themselves are expanded. Backslash can be used to +escape colons and closing curly brackets. +. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre2pattern\fP(3), \fBpcre2api\fP(3), \fBpcre2callout\fP(3), +\fBpcre2matching\fP(3), \fBpcre2\fP(3). +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 27 November 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/pcre2unicode.3 b/miniconda3/share/man/man3/pcre2unicode.3 new file mode 100644 index 0000000000000000000000000000000000000000..417baf3737b162cc195bb738cbc0769197b6b8fc --- /dev/null +++ b/miniconda3/share/man/man3/pcre2unicode.3 @@ -0,0 +1,514 @@ +.TH PCRE2UNICODE 3 "27 November 2024" "PCRE2 10.46" +.SH NAME +PCRE2 - Perl-compatible regular expressions (revised API) +.SH "UNICODE AND UTF SUPPORT" +.rs +.sp +PCRE2 is normally built with Unicode support, though if you do not need it, you +can build it without, in which case the library will be smaller. With Unicode +support, PCRE2 has knowledge of Unicode character properties and can process +strings of text in UTF-8, UTF-16, and UTF-32 format (depending on the code unit +width), but this is not the default. Unless specifically requested, PCRE2 +treats each code unit in a string as one character. +.P +There are two ways of telling PCRE2 to switch to UTF mode, where characters may +consist of more than one code unit and the range of values is constrained. The +program can call +.\" HREF +\fBpcre2_compile()\fP +.\" +with the PCRE2_UTF option, or the pattern may start with the sequence (*UTF). +However, the latter facility can be locked out by the PCRE2_NEVER_UTF option. +That is, the programmer can prevent the supplier of the pattern from switching +to UTF mode. +.P +Note that the PCRE2_MATCH_INVALID_UTF option (see +.\" HTML +.\" +below) +.\" +forces PCRE2_UTF to be set. +.P +In UTF mode, both the pattern and any subject strings that are matched against +it are treated as UTF strings instead of strings of individual one-code-unit +characters. There are also some other changes to the way characters are +handled, as documented below. +. +. +.SH "UNICODE PROPERTY SUPPORT" +.rs +.sp +When PCRE2 is built with Unicode support, the escape sequences \ep{..}, +\eP{..}, and \eX can be used. This is not dependent on the PCRE2_UTF setting. +The Unicode properties that can be tested are a subset of those that Perl +supports. Currently they are limited to the general category properties such as +Lu for an upper case letter or Nd for a decimal number, the derived properties +Any and Lc (synonym L&), the Unicode script names such as Arabic or Han, +Bidi_Class, Bidi_Control, and a few binary properties. +.P +The full lists are given in the +.\" HREF +\fBpcre2pattern\fP +.\" +and +.\" HREF +\fBpcre2syntax\fP +.\" +documentation. In general, only the short names for properties are supported. +For example, \ep{L} matches a letter. Its longer synonym, \ep{Letter}, is not +supported. Furthermore, in Perl, many properties may optionally be prefixed by +"Is", for compatibility with Perl 5.6. PCRE2 does not support this. +. +. +.SH "WIDE CHARACTERS AND UTF MODES" +.rs +.sp +Code points less than 256 can be specified in patterns by either braced or +unbraced hexadecimal escape sequences (for example, \ex{b3} or \exb3). Larger +values have to use braced sequences. Unbraced octal code points up to \e777 are +also recognized; larger ones can be coded using \eo{...}. +.P +The escape sequence \eN{U+} is recognized as another way of +specifying a Unicode character by code point in a UTF mode. It is not allowed +in non-UTF mode. +.P +In UTF mode, repeat quantifiers apply to complete UTF characters, not to +individual code units. +.P +In UTF mode, the dot metacharacter matches one UTF character instead of a +single code unit. +.P +In UTF mode, capture group names are not restricted to ASCII, and may contain +any Unicode letters and decimal digits, as well as underscore. +.P +The escape sequence \eC can be used to match a single code unit in UTF mode, +but its use can lead to some strange effects because it breaks up multi-unit +characters (see the description of \eC in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation). For this reason, there is a build-time option that disables +support for \eC completely. There is also a less draconian compile-time option +for locking out the use of \eC when a pattern is compiled. +.P +The use of \eC is not supported by the alternative matching function +\fBpcre2_dfa_match()\fP when in UTF-8 or UTF-16 mode, that is, when a character +may consist of more than one code unit. The use of \eC in these modes provokes +a match-time error. Also, the JIT optimization does not support \eC in these +modes. If JIT optimization is requested for a UTF-8 or UTF-16 pattern that +contains \eC, it will not succeed, and so when \fBpcre2_match()\fP is called, +the matching will be carried out by the interpretive function. +.P +The character escapes \eb, \eB, \ed, \eD, \es, \eS, \ew, and \eW correctly test +characters of any code value, but, by default, the characters that PCRE2 +recognizes as digits, spaces, or word characters remain the same set as in +non-UTF mode, all with code points less than 256. This remains true even when +PCRE2 is built to include Unicode support, because to do otherwise would slow +down matching in many common cases. Note that this also applies to \eb +and \eB, because they are defined in terms of \ew and \eW. If you want +to test for a wider sense of, say, "digit", you can use explicit Unicode +property tests such as \ep{Nd}. Alternatively, if you set the PCRE2_UCP option, +the way that the character escapes work is changed so that Unicode properties +are used to determine which characters match, though there are some options +that suppress this for individual escapes. For details see the section on +.\" HTML +.\" +generic character types +.\" +in the +.\" HREF +\fBpcre2pattern\fP +.\" +documentation. +.P +Like the escapes, characters that match the POSIX named character classes are +all low-valued characters unless the PCRE2_UCP option is set, but there is an +option to override this. +.P +In contrast to the character escapes and character classes, the special +horizontal and vertical white space escapes (\eh, \eH, \ev, and \eV) do match +all the appropriate Unicode characters, whether or not PCRE2_UCP is set. +. +. +.SH "UNICODE CASE-EQUIVALENCE" +.rs +.sp +If either PCRE2_UTF or PCRE2_UCP is set, upper/lower case processing makes use +of Unicode properties except for characters whose code points are less than 128 +and that have at most two case-equivalent values. For these, a direct table +lookup is used for speed. A few Unicode characters such as Greek sigma have +more than two code points that are case-equivalent, and these are treated +specially. Setting PCRE2_UCP without PCRE2_UTF allows Unicode-style case +processing for non-UTF character encodings such as UCS-2. +.P +There are two ASCII characters (S and K) that, in addition to their ASCII lower +case equivalents, have a non-ASCII one as well (long S and Kelvin sign). +Recognition of these non-ASCII characters as case-equivalent to their ASCII +counterparts can be disabled by setting the PCRE2_EXTRA_CASELESS_RESTRICT +option. When this is set, all characters in a case equivalence must either be +ASCII or non-ASCII; there can be no mixing. +.sp + Without PCRE2_EXTRA_CASELESS_RESTRICT: + 'k' = 'K' = U+212A (Kelvin sign) + 's' = 'S' = U+017F (long S) + With PCRE2_EXTRA_CASELESS_RESTRICT: + 'k' = 'K' + U+212A (Kelvin sign) only case-equivalent to itself + 's' = 'S' + U+017F (long S) only case-equivalent to itself +.P +One language family, Turkish and Azeri, has its own case-insensitivity rules, +which can be selected by setting PCRE2_EXTRA_TURKISH_CASING. This alters the +behaviour of the 'i', 'I', U+0130 (capital I with dot above), and U+0131 +(small dotless i) characters. +.sp + Without PCRE2_EXTRA_TURKISH_CASING: + 'i' = 'I' + U+0130 (capital I with dot above) only case-equivalent to itself + U+0131 (small dotless i) only case-equivalent to itself + With PCRE2_EXTRA_TURKISH_CASING: + 'i' = U+0130 (capital I with dot above) + U+0131 (small dotless i) = 'I' +.P +It is not allowed to specify both PCRE2_EXTRA_CASELESS_RESTRICT and +PCRE2_EXTRA_TURKISH_CASING together. +.P +From release 10.45 the Unicode letter properties Lu (upper case), Ll (lower +case), and Lt (title case) are all treated as Lc (cased letter) when caseless +matching is set by the PCRE2_CASELESS option or (?i) within the pattern. +. +. +.\" HTML +.SH "SCRIPT RUNS" +.rs +.sp +The pattern constructs (*script_run:...) and (*atomic_script_run:...), with +synonyms (*sr:...) and (*asr:...), verify that the string matched within the +parentheses is a script run. In concept, a script run is a sequence of +characters that are all from the same Unicode script. However, because some +scripts are commonly used together, and because some diacritical and other +marks are used with multiple scripts, it is not that simple. +.P +Every Unicode character has a Script property, mostly with a value +corresponding to the name of a script, such as Latin, Greek, or Cyrillic. There +are also three special values: +.P +"Unknown" is used for code points that have not been assigned, and also for the +surrogate code points. In the PCRE2 32-bit library, characters whose code +points are greater than the Unicode maximum (U+10FFFF), which are accessible +only in non-UTF mode, are assigned the Unknown script. +.P +"Common" is used for characters that are used with many scripts. These include +punctuation, emoji, mathematical, musical, and currency symbols, and the ASCII +digits 0 to 9. +.P +"Inherited" is used for characters such as diacritical marks that modify a +previous character. These are considered to take on the script of the character +that they modify. +.P +Some Inherited characters are used with many scripts, but many of them are only +normally used with a small number of scripts. For example, U+102E0 (Coptic +Epact thousands mark) is used only with Arabic and Coptic. In order to make it +possible to check this, a Unicode property called Script Extension exists. Its +value is a list of scripts that apply to the character. For the majority of +characters, the list contains just one script, the same one as the Script +property. However, for characters such as U+102E0 more than one Script is +listed. There are also some Common characters that have a single, non-Common +script in their Script Extension list. +.P +The next section describes the basic rules for deciding whether a given string +of characters is a script run. Note, however, that there are some special cases +involving the Chinese Han script, and an additional constraint for decimal +digits. These are covered in subsequent sections. +. +. +.SS "Basic script run rules" +.rs +.sp +A string that is less than two characters long is a script run. This is the +only case in which an Unknown character can be part of a script run. Longer +strings are checked using only the Script Extensions property, not the basic +Script property. +.P +If a character's Script Extension property is the single value "Inherited", it +is always accepted as part of a script run. This is also true for the property +"Common", subject to the checking of decimal digits described below. All the +remaining characters in a script run must have at least one script in common in +their Script Extension lists. In set-theoretic terminology, the intersection of +all the sets of scripts must not be empty. +.P +A simple example is an Internet name such as "google.com". The letters are all +in the Latin script, and the dot is Common, so this string is a script run. +However, the Cyrillic letter "o" looks exactly the same as the Latin "o"; a +string that looks the same, but with Cyrillic "o"s is not a script run. +.P +More interesting examples involve characters with more than one script in their +Script Extension. Consider the following characters: +.sp + U+060C Arabic comma + U+06D4 Arabic full stop +.sp +The first has the Script Extension list Arabic, Hanifi Rohingya, Syriac, and +Thaana; the second has just Arabic and Hanifi Rohingya. Both of them could +appear in script runs of either Arabic or Hanifi Rohingya. The first could also +appear in Syriac or Thaana script runs, but the second could not. +. +. +.SS "The Chinese Han script" +.rs +.sp +The Chinese Han script is commonly used in conjunction with other scripts for +writing certain languages. Japanese uses the Hiragana and Katakana scripts +together with Han; Korean uses Hangul and Han; Taiwanese Mandarin uses Bopomofo +and Han. These three combinations are treated as special cases when checking +script runs and are, in effect, "virtual scripts". Thus, a script run may +contain a mixture of Hiragana, Katakana, and Han, or a mixture of Hangul and +Han, or a mixture of Bopomofo and Han, but not, for example, a mixture of +Hangul and Bopomofo and Han. PCRE2 (like Perl) follows Unicode's Technical +Standard 39 ("Unicode Security Mechanisms", http://unicode.org/reports/tr39/) +in allowing such mixtures. +. +. +.SS "Decimal digits" +.rs +.sp +Unicode contains many sets of 10 decimal digits in different scripts, and some +scripts (including the Common script) contain more than one set. Some of these +decimal digits them are visually indistinguishable from the common ASCII +digits. In addition to the script checking described above, if a script run +contains any decimal digits, they must all come from the same set of 10 +adjacent characters. +. +. +.SH "VALIDITY OF UTF STRINGS" +.rs +.sp +When the PCRE2_UTF option is set, the strings passed as patterns and subjects +are (by default) checked for validity on entry to the relevant functions. If an +invalid UTF string is passed, a negative error code is returned. The code unit +offset to the offending character can be extracted from the match data block by +calling \fBpcre2_get_startchar()\fP, which is used for this purpose after a UTF +error. +.P +In some situations, you may already know that your strings are valid, and +therefore want to skip these checks in order to improve performance, for +example in the case of a long subject string that is being scanned repeatedly. +If you set the PCRE2_NO_UTF_CHECK option at compile time or at match time, +PCRE2 assumes that the pattern or subject it is given (respectively) contains +only valid UTF code unit sequences. +.P +If you pass an invalid UTF string when PCRE2_NO_UTF_CHECK is set, the result +is undefined and your program may crash or loop indefinitely or give incorrect +results. There is, however, one mode of matching that can handle invalid UTF +subject strings. This is enabled by passing PCRE2_MATCH_INVALID_UTF to +\fBpcre2_compile()\fP and is discussed below in the next section. The rest of +this section covers the case when PCRE2_MATCH_INVALID_UTF is not set. +.P +Passing PCRE2_NO_UTF_CHECK to \fBpcre2_compile()\fP just disables the UTF check +for the pattern; it does not also apply to subject strings. If you want to +disable the check for a subject string you must pass this same option to +\fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP. +.P +UTF-16 and UTF-32 strings can indicate their endianness by special code knows +as a byte-order mark (BOM). The PCRE2 functions do not handle this, expecting +strings to be in host byte order. +.P +Unless PCRE2_NO_UTF_CHECK is set, a UTF string is checked before any other +processing takes place. In the case of \fBpcre2_match()\fP and +\fBpcre2_dfa_match()\fP calls with a non-zero starting offset, the check is +applied only to that part of the subject that could be inspected during +matching, and there is a check that the starting offset points to the first +code unit of a character or to the end of the subject. If there are no +lookbehind assertions in the pattern, the check starts at the starting offset. +Otherwise, it starts at the length of the longest lookbehind before the +starting offset, or at the start of the subject if there are not that many +characters before the starting offset. Note that the sequences \eb and \eB are +one-character lookbehinds. +.P +In addition to checking the format of the string, there is a check to ensure +that all code points lie in the range U+0 to U+10FFFF, excluding the surrogate +area. The so-called "non-character" code points are not excluded because +Unicode corrigendum #9 makes it clear that they should not be. +.P +Characters in the "Surrogate Area" of Unicode are reserved for use by UTF-16, +where they are used in pairs to encode code points with values greater than +0xFFFF. The code points that are encoded by UTF-16 pairs are available +independently in the UTF-8 and UTF-32 encodings. (In other words, the whole +surrogate thing is a fudge for UTF-16 which unfortunately messes up UTF-8 and +UTF-32.) +.P +Setting PCRE2_NO_UTF_CHECK at compile time does not disable the error that is +given if an escape sequence for an invalid Unicode code point is encountered in +the pattern. If you want to allow escape sequences such as \ex{d800} (a +surrogate code point) you can set the PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES extra +option. However, this is possible only in UTF-8 and UTF-32 modes, because these +values are not representable in UTF-16. +. +. +.\" HTML +.SS "Errors in UTF-8 strings" +.rs +.sp +The following negative error codes are given for invalid UTF-8 strings: +.sp + PCRE2_ERROR_UTF8_ERR1 + PCRE2_ERROR_UTF8_ERR2 + PCRE2_ERROR_UTF8_ERR3 + PCRE2_ERROR_UTF8_ERR4 + PCRE2_ERROR_UTF8_ERR5 +.sp +The string ends with a truncated UTF-8 character; the code specifies how many +bytes are missing (1 to 5). Although RFC 3629 restricts UTF-8 characters to be +no longer than 4 bytes, the encoding scheme (originally defined by RFC 2279) +allows for up to 6 bytes, and this is checked first; hence the possibility of +4 or 5 missing bytes. +.sp + PCRE2_ERROR_UTF8_ERR6 + PCRE2_ERROR_UTF8_ERR7 + PCRE2_ERROR_UTF8_ERR8 + PCRE2_ERROR_UTF8_ERR9 + PCRE2_ERROR_UTF8_ERR10 +.sp +The two most significant bits of the 2nd, 3rd, 4th, 5th, or 6th byte of the +character do not have the binary value 0b10 (that is, either the most +significant bit is 0, or the next bit is 1). +.sp + PCRE2_ERROR_UTF8_ERR11 + PCRE2_ERROR_UTF8_ERR12 +.sp +A character that is valid by the RFC 2279 rules is either 5 or 6 bytes long; +these code points are excluded by RFC 3629. +.sp + PCRE2_ERROR_UTF8_ERR13 +.sp +A 4-byte character has a value greater than 0x10ffff; these code points are +excluded by RFC 3629. +.sp + PCRE2_ERROR_UTF8_ERR14 +.sp +A 3-byte character has a value in the range 0xd800 to 0xdfff; this range of +code points are reserved by RFC 3629 for use with UTF-16, and so are excluded +from UTF-8. +.sp + PCRE2_ERROR_UTF8_ERR15 + PCRE2_ERROR_UTF8_ERR16 + PCRE2_ERROR_UTF8_ERR17 + PCRE2_ERROR_UTF8_ERR18 + PCRE2_ERROR_UTF8_ERR19 +.sp +A 2-, 3-, 4-, 5-, or 6-byte character is "overlong", that is, it codes for a +value that can be represented by fewer bytes, which is invalid. For example, +the two bytes 0xc0, 0xae give the value 0x2e, whose correct coding uses just +one byte. +.sp + PCRE2_ERROR_UTF8_ERR20 +.sp +The two most significant bits of the first byte of a character have the binary +value 0b10 (that is, the most significant bit is 1 and the second is 0). Such a +byte can only validly occur as the second or subsequent byte of a multi-byte +character. +.sp + PCRE2_ERROR_UTF8_ERR21 +.sp +The first byte of a character has the value 0xfe or 0xff. These values can +never occur in a valid UTF-8 string. +. +. +.\" HTML +.SS "Errors in UTF-16 strings" +.rs +.sp +The following negative error codes are given for invalid UTF-16 strings: +.sp + PCRE2_ERROR_UTF16_ERR1 Missing low surrogate at end of string + PCRE2_ERROR_UTF16_ERR2 Invalid low surrogate follows high surrogate + PCRE2_ERROR_UTF16_ERR3 Isolated low surrogate +.sp +. +. +.\" HTML +.SS "Errors in UTF-32 strings" +.rs +.sp +The following negative error codes are given for invalid UTF-32 strings: +.sp + PCRE2_ERROR_UTF32_ERR1 Surrogate character (0xd800 to 0xdfff) + PCRE2_ERROR_UTF32_ERR2 Code point is greater than 0x10ffff +.sp +. +. +.\" HTML +.SH "MATCHING IN INVALID UTF STRINGS" +.rs +.sp +You can run pattern matches on subject strings that may contain invalid UTF +sequences if you call \fBpcre2_compile()\fP with the PCRE2_MATCH_INVALID_UTF +option. This is supported by \fBpcre2_match()\fP, including JIT matching, but +not by \fBpcre2_dfa_match()\fP. When PCRE2_MATCH_INVALID_UTF is set, it forces +PCRE2_UTF to be set as well. Note, however, that the pattern itself must be a +valid UTF string. +.P +If you do not set PCRE2_MATCH_INVALID_UTF when calling \fBpcre2_compile\fP, and +you are not certain that your subject strings are valid UTF sequences, you +should not make use of the JIT "fast path" function \fBpcre2_jit_match()\fP +because it bypasses sanity checks, including the one for UTF validity. An +invalid string may cause undefined behaviour, including looping, crashing, or +giving the wrong answer. +.P +Setting PCRE2_MATCH_INVALID_UTF does not affect what \fBpcre2_compile()\fP +generates, but if \fBpcre2_jit_compile()\fP is subsequently called, it does +generate different code. If JIT is not used, the option affects the behaviour +of the interpretive code in \fBpcre2_match()\fP. When PCRE2_MATCH_INVALID_UTF +is set at compile time, PCRE2_NO_UTF_CHECK is ignored at match time. +.P +In this mode, an invalid code unit sequence in the subject never matches any +pattern item. It does not match dot, it does not match \ep{Any}, it does not +even match negative items such as [^X]. A lookbehind assertion fails if it +encounters an invalid sequence while moving the current point backwards. In +other words, an invalid UTF code unit sequence acts as a barrier which no match +can cross. +.P +You can also think of this as the subject being split up into fragments of +valid UTF, delimited internally by invalid code unit sequences. The pattern is +matched fragment by fragment. The result of a successful match, however, is +given as code unit offsets in the entire subject string in the usual way. There +are a few points to consider: +.P +The internal boundaries are not interpreted as the beginnings or ends of lines +and so do not match circumflex or dollar characters in the pattern. +.P +If \fBpcre2_match()\fP is called with an offset that points to an invalid +UTF-sequence, that sequence is skipped, and the match starts at the next valid +UTF character, or the end of the subject. +.P +At internal fragment boundaries, \eb and \eB behave in the same way as at the +beginning and end of the subject. For example, a sequence such as \ebWORD\eb +would match an instance of WORD that is surrounded by invalid UTF code units. +.P +Using PCRE2_MATCH_INVALID_UTF, an application can run matches on arbitrary +data, knowing that any matched strings that are returned are valid UTF. This +can be useful when searching for UTF text in executable or other binary files. +.P +Note, however, that the 16-bit and 32-bit PCRE2 libraries process strings as +sequences of uint16_t or uint32_t code points. They cannot find valid UTF +sequences within an arbitrary string of bytes unless such sequences are +suitably aligned. +. +. +.SH AUTHOR +.rs +.sp +.nf +Philip Hazel +Retired from University Computing Service +Cambridge, England. +.fi +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 27 November 2024 +Copyright (c) 1997-2024 University of Cambridge. +.fi diff --git a/miniconda3/share/man/man3/readline.3 b/miniconda3/share/man/man3/readline.3 new file mode 100644 index 0000000000000000000000000000000000000000..f66e21a318daf1008d99026534e2d4c76af357c6 --- /dev/null +++ b/miniconda3/share/man/man3/readline.3 @@ -0,0 +1,1887 @@ +.\" +.\" MAN PAGE COMMENTS to +.\" +.\" Chet Ramey +.\" Information Network Services +.\" Case Western Reserve University +.\" chet.ramey@case.edu +.\" +.\" Last Change: Mon Dec 30 11:27:47 EST 2024 +.\" +.TH READLINE 3 "2024 December 30" "GNU Readline 8.3" +.\" +.ie \n(.g \{\ +.ds ' \(aq +.ds " \(dq +.ds ^ \(ha +.ds ~ \(ti +.\} +.el \{\ +.ds ' ' +.\" \*" is not usable in macro arguments on AT&T troff (DWB, Solaris 10) +.ds " ""\" two adjacent quotes and no space before this comment +.ds ^ ^ +.ds ~ ~ +.\} +. +.\" File Name macro. This used to be `.PN', for Path Name, +.\" but Sun doesn't seem to like that very much. +.\" \% at the beginning of the string protects the filename from hyphenation. +.\" +.de FN +\%\fI\|\\$1\|\fP +.. +.\" +.\" Quotation macro: generate consistent quoted strings that don't rely +.\" on the presence of the `CW' constant-width font. +.\" +.de Q +.ie \n(.g \(lq\\$1\(rq\\$2 +.el \{\ +. if t ``\\$1''\\$2 +. if n "\\$1"\\$2 +.\} +.. +.SH NAME +readline \- get a line from a user with editing +.SH SYNOPSIS +.LP +.nf +.ft B +#include +#include +#include +.ft +.fi +.LP +.nf +\fIchar *\fP +.br +\fBreadline\fP (\fIconst char *prompt\fP); +.fi +.SH COPYRIGHT +.if n Readline is Copyright (C) 1989\-2025 Free Software Foundation, Inc. +.if t Readline is Copyright \(co 1989\-2025 Free Software Foundation, Inc. +.SH DESCRIPTION +.LP +.B readline +reads a line from the terminal +and return it, using +.B prompt +as a prompt. +If +.B prompt +is \fBNULL\fP or the empty string, \fBreadline\fP does not issue a prompt. +The line returned is allocated with +.IR malloc (3); +the caller must free it when finished. +The line returned +has the final newline removed, so only the text of the line +remains. +Since it's possible to enter characters into the line while quoting +them to disable any \fBreadline\fP editing function they might normally have, +this line may include embedded newlines and other special characters. +.LP +.B readline +offers editing capabilities while the user is entering the +line. +By default, the line editing commands +are similar to those of emacs. +A vi\-style line editing interface is also available. +.LP +This manual page describes only the most basic use of \fBreadline\fP. +Much more functionality is available; see +\fIThe GNU Readline Library\fP and \fIThe GNU History Library\fP +for additional information. +.SH RETURN VALUE +.LP +.B readline +returns the text of the line read. +A blank line returns the empty string. +If +.B EOF +is encountered while reading a line, and the line is empty, +.B readline +returns +.BR NULL . +If an +.B EOF +is read with a non\-empty line, it is treated as a newline. +.SH NOTATION +.LP +This section uses Emacs-style editing concepts and uses its +notation for keystrokes. +Control keys are denoted by C\-\fIkey\fP, e.g., C\-n means Control\-N. +Similarly, +.I meta +keys are denoted by M\-\fIkey\fP, so M\-x means Meta\-X. +The Meta key is often labeled +.Q Alt +or +.Q Option . +.PP +On keyboards without a +.I Meta +key, M\-\fIx\fP means ESC \fIx\fP, i.e., press and release +the Escape key, then press and release the +.I x +key, in sequence. +This makes ESC the \fImeta prefix\fP. +The combination M\-C\-\fIx\fP means ESC Control\-\fIx\fP: +press and release the Escape key, +then press and hold the Control key while pressing the +.I x +key, then release both. +.PP +On some keyboards, the Meta key modifier produces characters with +the eighth bit (0200) set. +You can use the \fBenable\-meta\-key\fP variable +to control whether or not it does this, if the keyboard allows it. +On many others, the terminal or terminal emulator converts the metafied +key to a key sequence beginning with ESC as described in the +preceding paragraph. +.PP +If your \fIMeta\fP key produces a key sequence with the ESC meta prefix, +you can make M-\fIkey\fP key bindings you specify (see +.B "Readline Key Bindings" +below) do the same thing by setting the \fBforce\-meta\-prefix\fP variable. +.PP +.B Readline +commands may be given numeric +.IR arguments , +which normally act as a repeat count. +Sometimes, however, it is the sign of the argument that is significant. +Passing a negative argument +to a command that acts in the forward direction (e.g., \fBkill\-line\fP) +makes that command act in a backward direction. +Commands whose behavior with arguments deviates from this are noted +below. +.PP +The \fIpoint\fP is the current cursor position, and \fImark\fP refers +to a saved cursor position. +The text between the point and mark is referred to as the \fIregion\fP. +.PP +When a command is described as \fIkilling\fP text, the text +deleted is saved for possible future retrieval +(\fIyanking\fP). +The killed text is saved in a \fIkill ring\fP. +Consecutive kills accumulate the deleted text +into one unit, which can be yanked all at once. +Commands which do not kill text separate the chunks of text +on the kill ring. +.SH INITIALIZATION FILE +.LP +.B Readline +is customized by putting commands in an initialization +file (the \fIinputrc\fP file). +The name of this file is taken from the value of the +.B INPUTRC +environment variable. +If that variable is unset, the default is +.IR \*~/.inputrc . +If that file does not exist or cannot be read, \fBreadline\fP looks for +.IR /etc/inputrc . +When a program that uses the \fBreadline\fP library starts up, +\fBreadline\fP reads the initialization file +and sets the key bindings and variables found there, +before reading any user input. +.PP +There are only a few basic constructs allowed in the inputrc file. +Blank lines are ignored. +Lines beginning with a \fB#\fP are comments. +Lines beginning with a \fB$\fP indicate conditional constructs. +Other lines denote key bindings and variable settings. +.PP +The default key-bindings in this document +may be changed using key binding commands in the +.I inputrc +file. +Programs that use this library +may add their own commands and bindings. +.PP +For example, placing +.RS +.PP +M\-Control\-u: universal\-argument +.RE +or +.RS +C\-Meta\-u: universal\-argument +.RE +.LP +into the +.I inputrc +would make M\-C\-u execute the \fBreadline\fP command +.IR universal\-argument . +.PP +Key bindings may contain the following symbolic character names: +.IR DEL , +.IR ESC , +.IR ESCAPE , +.IR LFD , +.IR NEWLINE , +.IR RET , +.IR RETURN , +.I RUBOUT +(a destructive backspace), +.IR SPACE , +.IR SPC , +and +.IR TAB . +.PP +In addition to command names, \fBreadline\fP allows keys to be bound +to a string that is inserted when the key is pressed (a \fImacro\fP). +The difference between a macro and a command is that a macro is +enclosed in single or double quotes. +.SS Key Bindings +The syntax for controlling key bindings in the +.I inputrc +file is simple. +All that is required is the name of the command or the text of a macro +and a key sequence to which it should be bound. +The key sequence may be specified in one of two ways: +as a symbolic key name, +possibly with \fIMeta\-\fP or \fIControl\-\fP prefixes, +or as a key sequence composed of one or more characters +enclosed in double quotes. +The key sequence and name are separated by a colon. +There can be no whitespace between the name and the colon. +.PP +When using the form \fBkeyname\fP:\^\fIfunction\-name\fP or \fImacro\fP, +.I keyname +is the name of a key spelled out in English. For example: +.PP +.RS +.EX +.nf +Control-u: universal\-argument +Meta-Rubout: backward\-kill\-word +Control-o: \*"> output\*" +.fi +.EE +.RE +.LP +In the above example, +.I C\-u +is bound to the function +.BR universal\-argument , +.I M\-DEL +is bound to the function +.BR backward\-kill\-word , +and +.I C\-o +is bound to run the macro +expressed on the right hand side (that is, to insert the text +.Q "> output" +into the line). +.PP +In the second form, +\fB\*"keyseq\*"\fP:\^\fIfunction\-name\fP or \fImacro\fP, +.B keyseq +differs from +.B keyname +above in that strings denoting +an entire key sequence may be specified by placing the sequence +within double quotes. +Some GNU Emacs style key escapes can be +used, as in the following example, but none of +the symbolic character names are recognized. +.PP +.RS +.EX +.nf +\*"\eC\-u\*": universal\-argument +\*"\eC\-x\eC\-r\*": re\-read\-init\-file +\*"\ee[11\*~\*": \*"Function Key 1\*" +.fi +.EE +.RE +.PP +In this example, +.I C\-u +is again bound to the function +.BR universal\-argument . +.I "C\-x C\-r" +is bound to the function +.BR re\-read\-init\-file , +and +.I "ESC [ 1 1 \*~" +is bound to insert the text +.Q "Function Key 1" . +.PP +The full set of GNU Emacs style escape sequences available when specifying +key sequences is +.RS +.PD 0 +.TP +.B \eC\- +A control prefix. +.TP +.B \eM\- +Adding the meta prefix or converting the following character to a meta +character, as described below under \fBforce-meta-prefix\fP. +.TP +.B \ee +An escape character. +.TP +.B \e\e +Backslash. +.TP +.B \e\*" +Literal \*", a double quote. +.TP +.B \e\*' +Literal \*', a single quote. +.RE +.PD +.PP +In addition to the GNU Emacs style escape sequences, a second +set of backslash escapes is available: +.RS +.PD 0 +.TP +.B \ea +alert (bell) +.TP +.B \eb +backspace +.TP +.B \ed +delete +.TP +.B \ef +form feed +.TP +.B \en +newline +.TP +.B \er +carriage return +.TP +.B \et +horizontal tab +.TP +.B \ev +vertical tab +.TP +.B \e\fInnn\fP +The eight-bit character whose value is the octal value \fInnn\fP +(one to three digits). +.TP +.B \ex\fIHH\fP +The eight-bit character whose value is the hexadecimal value \fIHH\fP +(one or two hex digits). +.RE +.PD +.PP +When entering the text of a macro, single or double quotes must +be used to indicate a macro definition. +Unquoted text is assumed to be a function name. +The backslash escapes described above are expanded +in the macro body. +Backslash quotes any other character in the macro text, +including \*" and \*'. +.PP +.B Bash +will display or modify the current \fBreadline\fP key bindings with the +.B bind +builtin command. +The +.B \-o emacs +or +.B \-o vi +options to the +.B set +builtin +change the editing mode during interactive use. +Other programs using this library provide similar mechanisms. +A user may always edit the +.I inputrc +file and have \fBreadline\fP re-read it if a program does not provide +any other means to incorporate new bindings. +.SS Variables +.B Readline +has variables that can be used to further customize its +behavior. +A variable may be set in the +.I inputrc +file with a statement of the form +.RS +.PP +\fBset\fP \fIvariable\-name\fP \fIvalue\fP +.RE +.PP +Except where noted, \fBreadline\fP variables can take the values +.B On +or +.B Off +(without regard to case). +Unrecognized variable names are ignored. +When \fBreadline\fP reads a variable value, empty or null values, +.Q "on" +(case-insensitive), and +.Q 1 +are equivalent to \fBOn\fP. +All other values are equivalent to +\fBOff\fP. +.PP +The variables and their default values are: +.PP +.PD 0 +.TP +.B active\-region\-start\-color +A string variable that controls the text color and background when displaying +the text in the active region (see the description of +\fBenable\-active\-region\fP below). +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal before displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that puts the terminal in standout mode, +as obtained from the terminal's terminfo description. +A sample value might be +.Q \ee[01;33m . +.TP +.B active\-region\-end\-color +A string variable that +.Q undoes +the effects of \fBactive\-region\-start\-color\fP +and restores +.Q normal +terminal display appearance after displaying text in the active region. +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal after displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that restores the terminal from standout mode, +as obtained from the terminal's terminfo description. +A sample value might be +.Q \ee[0m . +.TP +.B bell\-style (audible) +Controls what happens when \fBreadline\fP wants to ring the terminal bell. +If set to \fBnone\fP, \fBreadline\fP never rings the bell. +If set to \fBvisible\fP, \fBreadline\fP uses a visible bell if one is available. +If set to \fBaudible\fP, \fBreadline\fP attempts to ring the terminal's bell. +.TP +.B bind\-tty\-special\-chars (On) +If set to \fBOn\fP, \fBreadline\fP attempts to bind +the control characters that are treated specially by the kernel's +terminal driver to their \fBreadline\fP equivalents. +These override the default \fBreadline\fP bindings described here. +Type +.Q "stty \-a" +at a \fBbash\fP prompt to see your current terminal settings, +including the special control characters (usually \fBcchars\fP). +.TP +.B blink\-matching\-paren (Off) +If set to \fBOn\fP, \fBreadline\fP attempts to briefly move the cursor to an +opening parenthesis when a closing parenthesis is inserted. +.TP +.B colored\-completion\-prefix (Off) +If set to \fBOn\fP, when listing completions, \fBreadline\fP displays the +common prefix of the set of possible completions using a different color. +The color definitions are taken from the value of the \fBLS_COLORS\fP +environment variable. +If there is a color definition in \fB$LS_COLORS\fP for the custom suffix +.Q readline-colored-completion-prefix , +\fBreadline\fP uses this color for +the common prefix instead of its default. +.TP +.B colored\-stats (Off) +If set to \fBOn\fP, \fBreadline\fP displays possible completions using different +colors to indicate their file type. +The color definitions are taken from the value of the \fBLS_COLORS\fP +environment variable. +.\" Tucking multiple macro calls into a paragraph tag requires some +.\" finesse. We require `\c`, and while the single-font macros don't +.\" honor input trap continuation, the font alternation macros do. +.TP +.BR comment\-begin\ ( \c +.Q \fB#\fP \fB)\fP +The string that the \fBreadline\fP +.B insert\-comment +command inserts. +This command is bound to +.B M\-# +in emacs mode and to +.B # +in vi command mode. +.TP +.B completion\-display\-width (\-1) +The number of screen columns used to display possible matches +when performing completion. +The value is ignored if it is less than 0 or greater than the terminal +screen width. +A value of 0 causes matches to be displayed one per line. +The default value is \-1. +.TP +.B completion\-ignore\-case (Off) +If set to \fBOn\fP, \fBreadline\fP performs filename matching and completion +in a case\-insensitive fashion. +.TP +.B completion\-map\-case (Off) +If set to \fBOn\fP, and \fBcompletion\-ignore\-case\fP is enabled, +\fBreadline\fP +treats hyphens (\fI\-\fP) and underscores (\fI_\fP) as equivalent when +performing case\-insensitive filename matching and completion. +.TP +.B completion\-prefix\-display\-length (0) +The maximum +length in characters of the common prefix of a list of possible +completions that is displayed without modification. +When set to a value greater than zero, \fBreadline\fP +replaces common prefixes longer than this value +with an ellipsis when displaying possible completions. +If a completion begins with a period, +and \fBeadline\fP is completing filenames, +it uses three underscores instead of an ellipsis. +.TP +.B completion\-query\-items (100) +This determines when the user is queried about viewing +the number of possible completions +generated by the \fBpossible\-completions\fP command. +It may be set to any integer value greater than or equal to zero. +If the number of possible completions is greater than +or equal to the value of this variable, +\fBreadline\fP asks whether or not the user wishes to view them; +otherwise \fBreadline\fP simply lists them on the terminal. +A zero value means \fBreadline\fP should never ask; negative values are +treated as zero. +.TP +.B convert\-meta (On) +If set to \fBOn\fP, \fBreadline\fP converts characters it reads +that have the eighth bit set to an ASCII key sequence by +clearing the eighth bit and prefixing it with an escape character +(converting the character to have the meta prefix). +The default is \fIOn\fP, but \fBreadline\fP sets it to \fIOff\fP +if the locale contains +characters whose encodings may include bytes with the eighth bit set. +This variable is dependent on the \fBLC_CTYPE\fP locale category, and +may change if the locale changes. +This variable also affects key bindings; see the description of +\fBforce\-meta\-prefix\fP below. +.TP +.B disable\-completion (Off) +If set to \fBOn\fP, \fBreadline\fP inhibits word completion. +Completion characters are inserted into the line as if they +had been mapped to \fBself-insert\fP. +.TP +.B echo\-control\-characters (On) +When set to \fBOn\fP, on operating systems that indicate they support it, +\fBreadline\fP echoes a character corresponding to a signal generated from the +keyboard. +.TP +.B editing\-mode (emacs) +Controls whether \fBreadline\fP uses a set of key bindings similar +to \fIEmacs\fP or \fIvi\fP. +.B editing\-mode +can be set to either +.B emacs +or +.BR vi . +.TP +.B emacs\-mode\-string (@) +If the \fIshow\-mode\-in\-prompt\fP variable is enabled, +this string is displayed immediately before the last line of the +primary prompt when emacs editing mode is active. +The value is expanded like a +key binding, so the standard set of meta- and control- prefixes and +backslash escape sequences is available. +The \e1 and \e2 escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +.TP +.B enable\-active\-region (On) +When this variable is set to \fIOn\fP, \fBreadline\fP allows certain commands +to designate the region as \fIactive\fP. +When the region is active, \fBreadline\fP +highlights the text in the region using the value of the +.B active\-region\-start\-color +variable, which defaults to the string that enables +the terminal's standout mode. +The active region shows the text inserted by bracketed-paste and any +matching text found by incremental and non-incremental history searches. +.TP +.B enable\-bracketed\-paste (On) +When set to \fBOn\fP, \fBreadline\fP configures the terminal to insert each +paste into the editing buffer as a single string of characters, instead +of treating each character as if it had been read from the keyboard. +This is called \fIbracketed\-paste mode\fP; +it prevents \fBreadline\fP from executing any editing commands bound to key +sequences appearing in the pasted text. +.TP +.B enable\-keypad (Off) +When set to \fBOn\fP, \fBreadline\fP tries to enable the application +keypad when it is called. +Some systems need this to enable the arrow keys. +.TP +.B enable\-meta\-key (On) +When set to \fBOn\fP, \fBreadline\fP tries to enable any meta modifier +key the terminal claims to support. +On many terminals, the Meta key is used to send eight-bit characters; +this variable checks for the terminal capability that indicates the +terminal can enable and disable a mode that sets the eighth bit of a +character (0200) if the Meta key is held down when the character is +typed (a meta character). +.TP +.B expand\-tilde (Off) +If set to \fBOn\fP, \fBreadline\fP performs tilde expansion when it +attempts word completion. +.TP +.B force\-meta\-prefix (Off) +If set to \fBOn\fP, \fBreadline\fP modifies its behavior when binding key +sequences containing \eM- or Meta- +(see \fBKey Bindings\fP above) by converting a key sequence of the form +\eM\-\fIC\fP or Meta\-\fIC\fP to the two-character sequence +\fBESC\fP \fIC\fP (adding the meta prefix). +If +.B force\-meta\-prefix +is set to \fBOff\fP (the default), +\fBreadline\fP uses the value of the +.B convert\-meta +variable to determine whether to perform this conversion: +if \fBconvert\-meta\fP is \fBOn\fP, +\fBreadline\fP performs the conversion described above; +if it is \fBOff\fP, \fBreadline\fP converts \fIC\fP to a meta character by +setting the eighth bit (0200). +.TP +.B history\-preserve\-point (Off) +If set to \fBOn\fP, the history code attempts to place point at the +same location on each history line retrieved with \fBprevious-history\fP +or \fBnext-history\fP. +.TP +.B history\-size (unset) +Set the maximum number of history entries saved in the history list. +If set to zero, any existing history entries are deleted and no new entries +are saved. +If set to a value less than zero, the number of history entries is not +limited. +By default, the number of history entries is not limited. +Setting \fIhistory\-size\fP to a non-numeric value will set +the maximum number of history entries to 500. +.TP +.B horizontal\-scroll\-mode (Off) +Setting this variable to \fBOn\fP makes \fBreadline\fP use a single line +for display, scrolling the input horizontally on a single screen line +when it becomes longer than the screen width rather than wrapping to +a new line. +This setting is automatically enabled for terminals of height 1. +.TP +.B input\-meta (Off) +If set to \fBOn\fP, \fBreadline\fP enables eight-bit input (that is, it +does not clear the eighth bit in the characters it reads), +regardless of what the terminal claims it can support. +The default is \fIOff\fP, but \fBreadline\fP sets it to \fIOn\fP +if the locale contains characters whose encodings may include bytes +with the eighth bit set. +This variable is dependent on the \fBLC_CTYPE\fP locale category, and +its value may change if the locale changes. +The name \fBmeta\-flag\fP is a synonym for \fBinput\-meta\fP. +.TP +.BR isearch\-terminators\ ( \c +.Q \fBC\-[C\-j\fP \fB)\fP +The string of characters that should terminate an incremental +search without subsequently executing the character as a command. +If this variable has not been given a value, the characters +\fIESC\fP and \fBC\-j\fP terminate an incremental search. +.TP +.B keymap (emacs) +Set the current \fBreadline\fP keymap. +The set of valid keymap names is +\fIemacs, emacs\-standard, emacs\-meta, emacs\-ctlx, vi, +vi\-command\fP, and +.IR vi\-insert . +\fIvi\fP is equivalent to \fIvi\-command\fP; +\fIemacs\fP is equivalent to \fIemacs\-standard\fP. +The default value is \fIemacs\fP; +the value of +.B editing\-mode +also affects the default keymap. +.TP +.B keyseq\-timeout (500) +Specifies the duration \fBreadline\fP will wait for a character when +reading an ambiguous key sequence +(one that can form a complete key sequence using the input read so far, +or can take additional input to complete a longer key sequence). +If \fBreadline\fP does not receive any input within the timeout, +it uses the shorter but complete key sequence. +The value is specified in milliseconds, so a value of 1000 means that +\fBreadline\fP will wait one second for additional input. +If this variable is set to a value less than or equal to zero, or to a +non-numeric value, \fBreadline\fP waits until another key is pressed to +decide which key sequence to complete. +.TP +.B mark\-directories (On) +If set to \fBOn\fP, completed directory names have a slash appended. +.TP +.B mark\-modified\-lines (Off) +If set to \fBOn\fP, \fBreadline\fP displays history lines +that have been modified +with a preceding asterisk (\fB*\fP). +.TP +.B mark\-symlinked\-directories (Off) +If set to \fBOn\fP, completed names which are symbolic links to directories +have a slash appended, subject to the value of \fBmark\-directories\fP. +.TP +.B match\-hidden\-files (On) +This variable, when set to \fBOn\fP, forces \fBreadline\fP to match files whose +names begin with a +.Q . +(hidden files) when performing filename completion. +If set to \fBOff\fP, the user must include the leading +.Q . +in the filename to be completed. +.TP +.B menu\-complete\-display\-prefix (Off) +If set to \fBOn\fP, menu completion displays the common prefix of the +list of possible completions (which may be empty) before cycling through +the list. +.TP +.B output\-meta (Off) +If set to \fBOn\fP, \fBreadline\fP displays characters with the +eighth bit set directly rather than as a meta-prefixed escape +sequence. +The default is \fIOff\fP, but \fBreadline\fP sets it to \fIOn\fP +if the locale contains characters whose encodings may include +bytes with the eighth bit set. +This variable is dependent on the \fBLC_CTYPE\fP locale category, and +its value may change if the locale changes. +.TP +.B page\-completions (On) +If set to \fBOn\fP, \fBreadline\fP uses an internal pager resembling +.IR more (1) +to display a screenful of possible completions at a time. +.TP +.B prefer\-visible\-bell +See \fBbell\-style\fP. +.TP +.B print\-completions\-horizontally (Off) +If set to \fBOn\fP, \fBreadline\fP displays completions with matches +sorted horizontally in alphabetical order, rather than down the screen. +.TP +.B revert\-all\-at\-newline (Off) +If set to \fBOn\fP, \fBreadline\fP will undo all changes to history lines +before returning when executing \fBaccept\-line\fP. +By default, +history lines may be modified and retain individual undo lists across +calls to \fBreadline()\fP. +.TP +.B search\-ignore\-case (Off) +If set to \fBOn\fP, \fBreadline\fP performs incremental and non-incremental +history list searches in a case\-insensitive fashion. +.TP +.B show\-all\-if\-ambiguous (Off) +This alters the default behavior of the completion functions. +If set to +.BR On , +words which have more than one possible completion cause the +matches to be listed immediately instead of ringing the bell. +.TP +.B show\-all\-if\-unmodified (Off) +This alters the default behavior of the completion functions in +a fashion similar to \fBshow\-all\-if\-ambiguous\fP. +If set to +.BR On , +words which have more than one possible completion without any +possible partial completion (the possible completions don't share +a common prefix) cause the matches to be listed immediately instead +of ringing the bell. +.TP +.B show\-mode\-in\-prompt (Off) +If set to \fBOn\fP, add a string to the beginning of the prompt +indicating the editing mode: emacs, vi command, or vi insertion. +The mode strings are user-settable (e.g., \fIemacs\-mode\-string\fP). +.TP +.B skip\-completed\-text (Off) +If set to \fBOn\fP, this alters the default completion behavior when +inserting a single match into the line. +It's only active when performing completion in the middle of a word. +If enabled, \fBreadline\fP does not insert characters from the completion +that match characters after point in the word being completed, +so portions of the word following the cursor are not duplicated. +.TP +.B vi\-cmd\-mode\-string ((cmd)) +If the \fIshow\-mode\-in\-prompt\fP variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in command mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The \e1 and \e2 escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +.TP +.B vi\-ins\-mode\-string ((ins)) +If the \fIshow\-mode\-in\-prompt\fP variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in insertion mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The \e1 and \e2 escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +.TP +.B visible\-stats (Off) +If set to \fBOn\fP, a character denoting a file's type as reported +by \fIstat\fP(2) is appended to the filename when listing possible +completions. +.PD +.SS Conditional Constructs +.B Readline +implements a facility similar in spirit to the conditional +compilation features of the C preprocessor which allows key +bindings and variable settings to be performed as the result +of tests. +There are four parser directives available. +.TP +.B $if +The +.B $if +construct allows bindings to be made based on the +editing mode, the terminal being used, or the application using +\fBreadline\fP. +The text of the test, after any comparison operator, +extends to the end of the line; +unless otherwise noted, no characters are required to isolate it. +.RS +.TP +.B mode +The \fBmode=\fP form of the \fB$if\fP directive is used to test +whether \fBreadline\fP is in emacs or vi mode. +This may be used in conjunction +with the \fBset keymap\fP command, for instance, to set bindings in +the \fIemacs\-standard\fP and \fIemacs\-ctlx\fP keymaps only if +\fBreadline\fP is starting out in emacs mode. +.TP +.B term +The \fBterm=\fP form may be used to include terminal-specific +key bindings, perhaps to bind the key sequences output by the +terminal's function keys. +The word on the right side of the +.B = +is tested against both the full name of the terminal and the portion +of the terminal name before the first \fB\-\fP. +This allows +.I xterm +to match both +.I xterm +and +.IR xterm\-256color , +for instance. +.TP +.B version +The \fBversion\fP test may be used to perform comparisons against +specific \fBreadline\fP versions. +The \fBversion\fP expands to the current \fBreadline\fP version. +The set of comparison operators includes +.BR = , +(and +.BR == ), +.BR != , +.BR <= , +.BR >= , +.BR < , +and +.BR > . +The version number supplied on the right side of the operator consists +of a major version number, an optional decimal point, and an optional +minor version (e.g., \fB7.1\fP). +If the minor version is omitted, it +defaults to \fB0\fP. +The operator may be separated from the string \fBversion\fP +and from the version number argument by whitespace. +.TP +.I application +The \fIapplication\fP construct is used to include +application-specific settings. +Each program using the \fBreadline\fP +library sets the \fIapplication name\fP, and an initialization +file can test for a particular value. +This could be used to bind key sequences to functions useful for +a specific program. +For instance, the following command adds a +key sequence that quotes the current or previous word in \fBbash\fP: +.PP +.RS +.EX +.nf +\fB$if\fP Bash +# Quote the current or previous word +\*"\eC-xq\*": \*"\eeb\e\*"\eef\e\*"\*" +\fB$endif\fP +.fi +.EE +.RE +.TP +.I variable +The \fIvariable\fP construct provides simple equality tests for \fBreadline\fP +variables and values. +The permitted comparison operators are \fI=\fP, \fI==\fP, and \fI!=\fP. +The variable name must be separated from the comparison operator by +whitespace; the operator may be separated from the value on the right hand +side by whitespace. +String and boolean variables may be tested. +Boolean variables must be +tested against the values \fIon\fP and \fIoff\fP. +.RE +.TP +.B $else +Commands in this branch of the \fB$if\fP directive are executed if +the test fails. +.TP +.B $endif +This command, as seen in the previous example, terminates an +\fB$if\fP command. +.TP +.B $include +This directive takes a single filename as an argument and reads commands +and key bindings from that file. +For example, the following directive would read \fI/etc/inputrc\fP: +.PP +.RS +.nf +\fB$include\fP \^ \fI/etc/inputrc\fP +.fi +.RE +.SH SEARCHING +.B Readline +provides commands for searching through the command history +for lines containing a specified string. +There are two search modes: +.I incremental +and +.IR non-incremental . +.PP +Incremental searches begin before the user has finished typing the +search string. +As each character of the search string is typed, \fBreadline\fP displays +the next entry from the history matching the string typed so far. +An incremental search requires only as many characters as needed to +find the desired history entry. +When using emacs editing mode, type \fBC\-r\fP to +search backward in the history for a particular string. +Typing \fBC\-s\fP searches forward through the history. +The characters present in the value of the \fBisearch-terminators\fP +variable are used to terminate an incremental search. +If that variable has not been assigned a value, +\fIESC\fP and \fBC\-j\fP terminate an incremental search. +\fBC\-g\fP aborts an incremental search and restores the original line. +When the search is terminated, the history entry containing the +search string becomes the current line. +.PP +To find other matching entries in the history list, type \fBC\-r\fP or +\fBC\-s\fP as appropriate. +This searches backward or forward in the history for the next +entry matching the search string typed so far. +Any other key sequence bound to a \fBreadline\fP command terminates +the search and executes that command. +For instance, a newline terminates the search and accepts +the line, thereby executing the command from the history list. +A movement command will terminate the search, make the last line found +the current line, and begin editing. +.PP +.B Readline +remembers the last incremental search string. +If two \fBC\-r\fPs are typed without any intervening characters defining +a new search string, \fBreadline\fP uses any remembered search string. +.PP +Non-incremental searches read the entire search string before starting +to search for matching history entries. +The search string may be +typed by the user or be part of the contents of the current line. +.SH EDITING COMMANDS +The following is a list of the names of the commands and the default +key sequences to which they are bound. +Command names without an accompanying key sequence are unbound by default. +.PP +In the following descriptions, \fIpoint\fP refers to the current cursor +position, and \fImark\fP refers to a cursor position saved by the +\fBset\-mark\fP command. +The text between the point and mark is referred to as the \fIregion\fP. +.B Readline +has the concept of an \fIactive region\fP: +when the region is active, \fBreadline\fP redisplay +highlights the region using the value of the +.B active\-region\-start\-color +variable. +The \fBenable\-active\-region\fP variable turns this on and off. +Several commands set the region to active; those are noted below. +.SS Commands for Moving +.PD 0 +.TP +.B beginning\-of\-line (C\-a) +Move to the start of the current line. +This may also be bound to the Home key on some keyboards. +.TP +.B end\-of\-line (C\-e) +Move to the end of the line. +This may also be bound to the End key on some keyboards. +.TP +.B forward\-char (C\-f) +Move forward a character. +This may also be bound to the right arrow key on some keyboards. +.TP +.B backward\-char (C\-b) +Move back a character. +.TP +.B forward\-word (M\-f) +Move forward to the end of the next word. +Words are composed of alphanumeric characters (letters and digits). +.TP +.B backward\-word (M\-b) +Move back to the start of the current or previous word. +Words are composed of alphanumeric characters (letters and digits). +.TP +.B previous\-screen\-line +Attempt to move point to the same physical screen column on the previous +physical screen line. +This will not have the desired effect if the current +\fBreadline\fP line does not take up more than one physical line or if +point is not greater than the length of the prompt plus the screen width. +.TP +.B next\-screen\-line +Attempt to move point to the same physical screen column on the next +physical screen line. +This will not have the desired effect if the current +\fBreadline\fP line does not take up more than one physical line or if +the length of the current \fBreadline\fP line is +not greater than the length of the prompt +plus the screen width. +.TP +.B clear\-display (M\-C\-l) +Clear the screen and, if possible, the terminal's scrollback buffer, +then redraw the current line, +leaving the current line at the top of the screen. +.TP +.B clear\-screen (C\-l) +Clear the screen, +then redraw the current line, +leaving the current line at the top of the screen. +With a numeric argument, refresh the current line without clearing the +screen. +.TP +.B redraw\-current\-line +Refresh the current line. +.PD +.SS Commands for Manipulating the History +.PD 0 +.TP +.B accept\-line (Newline, Return) +Accept the line regardless of where the cursor is. +If this line is non-empty, +it may be added to the history list for future recall with +\fBadd_history()\fP. +If the line is a modified history line, +restore the history line to its original state. +.TP +.B previous\-history (C\-p) +Fetch the previous command from the history list, moving back in +the list. +This may also be bound to the up arrow key on some keyboards. +.TP +.B next\-history (C\-n) +Fetch the next command from the history list, moving forward in the +list. +This may also be bound to the down arrow key on some keyboards. +.TP +.B beginning\-of\-history (M\-<) +Move to the first line in the history. +.TP +.B end\-of\-history (M\->) +Move to the end of the input history, i.e., the line currently being +entered. +.TP +.B operate\-and\-get\-next (C\-o) +Accept the current line for return to the calling application as if a +newline had been entered, +and fetch the next line relative to the current line from the history +for editing. +A numeric argument, if supplied, specifies the history entry to use instead +of the current line. +.TP +.B +fetch\-history +With a numeric argument, fetch that entry from the history list +and make it the current line. +Without an argument, move back to the first entry in the history list. +.TP +.B reverse\-search\-history (C\-r) +Search backward starting at the current line and moving +.Q up +through the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +.TP +.B forward\-search\-history (C\-s) +Search forward starting at the current line and moving +.Q down +through the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +.TP +.B non\-incremental\-reverse\-search\-history (M\-p) +Search backward through the history starting at the current line +using a non-incremental search for a string supplied by the user. +The search string may match anywhere in a history line. +.TP +.B non\-incremental\-forward\-search\-history (M\-n) +Search forward through the history using a non-incremental search +for a string supplied by the user. +The search string may match anywhere in a history line. +.TP +.B history\-search\-backward +Search backward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +This may be bound to the Page Up key on some keyboards. +.TP +.B history\-search\-forward +Search forward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +This may be bound to the Page Down key on some keyboards. +.TP +.B history\-substring\-search\-backward +Search backward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +.TP +.B history\-substring\-search\-forward +Search forward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +.TP +.B yank\-nth\-arg (M\-C\-y) +Insert the first argument to the previous command (usually +the second word on the previous line) at point. +With an argument +.IR n , +insert the \fIn\fPth word from the previous command (the words +in the previous command begin with word 0). +A negative argument inserts the \fIn\fPth word from the end of +the previous command. +Once the argument \fIn\fP is computed, +this uses the history expansion facilities to extract the +\fIn\fPth word, as if the +.Q !\fIn\fP +history expansion had been specified. +.TP +.B +yank\-last\-arg (M\-.\^, M\-_\^) +Insert the last argument to the previous command (the last word of +the previous history entry). +With a numeric argument, behave exactly like \fByank\-nth\-arg\fP. +Successive calls to \fByank\-last\-arg\fP move back through the history +list, inserting the last word (or the word specified by the argument to +the first call) of each line in turn. +Any numeric argument supplied to these successive calls determines +the direction to move through the history. +A negative argument switches the direction through the history +(back or forward). +This uses the history expansion facilities to extract the +last word, as if the +.Q !$ +history expansion had been specified. +.PD +.SS Commands for Changing Text +.PD 0 +.TP +.B \fIend\-of\-file\fP (usually C\-d) +The character indicating end-of-file as set, for example, by +.IR stty (1). +If this character is read when there are no characters +on the line, and point is at the beginning of the line, \fBreadline\fP +interprets it as the end of input and returns +.SM +.BR EOF . +.TP +.B delete\-char (C\-d) +Delete the character at point. +If this function is bound to the +same character as the tty \fBEOF\fP character, as \fBC\-d\fP +commonly is, see above for the effects. +This may also be bound to the Delete key on some keyboards. +.TP +.B backward\-delete\-char (Rubout) +Delete the character behind the cursor. +When given a numeric argument, +save the deleted text on the kill ring. +.TP +.B forward\-backward\-delete\-char +Delete the character under the cursor, unless the cursor is at the +end of the line, in which case the character behind the cursor is +deleted. +.TP +.B quoted\-insert (C\-q, C\-v) +Add the next character typed to the line verbatim. +This is how to insert characters like \fBC\-q\fP, for example. +.TP +.B tab\-insert (M-TAB) +Insert a tab character. +.TP +.B "self\-insert (a, b, A, 1, !, \fR.\|.\|.\fP)" +Insert the character typed. +.TP +.B bracketed\-paste\-begin +This function is intended to be bound to the +.Q "bracketed paste" +escape +sequence sent by some terminals, and such a binding is assigned by default. +It allows \fBreadline\fP to insert the pasted text as a single unit +without treating each character as if it had been read from the keyboard. +The pasted characters +are inserted as if each one was bound to \fBself\-insert\fP instead of +executing any editing commands. +.IP +Bracketed paste sets the region to the inserted text and activates the region. +.TP +.B transpose\-chars (C\-t) +Drag the character before point forward over the character at point, +moving point forward as well. +If point is at the end of the line, then this transposes +the two characters before point. +Negative arguments have no effect. +.TP +.B transpose\-words (M\-t) +Drag the word before point past the word after point, +moving point past that word as well. +If point is at the end of the line, this transposes +the last two words on the line. +.TP +.B upcase\-word (M\-u) +Uppercase the current (or following) word. +With a negative argument, +uppercase the previous word, but do not move point. +.TP +.B downcase\-word (M\-l) +Lowercase the current (or following) word. +With a negative argument, +lowercase the previous word, but do not move point. +.TP +.B capitalize\-word (M\-c) +Capitalize the current (or following) word. +With a negative argument, +capitalize the previous word, but do not move point. +.TP +.B overwrite\-mode +Toggle overwrite mode. +With an explicit positive numeric argument, switches to overwrite mode. +With an explicit non-positive numeric argument, switches to insert mode. +This command affects only \fBemacs\fP mode; +\fBvi\fP mode does overwrite differently. +Each call to \fIreadline()\fP starts in insert mode. +.IP +In overwrite mode, characters bound to \fBself\-insert\fP replace +the text at point rather than pushing the text to the right. +Characters bound to \fBbackward\-delete\-char\fP replace the character +before point with a space. +By default, this command is unbound, +but may be bound to the Insert key on some keyboards. +.PD +.SS Killing and Yanking +.PD 0 +.TP +.B kill\-line (C\-k) +Kill the text from point to the end of the current line. +With a negative numeric argument, kill backward from the cursor to the +beginning of the line. +.TP +.B backward\-kill\-line (C\-x Rubout) +Kill backward to the beginning of the current line. +With a negative numeric argument, kill forward from the cursor to the +end of the line. +.TP +.B unix\-line\-discard (C\-u) +Kill backward from point to the beginning of the line, +saving the killed text on the kill-ring. +.\" There is no real difference between this and backward-kill-line +.TP +.B kill\-whole\-line +Kill all characters on the current line, no matter where point is. +.TP +.B kill\-word (M\-d) +Kill from point to the end of the current word, or if between +words, to the end of the next word. +Word boundaries are the same as those used by \fBforward\-word\fP. +.TP +.B backward\-kill\-word (M\-Rubout) +Kill the word behind point. +Word boundaries are the same as those used by \fBbackward\-word\fP. +.TP +.B unix\-word\-rubout (C\-w) +Kill the word behind point, using white space as a word boundary, +saving the killed text on the kill-ring. +.TP +.B unix\-filename\-rubout +Kill the word behind point, using white space and the slash character +as the word boundaries, +saving the killed text on the kill-ring. +.TP +.B delete\-horizontal\-space (M\-\e) +Delete all spaces and tabs around point. +.TP +.B kill\-region +Kill the text in the current region. +.TP +.B copy\-region\-as\-kill +Copy the text in the region to the kill buffer, +so it can be yanked immediately. +.TP +.B copy\-backward\-word +Copy the word before point to the kill buffer. +The word boundaries are the same as \fBbackward\-word\fP. +.TP +.B copy\-forward\-word +Copy the word following point to the kill buffer. +The word boundaries are the same as \fBforward\-word\fP. +.TP +.B yank (C\-y) +Yank the top of the kill ring into the buffer at point. +.TP +.B yank\-pop (M\-y) +Rotate the kill ring, and yank the new top. +Only works following +.B yank +or +.BR yank\-pop . +.PD +.SS Numeric Arguments +.PD 0 +.TP +.B digit\-argument (M\-0, M\-1, \fR.\|.\|.\fP, M\-\-) +Add this digit to the argument already accumulating, or start a new +argument. +M\-\- starts a negative argument. +.TP +.B universal\-argument +This is another way to specify an argument. +If this command is followed by one or more digits, optionally with a +leading minus sign, those digits define the argument. +If the command is followed by digits, executing +.B universal\-argument +again ends the numeric argument, but is otherwise ignored. +As a special case, if this command is immediately followed by a +character that is neither a digit nor minus sign, +the argument count for the next command is multiplied by four. +The argument count is initially one, so executing this function the +first time makes the argument count four, a second time makes the +argument count sixteen, and so on. +.PD +.SS Completing +.PD 0 +.TP +.B complete (TAB) +Attempt to perform completion on the text before point. +The actual completion performed is application-specific. +.BR Bash , +for instance, attempts programmable completion first, +otherwise treating the text as a +variable (if the text begins with \fB$\fP), +username (if the text begins with \fB\*~\fP), +hostname (if the text begins with \fB@\fP), or +command (including aliases, functions, and builtins) in turn. +If none of these produces a match, it falls back to filename completion. +.BR Gdb , +on the other hand, +allows completion of program functions and variables, and +only attempts filename completion under certain circumstances. +The default \fBreadline\fP completion is filename completion. +.TP +.B possible\-completions (M\-?) +List the possible completions of the text before point. +When displaying completions, \fBreadline\fP sets the number of columns used +for display to the value of \fBcompletion-display-width\fP, the value of +the environment variable +.BR COLUMNS , +or the screen width, in that order. +.TP +.B insert\-completions (M\-*) +Insert all completions of the text before point +that would have been generated by +\fBpossible\-completions\fP, +separated by a space. +.TP +.B menu\-complete +Similar to \fBcomplete\fP, but replaces the word to be completed +with a single match from the list of possible completions. +Repeatedly executing \fBmenu\-complete\fP steps through the list +of possible completions, inserting each match in turn. +At the end of the list of completions, +\fBmenu\-complete\fP rings the bell +(subject to the setting of \fBbell\-style\fP) +and restores the original text. +An argument of \fIn\fP moves \fIn\fP positions forward in the list +of matches; a negative argument moves backward through the list. +This command is intended to be bound to \fBTAB\fP, but is unbound +by default. +.TP +.B menu\-complete\-backward +Identical to \fBmenu\-complete\fP, but moves backward through the list +of possible completions, as if \fBmenu\-complete\fP had been given a +negative argument. +This command is unbound by default. +.TP +.B export\-completions +Perform completion on the word before point as described above +and write the list of possible completions to \fBreadline\fP's output +stream using the following format, writing information on separate lines: +.RS +.PD +.IP \(bu +.PD 0 +the number of matches \fIN\fP; +.IP \(bu +the word being completed; +.IP \(bu +\fIS\fP:\fIE\fP, +where \fIS\fP and \fIE\fP are the start and end offsets of the word +in the \fBreadline\fP line buffer; then +.IP \(bu +each match, one per line +.RE +.PD +.IP +If there are no matches, the first line will be +.Q 0 , +and this command does not print any output after the \fIS\fP:\fIE\fP. +If there is only a single match, this prints a single line containing it. +If there is more than one match, this prints the common prefix of the +matches, which may be empty, on the first line after the \fIS\fP:\fIE\fP, +then the matches on subsequent lines. +In this case, \fIN\fP will include the first line with the common prefix. +.IP +The user or application +should be able to accommodate the possibility of a blank line. +The intent is that the user or application reads \fIN\fP lines after +the line containing \fIS\fP:\fIE\fP to obtain the match list. +This command is unbound by default. +.TP +.B delete\-char\-or\-list +Deletes the character under the cursor if not at the beginning or +end of the line (like \fBdelete\-char\fP). +At the end of the line, it behaves identically to \fBpossible\-completions\fP. +This command is unbound by default. +.PD +.SS "Keyboard Macros" +.PD 0 +.TP +.B start\-kbd\-macro (C\-x (\^) +Begin saving the characters typed into the current keyboard macro. +.TP +.B end\-kbd\-macro (C\-x )\^) +Stop saving the characters typed into the current keyboard macro +and store the definition. +.TP +.B call\-last\-kbd\-macro (C\-x e) +Re-execute the last keyboard macro defined, by making the characters +in the macro appear as if typed at the keyboard. +.TP +.B print\-last\-kbd\-macro () +Print the last keyboard macro defined in a format suitable for the +\fIinputrc\fP file. +.PD +.SS Miscellaneous +.PD 0 +.TP +.B re\-read\-init\-file (C\-x C\-r) +Read in the contents of the \fIinputrc\fP file, and incorporate +any bindings or variable assignments found there. +.TP +.B abort (C\-g) +Abort the current editing command and +ring the terminal's bell (subject to the setting of +.BR bell\-style ). +.TP +.B do\-lowercase\-version (M\-A, M\-B, M\-\fIx\fP, \fR.\|.\|.\fP) +If the metafied character \fIx\fP is uppercase, run the command +that is bound to the corresponding metafied lowercase character. +The behavior is undefined if \fIx\fP is already lowercase. +.TP +.B prefix\-meta (ESC) +Metafy the next character typed. +.SM +.B ESC +.B f +is equivalent to +.BR Meta\-f . +.TP +.B undo (C\-_, C\-x C\-u) +Incremental undo, separately remembered for each line. +.TP +.B revert\-line (M\-r) +Undo all changes made to this line. +This is like executing the +.B undo +command enough times to return the line to its initial state. +.TP +.B tilde\-expand (M\-~) +Perform tilde expansion on the current word. +.TP +.B set\-mark (C\-@, M\-) +Set the mark to the point. +If a numeric argument is supplied, set the mark to that position. +.TP +.B exchange\-point\-and\-mark (C\-x C\-x) +Swap the point with the mark. +Set the current cursor position to the saved position, +then set the mark to the old cursor position. +.TP +.B character\-search (C\-]) +Read a character and move point to the next occurrence of that character. +A negative argument searches for previous occurrences. +.TP +.B character\-search\-backward (M\-C\-]) +Read a character and move point to the previous occurrence of that character. +A negative argument searches for subsequent occurrences. +.TP +.B skip\-csi\-sequence +Read enough characters to consume a multi-key sequence such as those +defined for keys like Home and End. +CSI sequences begin with a Control Sequence Indicator (CSI), usually +.IR "ESC [" . +If this sequence is bound to +.Q \ee[ , +keys producing CSI sequences have no effect +unless explicitly bound to a \fBreadline\fP command, +instead of inserting stray characters into the editing buffer. +This is unbound by default, but usually bound to +.IR "ESC [" . +.TP +.B insert\-comment (M\-#) +Without a numeric argument, insert the value of the \fBreadline\fP +.B comment\-begin +variable at the beginning of the current line. +If a numeric argument is supplied, this command acts as a toggle: if +the characters at the beginning of the line do not match the value +of \fBcomment\-begin\fP, insert the value; otherwise delete +the characters in \fBcomment-begin\fP from the beginning of the line. +In either case, the line is accepted as if a newline had been typed. +The default value of +\fBcomment\-begin\fP causes this command to make the current line +a shell comment. +If a numeric argument causes the comment character to be removed, the line +will be executed by the shell. +.TP +.B dump\-functions +Print all of the functions and their key bindings +to the \fBreadline\fP output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an \fIinputrc\fP file. +.TP +.B dump\-variables +Print all of the settable variables and their values +to the \fBreadline\fP output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an \fIinputrc\fP file. +.TP +.B dump\-macros +Print all of the \fBreadline\fP key sequences bound to macros and the +strings they output +to the \fBreadline\fP output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an \fIinputrc\fP file. +.TP +.B execute\-named\-command (M-x) +Read a bindable \fBreadline\fP command name from the input and execute the +function to which it's bound, as if the key sequence to which it was +bound appeared in the input. +If this function is supplied with a numeric argument, it passes that +argument to the function it executes. +.TP +.B emacs\-editing\-mode (C\-e) +When in +.B vi +command mode, this switches \fBreadline\fP to +.B emacs +editing mode. +.TP +.B vi\-editing\-mode (M\-C\-j) +When in +.B emacs +editing mode, this switches to +.B vi +editing mode. +.PD +.SH DEFAULT KEY BINDINGS +.LP +The following is a list of the default emacs and vi bindings. +Characters with the eighth bit set are written as M\-, and +are referred to as +.I metafied +characters. +The printable ASCII characters not mentioned in the list of emacs +standard bindings are bound to the +.B self\-insert +function, which just inserts the given character into the input line. +In vi insertion mode, all characters not specifically mentioned are +bound to +.BR self\-insert . +Characters assigned to signal generation by +.IR stty (1) +or the terminal driver, such as C-Z or C-C, +retain that function. +Upper and lower case metafied characters are bound to the same function in +the emacs mode meta keymap. +The remaining characters are unbound, which causes \fBreadline\fP +to ring the bell (subject to the setting of the +.B bell\-style +variable). +.SS Emacs Mode +.RS +.6i +.nf +.ta 2.5i +.sp +Emacs Standard bindings +.PP +"C-@" set-mark +"C-A" beginning-of-line +"C-B" backward-char +"C-D" delete-char +"C-E" end-of-line +"C-F" forward-char +"C-G" abort +"C-H" backward-delete-char +"C-I" complete +"C-J" accept-line +"C-K" kill-line +"C-L" clear-screen +"C-M" accept-line +"C-N" next-history +"C-P" previous-history +"C-Q" quoted-insert +"C-R" reverse-search-history +"C-S" forward-search-history +"C-T" transpose-chars +"C-U" unix-line-discard +"C-V" quoted-insert +"C-W" unix-word-rubout +"C-Y" yank +"C-]" character-search +"C-_" undo +"\^ " to "/" self-insert +"0" to "9" self-insert +":" to "\*~" self-insert +"C-?" backward-delete-char +.PP +Emacs Meta bindings +.PP +"M-C-G" abort +"M-C-H" backward-kill-word +"M-C-I" tab-insert +"M-C-J" vi-editing-mode +"M-C-L" clear-display +"M-C-M" vi-editing-mode +"M-C-R" revert-line +"M-C-Y" yank-nth-arg +"M-C-[" complete +"M-C-]" character-search-backward +"M-space" set-mark +"M-#" insert-comment +"M-&" tilde-expand +"M-*" insert-completions +"M--" digit-argument +"M-." yank-last-arg +"M-0" digit-argument +"M-1" digit-argument +"M-2" digit-argument +"M-3" digit-argument +"M-4" digit-argument +"M-5" digit-argument +"M-6" digit-argument +"M-7" digit-argument +"M-8" digit-argument +"M-9" digit-argument +"M-<" beginning-of-history +"M-=" possible-completions +"M->" end-of-history +"M-?" possible-completions +"M-B" backward-word +"M-C" capitalize-word +"M-D" kill-word +"M-F" forward-word +"M-L" downcase-word +"M-N" non-incremental-forward-search-history +"M-P" non-incremental-reverse-search-history +"M-R" revert-line +"M-T" transpose-words +"M-U" upcase-word +"M-X" execute-named-command +"M-Y" yank-pop +"M-\e" delete-horizontal-space +"M-\*~" tilde-expand +"M-C-?" backward-kill-word +"M-_" yank-last-arg +.PP +Emacs Control-X bindings +.PP +"C-XC-G" abort +"C-XC-R" re-read-init-file +"C-XC-U" undo +"C-XC-X" exchange-point-and-mark +"C-X(" start-kbd-macro +"C-X)" end-kbd-macro +"C-XE" call-last-kbd-macro +"C-XC-?" backward-kill-line +.RE +.SS VI Mode bindings +.RS +.6i +.nf +.ta 2.5i +.PP +VI Insert Mode functions +.PP +"C-D" vi-eof-maybe +"C-H" backward-delete-char +"C-I" complete +"C-J" accept-line +"C-M" accept-line +"C-N" menu-complete +"C-P" menu-complete-backward +"C-R" reverse-search-history +"C-S" forward-search-history +"C-T" transpose-chars +"C-U" unix-line-discard +"C-V" quoted-insert +"C-W" vi-unix-word-rubout +"C-Y" yank +"C-[" vi-movement-mode +"C-_" vi-undo +"\^ " to "\*~" self-insert +"C-?" backward-delete-char +.PP +VI Command Mode functions +.PP +"C-D" vi-eof-maybe +"C-E" emacs-editing-mode +"C-G" abort +"C-H" backward-char +"C-J" accept-line +"C-K" kill-line +"C-L" clear-screen +"C-M" accept-line +"C-N" next-history +"C-P" previous-history +"C-Q" quoted-insert +"C-R" reverse-search-history +"C-S" forward-search-history +"C-T" transpose-chars +"C-U" unix-line-discard +"C-V" quoted-insert +"C-W" vi-unix-word-rubout +"C-Y" yank +"C-_" vi-undo +"\^ " forward-char +"#" insert-comment +"$" end-of-line +"%" vi-match +"&" vi-tilde-expand +"*" vi-complete +"+" next-history +"," vi-char-search +"-" previous-history +"." vi-redo +"/" vi-search +"0" beginning-of-line +"1" to "9" vi-arg-digit +";" vi-char-search +"=" vi-complete +"?" vi-search +"A" vi-append-eol +"B" vi-prev-word +"C" vi-change-to +"D" vi-delete-to +"E" vi-end-word +"F" vi-char-search +"G" vi-fetch-history +"I" vi-insert-beg +"N" vi-search-again +"P" vi-put +"R" vi-replace +"S" vi-subst +"T" vi-char-search +"U" revert-line +"W" vi-next-word +"X" vi-rubout +"Y" vi-yank-to +"\e" vi-complete +"\*^" vi-first-print +"_" vi-yank-arg +"`" vi-goto-mark +"a" vi-append-mode +"b" vi-prev-word +"c" vi-change-to +"d" vi-delete-to +"e" vi-end-word +"f" vi-char-search +"h" backward-char +"i" vi-insertion-mode +"j" next-history +"k" previous-history +"l" forward-char +"m" vi-set-mark +"n" vi-search-again +"p" vi-put +"r" vi-change-char +"s" vi-subst +"t" vi-char-search +"u" vi-undo +"w" vi-next-word +"x" vi-delete +"y" vi-yank-to +"|" vi-column +"\*~" vi-change-case +.RE +.SH "SEE ALSO" +.PD 0 +.TP +\fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey +.TP +\fIThe Gnu History Library\fP, Brian Fox and Chet Ramey +.TP +\fIbash\fP(1) +.PD +.SH FILES +.PD 0 +.TP +.FN \*~/.inputrc +Individual \fBreadline\fP initialization file +.PD +.SH AUTHORS +Brian Fox, Free Software Foundation +.br +bfox@gnu.org +.PP +Chet Ramey, Case Western Reserve University +.br +chet.ramey@case.edu +.SH BUG REPORTS +If you find a bug in +.BR readline , +you should report it. But first, you should +make sure that it really is a bug, and that it appears in the latest +version of the +.B readline +library that you have. +.PP +Once you have determined that a bug actually exists, mail a +bug report to \fIbug\-readline\fP@\fIgnu.org\fP. +If you have a fix, you are welcome to mail that +as well! Suggestions and +.Q philosophical +bug reports may be mailed +to \fPbug-readline\fP@\fIgnu.org\fP or posted to the Usenet +newsgroup +.BR gnu.bash.bug . +.PP +Comments and bug reports concerning +this manual page should be directed to +.IR chet.ramey@case.edu . +.SH BUGS +It's too big and too slow. diff --git a/miniconda3/share/man/man3/textdomain.3 b/miniconda3/share/man/man3/textdomain.3 new file mode 100644 index 0000000000000000000000000000000000000000..54913874ef0a5988cfbe36704a3012925a91d9e7 --- /dev/null +++ b/miniconda3/share/man/man3/textdomain.3 @@ -0,0 +1,57 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH TEXTDOMAIN 3 "May 2001" "GNU gettext 0.25.1" +.SH NAME +textdomain \- set domain for future gettext() calls +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * textdomain (const char * " domainname ); +.fi +.SH DESCRIPTION +The \fBtextdomain\fP function sets or retrieves the current message domain. +.PP +A message domain is a set of translatable \fImsgid\fP messages. Usually, +every software package has its own message domain. The domain name is used +to determine the message catalog where a translation is looked up; it must +be a non-empty string. +.PP +The current message domain is used by the \fBgettext\fP, \fBngettext\fP +functions, and by the \fBdgettext\fP, \fBdcgettext\fP, \fBdngettext\fP and +\fBdcngettext\fP functions when called with a NULL domainname argument. +.PP +If \fIdomainname\fP is not NULL, the current message domain is set to +\fIdomainname\fP. The string the function stores internally is a copy of the +\fIdomainname\fP argument. +.PP +If \fIdomainname\fP is NULL, the function returns the current message domain. +.SH "RETURN VALUE" +If successful, the \fBtextdomain\fP function returns the current message +domain, after possibly changing it. The resulting string is valid until the +next \fBtextdomain\fP call and must not be modified or freed. If a memory +allocation failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and returns +NULL. +.SH ERRORS +The following error can occur, among others: +.TP +.B ENOMEM +Not enough memory available. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.SH "SEE ALSO" +.BR gettext (3), +.BR ngettext (3), +.BR bindtextdomain (3), +.BR bind_textdomain_codeset (3) diff --git a/miniconda3/share/man/man3/types.h.3 b/miniconda3/share/man/man3/types.h.3 new file mode 100644 index 0000000000000000000000000000000000000000..3d8a98cbc4260d1140fcf65eb110089188e9d8ae --- /dev/null +++ b/miniconda3/share/man/man3/types.h.3 @@ -0,0 +1,117 @@ +.TH "types.h" 3 "August 2021" "Brotli" \" -*- nroff -*- +.ad l +.nh +.SH NAME +types.h \- Common types used in decoder and encoder API\&. + +.SH SYNOPSIS +.br +.PP +.SS "Macros" + +.in +1c +.ti -1c +.RI "#define \fBBROTLI_BOOL\fP int" +.br +.RI "\fIA portable \fCbool\fP replacement\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_FALSE\fP 0" +.br +.RI "\fIPortable \fCfalse\fP replacement\&. \fP" +.ti -1c +.RI "#define \fBBROTLI_TRUE\fP 1" +.br +.RI "\fIPortable \fCtrue\fP replacement\&. \fP" +.ti -1c +.RI "#define \fBTO_BROTLI_BOOL\fP(X) (!!(X) ? \fBBROTLI_TRUE\fP : \fBBROTLI_FALSE\fP)" +.br +.RI "\fI\fCbool\fP to \fBBROTLI_BOOL\fP conversion macros\&. \fP" +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void *(* \fBbrotli_alloc_func\fP) (void *opaque, size_t size)" +.br +.RI "\fIAllocating function pointer type\&. \fP" +.ti -1c +.RI "typedef void(* \fBbrotli_free_func\fP) (void *opaque, void *address)" +.br +.RI "\fIDeallocating function pointer type\&. \fP" +.in -1c +.SH "Detailed Description" +.PP +Common types used in decoder and encoder API\&. + + +.SH "Macro Definition Documentation" +.PP +.SS "#define BROTLI_BOOL int" + +.PP +A portable \fCbool\fP replacement\&. \fBBROTLI_BOOL\fP is a 'documentation' type: actually it is \fCint\fP, but in API it denotes a type, whose only values are \fBBROTLI_TRUE\fP and \fBBROTLI_FALSE\fP\&. +.PP +\fBBROTLI_BOOL\fP values passed to Brotli should either be \fBBROTLI_TRUE\fP or \fBBROTLI_FALSE\fP, or be a result of \fBTO_BROTLI_BOOL\fP macros\&. +.PP +\fBBROTLI_BOOL\fP values returned by Brotli should not be tested for equality with \fCtrue\fP, \fCfalse\fP, \fBBROTLI_TRUE\fP, \fBBROTLI_FALSE\fP, but rather should be evaluated, for example: +.PP +.nf +if (SomeBrotliFunction(encoder, BROTLI_TRUE) && + !OtherBrotliFunction(decoder, BROTLI_FALSE)) { + bool x = !!YetAnotherBrotliFunction(encoder, TO_BROLTI_BOOL(2 * 2 == 4)); + DoSomething(x); +} + +.fi +.PP + +.SS "#define BROTLI_FALSE 0" + +.PP +Portable \fCfalse\fP replacement\&. +.SS "#define BROTLI_TRUE 1" + +.PP +Portable \fCtrue\fP replacement\&. +.SS "#define TO_BROTLI_BOOL(X) (!!(X) ? \fBBROTLI_TRUE\fP : \fBBROTLI_FALSE\fP)" + +.PP +\fCbool\fP to \fBBROTLI_BOOL\fP conversion macros\&. +.SH "Typedef Documentation" +.PP +.SS "typedef void*(* brotli_alloc_func) (void *opaque, size_t size)" + +.PP +Allocating function pointer type\&. +.PP +\fBParameters:\fP +.RS 4 +\fIopaque\fP custom memory manager handle provided by client +.br +\fIsize\fP requested memory region size; can not be \fC0\fP +.RE +.PP +\fBReturns:\fP +.RS 4 +\fC0\fP in the case of failure +.PP +a valid pointer to a memory region of at least \fCsize\fP bytes long otherwise +.RE +.PP + +.SS "typedef void(* brotli_free_func) (void *opaque, void *address)" + +.PP +Deallocating function pointer type\&. This function \fBSHOULD\fP do nothing if \fCaddress\fP is \fC0\fP\&. +.PP +\fBParameters:\fP +.RS 4 +\fIopaque\fP custom memory manager handle provided by client +.br +\fIaddress\fP memory region pointer returned by \fBbrotli_alloc_func\fP, or \fC0\fP +.RE +.PP + +.SH "Author" +.PP +Generated automatically by Doxygen for Brotli from the source code\&. diff --git a/miniconda3/share/man/man5/cpio.5 b/miniconda3/share/man/man5/cpio.5 new file mode 100644 index 0000000000000000000000000000000000000000..21c30d78d3c531aaab9b1105e45a6594556a59ef --- /dev/null +++ b/miniconda3/share/man/man5/cpio.5 @@ -0,0 +1,389 @@ +.\" Copyright (c) 2007 Tim Kientzle +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 23, 2011 +.Dt CPIO 5 +.Os +.Sh NAME +.Nm cpio +.Nd format of cpio archive files +.Sh DESCRIPTION +The +.Nm +archive format collects any number of files, directories, and other +file system objects (symbolic links, device nodes, etc.) into a single +stream of bytes. +.Ss General Format +Each file system object in a +.Nm +archive comprises a header record with basic numeric metadata +followed by the full pathname of the entry and the file data. +The header record stores a series of integer values that generally +follow the fields in +.Va struct stat . +(See +.Xr stat 2 +for details.) +The variants differ primarily in how they store those integers +(binary, octal, or hexadecimal). +The header is followed by the pathname of the +entry (the length of the pathname is stored in the header) +and any file data. +The end of the archive is indicated by a special record with +the pathname +.Dq TRAILER!!! . +.Ss PWB format +The PWB binary +.Nm +format is the original format, when cpio was introduced as part of the +Programmer's Work Bench system, a variant of 6th Edition UNIX. It +stores numbers as 2-byte and 4-byte binary values. +Each entry begins with a header in the following format: +.Pp +.Bd -literal -offset indent +struct header_pwb_cpio { + short h_magic; + short h_dev; + short h_ino; + short h_mode; + short h_uid; + short h_gid; + short h_nlink; + short h_majmin; + long h_mtime; + short h_namesize; + long h_filesize; +}; +.Ed +.Pp +The +.Va short +fields here are 16-bit integer values, while the +.Va long +fields are 32 bit integers. Since PWB UNIX, like the 6th Edition UNIX +it was based on, only ran on PDP-11 computers, they +are in PDP-endian format, which has little-endian shorts, and +big-endian longs. That is, the long integer whose hexadecimal +representation is 0x12345678 would be stored in four successive bytes +as 0x34, 0x12, 0x78, 0x56. +The fields are as follows: +.Bl -tag -width indent +.It Va h_magic +The integer value octal 070707. +.It Va h_dev , Va h_ino +The device and inode numbers from the disk. +These are used by programs that read +.Nm +archives to determine when two entries refer to the same file. +Programs that synthesize +.Nm +archives should be careful to set these to distinct values for each entry. +.It Va h_mode +The mode specifies both the regular permissions and the file type, and +it also holds a couple of bits that are irrelevant to the cpio format, +because the field is actually a raw copy of the mode field in the inode +representing the file. These are the IALLOC flag, which shows that +the inode entry is in use, and the ILARG flag, which shows that the +file it represents is large enough to have indirect blocks pointers in +the inode. +The mode is decoded as follows: +.Pp +.Bl -tag -width "MMMMMMM" -compact +.It 0100000 +IALLOC flag - irrelevant to cpio. +.It 0060000 +This masks the file type bits. +.It 0040000 +File type value for directories. +.It 0020000 +File type value for character special devices. +.It 0060000 +File type value for block special devices. +.It 0010000 +ILARG flag - irrelevant to cpio. +.It 0004000 +SUID bit. +.It 0002000 +SGID bit. +.It 0001000 +Sticky bit. +.It 0000777 +The lower 9 bits specify read/write/execute permissions +for world, group, and user following standard POSIX conventions. +.El +.It Va h_uid , Va h_gid +The numeric user id and group id of the owner. +.It Va h_nlink +The number of links to this file. +Directories always have a value of at least two here. +Note that hardlinked files include file data with every copy in the archive. +.It Va h_majmin +For block special and character special entries, +this field contains the associated device number, with the major +number in the high byte, and the minor number in the low byte. +For all other entry types, it should be set to zero by writers +and ignored by readers. +.It Va h_mtime +Modification time of the file, indicated as the number +of seconds since the start of the epoch, +00:00:00 UTC January 1, 1970. +.It Va h_namesize +The number of bytes in the pathname that follows the header. +This count includes the trailing NUL byte. +.It Va h_filesize +The size of the file. Note that this archive format is limited to 16 +megabyte file sizes, because PWB UNIX, like 6th Edition, only used +an unsigned 24 bit integer for the file size internally. +.El +.Pp +The pathname immediately follows the fixed header. +If +.Cm h_namesize +is odd, an additional NUL byte is added after the pathname. +The file data is then appended, again with an additional NUL +appended if needed to get the next header at an even offset. +.Pp +Hardlinked files are not given special treatment; +the full file contents are included with each copy of the +file. +.Ss New Binary Format +The new binary +.Nm +format showed up when cpio was adopted into late 7th Edition UNIX. +It is exactly like the PWB binary format, described above, except for +three changes: +.Pp +First, UNIX now ran on more than one hardware type, so the endianness +of 16 bit integers must be determined by observing the magic number at +the start of the header. The 32 bit integers are still always stored +with the most significant word first, though, so each of those two, in +the struct shown above, was stored as an array of two 16 bit integers, +in the traditional order. Those 16 bit integers, like all the others +in the struct, were accessed using a macro that byte swapped them if +necessary. +.Pp +Next, 7th Edition had more file types to store, and the IALLOC and ILARG +flag bits were re-purposed to accommodate these. The revised use of the +various bits is as follows: +.Pp +.Bl -tag -width "MMMMMMM" -compact +.It 0170000 +This masks the file type bits. +.It 0140000 +File type value for sockets. +.It 0120000 +File type value for symbolic links. +For symbolic links, the link body is stored as file data. +.It 0100000 +File type value for regular files. +.It 0060000 +File type value for block special devices. +.It 0040000 +File type value for directories. +.It 0020000 +File type value for character special devices. +.It 0010000 +File type value for named pipes or FIFOs. +.It 0004000 +SUID bit. +.It 0002000 +SGID bit. +.It 0001000 +Sticky bit. +.It 0000777 +The lower 9 bits specify read/write/execute permissions +for world, group, and user following standard POSIX conventions. +.El +.Pp +Finally, the file size field now represents a signed 32 bit integer in +the underlying file system, so the maximum file size has increased to +2 gigabytes. +.Pp +Note that there is no obvious way to tell which of the two binary +formats an archive uses, other than to see which one makes more +sense. The typical error scenario is that a PWB format archive +unpacked as if it were in the new format will create named sockets +instead of directories, and then fail to unpack files that should +go in those directories. Running +.Va bsdcpio -itv +on an unknown archive will make it obvious which it is: if it's +PWB format, directories will be listed with an 's' instead of +a 'd' as the first character of the mode string, and the larger +files will have a '?' in that position. +.Ss Portable ASCII Format +.St -susv2 +standardized an ASCII variant that is portable across all +platforms. +It is commonly known as the +.Dq old character +format or as the +.Dq odc +format. +It stores the same numeric fields as the old binary format, but +represents them as 6-character or 11-character octal values. +.Pp +.Bd -literal -offset indent +struct cpio_odc_header { + char c_magic[6]; + char c_dev[6]; + char c_ino[6]; + char c_mode[6]; + char c_uid[6]; + char c_gid[6]; + char c_nlink[6]; + char c_rdev[6]; + char c_mtime[11]; + char c_namesize[6]; + char c_filesize[11]; +}; +.Ed +.Pp +The fields are identical to those in the new binary format. +The name and file body follow the fixed header. +Unlike the binary formats, there is no additional padding +after the pathname or file contents. +If the files being archived are themselves entirely ASCII, then +the resulting archive will be entirely ASCII, except for the +NUL byte that terminates the name field. +.Ss New ASCII Format +The "new" ASCII format uses 8-byte hexadecimal fields for +all numbers and separates device numbers into separate fields +for major and minor numbers. +.Pp +.Bd -literal -offset indent +struct cpio_newc_header { + char c_magic[6]; + char c_ino[8]; + char c_mode[8]; + char c_uid[8]; + char c_gid[8]; + char c_nlink[8]; + char c_mtime[8]; + char c_filesize[8]; + char c_devmajor[8]; + char c_devminor[8]; + char c_rdevmajor[8]; + char c_rdevminor[8]; + char c_namesize[8]; + char c_check[8]; +}; +.Ed +.Pp +Except as specified below, the fields here match those specified +for the new binary format above. +.Bl -tag -width indent +.It Va magic +The string +.Dq 070701 . +.It Va check +This field is always set to zero by writers and ignored by readers. +See the next section for more details. +.El +.Pp +The pathname is followed by NUL bytes so that the total size +of the fixed header plus pathname is a multiple of four. +Likewise, the file data is padded to a multiple of four bytes. +Note that this format supports only 4 gigabyte files (unlike the +older ASCII format, which supports 8 gigabyte files). +.Pp +In this format, hardlinked files are handled by setting the +filesize to zero for each entry except the first one that +appears in the archive. +.Ss New CRC Format +The CRC format is identical to the new ASCII format described +in the previous section except that the magic field is set +to +.Dq 070702 +and the +.Va check +field is set to the sum of all bytes in the file data. +This sum is computed treating all bytes as unsigned values +and using unsigned arithmetic. +Only the least-significant 32 bits of the sum are stored. +.Ss HP variants +The +.Nm cpio +implementation distributed with HPUX used XXXX but stored +device numbers differently XXX. +.Ss Other Extensions and Variants +Sun Solaris uses additional file types to store extended file +data, including ACLs and extended attributes, as special +entries in cpio archives. +.Pp +XXX Others? XXX +.Sh SEE ALSO +.Xr cpio 1 , +.Xr tar 5 +.Sh STANDARDS +The +.Nm cpio +utility is no longer a part of POSIX or the Single Unix Standard. +It last appeared in +.St -susv2 . +It has been supplanted in subsequent standards by +.Xr pax 1 . +The portable ASCII format is currently part of the specification for the +.Xr pax 1 +utility. +.Sh HISTORY +The original cpio utility was written by Dick Haight +while working in AT&T's Unix Support Group. +It appeared in 1977 as part of PWB/UNIX 1.0, the +.Dq Programmer's Work Bench +derived from +.At v6 +that was used internally at AT&T. +Both the new binary and old character formats were in use +by 1980, according to the System III source released +by SCO under their +.Dq Ancient Unix +license. +The character format was adopted as part of +.St -p1003.1-88 . +XXX when did "newc" appear? Who invented it? When did HP come out with their variant? When did Sun introduce ACLs and extended attributes? XXX +.Sh BUGS +The +.Dq CRC +format is mis-named, as it uses a simple checksum and +not a cyclic redundancy check. +.Pp +The binary formats are limited to 16 bits for user id, group id, +device, and inode numbers. They are limited to 16 megabyte and 2 +gigabyte file sizes for the older and newer variants, respectively. +.Pp +The old ASCII format is limited to 18 bits for +the user id, group id, device, and inode numbers. +It is limited to 8 gigabyte file sizes. +.Pp +The new ASCII format is limited to 4 gigabyte file sizes. +.Pp +None of the cpio formats store user or group names, +which are essential when moving files between systems with +dissimilar user or group numbering. +.Pp +Especially when writing older cpio variants, it may be necessary +to map actual device/inode values to synthesized values that +fit the available fields. +With very large filesystems, this may be necessary even for +the newer formats. diff --git a/miniconda3/share/man/man5/libarchive-formats.5 b/miniconda3/share/man/man5/libarchive-formats.5 new file mode 100644 index 0000000000000000000000000000000000000000..1b057b4da0d87cbea7973fb17e96550b8ffc709b --- /dev/null +++ b/miniconda3/share/man/man5/libarchive-formats.5 @@ -0,0 +1,478 @@ +.\" Copyright (c) 2003-2009 Tim Kientzle +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 27, 2016 +.Dt LIBARCHIVE-FORMATS 5 +.Os +.Sh NAME +.Nm libarchive-formats +.Nd archive formats supported by the libarchive library +.Sh DESCRIPTION +The +.Xr libarchive 3 +library reads and writes a variety of streaming archive formats. +Generally speaking, all of these archive formats consist of a series of +.Dq entries . +Each entry stores a single file system object, such as a file, directory, +or symbolic link. +.Pp +The following provides a brief description of each format supported +by libarchive, with some information about recognized extensions or +limitations of the current library support. +Note that just because a format is supported by libarchive does not +imply that a program that uses libarchive will support that format. +Applications that use libarchive specify which formats they wish +to support, though many programs do use libarchive convenience +functions to enable all supported formats. +.Ss Tar Formats +The +.Xr libarchive 3 +library can read most tar archives. +It can write POSIX-standard +.Dq ustar +and +.Dq pax interchange +formats as well as v7 tar format and a subset of the legacy GNU tar format. +.Pp +All tar formats store each entry in one or more 512-byte records. +The first record is used for file metadata, including filename, +timestamp, and mode information, and the file data is stored in +subsequent records. +Later variants have extended this by either appropriating undefined +areas of the header record, extending the header to multiple records, +or by storing special entries that modify the interpretation of +subsequent entries. +.Bl -tag -width indent +.It Cm gnutar +The +.Xr libarchive 3 +library can read most GNU-format tar archives. +It currently supports the most popular GNU extensions, including +modern long filename and linkname support, as well as atime and ctime data. +The libarchive library does not support multi-volume +archives, nor the old GNU long filename format. +It can read GNU sparse file entries, including the new POSIX-based +formats. +.Pp +The +.Xr libarchive 3 +library can write GNU tar format, including long filename +and linkname support, as well as atime and ctime data. +.It Cm pax +The +.Xr libarchive 3 +library can read and write POSIX-compliant pax interchange format +archives. +Pax interchange format archives are an extension of the older ustar +format that adds a separate entry with additional attributes stored +as key/value pairs immediately before each regular entry. +The presence of these additional entries is the only difference between +pax interchange format and the older ustar format. +The extended attributes are of unlimited length and are stored +as UTF-8 Unicode strings. +Keywords defined in the standard are in all lowercase; vendors are allowed +to define custom keys by preceding them with the vendor name in all uppercase. +When writing pax archives, libarchive uses many of the SCHILY keys +defined by Joerg Schilling's +.Dq star +archiver and a few LIBARCHIVE keys. +The libarchive library can read most of the SCHILY keys +and most of the GNU keys introduced by GNU tar. +It silently ignores any keywords that it does not understand. +.Pp +The pax interchange format converts filenames to Unicode +and stores them using the UTF-8 encoding. +Prior to libarchive 3.0, libarchive erroneously assumed +that the system wide-character routines natively supported +Unicode. +This caused it to mis-handle non-ASCII filenames on systems +that did not satisfy this assumption. +.It Cm restricted pax +The libarchive library can also write pax archives in which it +attempts to suppress the extended attributes entry whenever +possible. +The result will be identical to a ustar archive unless the +extended attributes entry is required to store a long file +name, long linkname, extended ACL, file flags, or if any of the standard +ustar data (user name, group name, UID, GID, etc) cannot be fully +represented in the ustar header. +In all cases, the result can be dearchived by any program that +can read POSIX-compliant pax interchange format archives. +Programs that correctly read ustar format (see below) will also be +able to read this format; any extended attributes will be extracted as +separate files stored in +.Pa PaxHeader +directories. +.It Cm ustar +The libarchive library can both read and write this format. +This format has the following limitations: +.Bl -bullet -compact +.It +Device major and minor numbers are limited to 21 bits. +Nodes with larger numbers will not be added to the archive. +.It +Path names in the archive are limited to 255 bytes. +(Shorter if there is no / character in exactly the right place.) +.It +Symbolic links and hard links are stored in the archive with +the name of the referenced file. +This name is limited to 100 bytes. +.It +Extended attributes, file flags, and other extended +security information cannot be stored. +.It +Archive entries are limited to 8 gigabytes in size. +.El +Note that the pax interchange format has none of these restrictions. +The ustar format is old and widely supported. +It is recommended when compatibility is the primary concern. +.It Cm v7 +The libarchive library can read and write the legacy v7 tar format. +This format has the following limitations: +.Bl -bullet -compact +.It +Only regular files, directories, and symbolic links can be archived. +Block and character device nodes, FIFOs, and sockets cannot be archived. +.It +Path names in the archive are limited to 100 bytes. +.It +Symbolic links and hard links are stored in the archive with +the name of the referenced file. +This name is limited to 100 bytes. +.It +User and group information are stored as numeric IDs; there +is no provision for storing user or group names. +.It +Extended attributes, file flags, and other extended +security information cannot be stored. +.It +Archive entries are limited to 8 gigabytes in size. +.El +Generally, users should prefer the ustar format for portability +as the v7 tar format is both less useful and less portable. +.El +.Pp +The libarchive library also reads a variety of commonly-used extensions to +the basic tar format. +These extensions are recognized automatically whenever they appear. +.Bl -tag -width indent +.It Numeric extensions. +The POSIX standards require fixed-length numeric fields to be written with +some character position reserved for terminators. +Libarchive allows these fields to be written without terminator characters. +This extends the allowable range; in particular, ustar archives with this +extension can support entries up to 64 gigabytes in size. +Libarchive also recognizes base-256 values in most numeric fields. +This essentially removes all limitations on file size, modification time, +and device numbers. +.It Solaris extensions +Libarchive recognizes ACL and extended attribute records written +by Solaris tar. +.El +.Pp +The first tar program appeared in Seventh Edition Unix in 1979. +The first official standard for the tar file format was the +.Dq ustar +(Unix Standard Tar) format defined by POSIX in 1988. +POSIX.1-2001 extended the ustar format to create the +.Dq pax interchange +format. +.Ss Cpio Formats +The libarchive library can read and write a number of common cpio +variants. A cpio archive stores each entry as a fixed-size header +followed by a variable-length filename and variable-length data. +Unlike the tar format, the cpio format does only minimal padding of +the header or file data. There are several cpio variants, which +differ primarily in how they store the initial header: some store the +values as octal or hexadecimal numbers in ASCII, others as binary +values of varying byte order and length. +.Bl -tag -width indent +.It Cm binary +The libarchive library transparently reads both big-endian and +little-endian variants of the the two binary cpio formats; the +original one from PWB/UNIX, and the later, more widely used, variant. +This format used 32-bit binary values for file size and mtime, and +16-bit binary values for the other fields. The formats support only +the file types present in UNIX at the time of their creation. File +sizes are limited to 24 bits in the PWB format, because of the limits +of the file system, and to 31 bits in the newer binary format, where +signed 32 bit longs were used. +.It Cm odc +This is the POSIX standardized format, which is officially known as the +.Dq cpio interchange format +or the +.Dq octet-oriented cpio archive format +and sometimes unofficially referred to as the +.Dq old character format . +This format stores the header contents as octal values in ASCII. +It is standard, portable, and immune from byte-order confusion. +File sizes and mtime are limited to 33 bits (8GB file size), +other fields are limited to 18 bits. +.It Cm SVR4/newc +The libarchive library can read both CRC and non-CRC variants of +this format. +The SVR4 format uses eight-digit hexadecimal values for +all header fields. +This limits file size to 4GB, and also limits the mtime and +other fields to 32 bits. +The SVR4 format can optionally include a CRC of the file +contents, although libarchive does not currently verify this CRC. +.El +.Pp +Cpio first appeared in PWB/UNIX 1.0, which was released within +AT&T in 1977. +PWB/UNIX 1.0 formed the basis of System III Unix, released outside +of AT&T in 1981. +This makes cpio older than tar, although cpio was not included +in Version 7 AT&T Unix. +As a result, the tar command became much better known in universities +and research groups that used Version 7. +The combination of the +.Nm find +and +.Nm cpio +utilities provided very precise control over file selection. +Unfortunately, the format has many limitations that make it unsuitable +for widespread use. +Only the POSIX format permits files over 4GB, and its 18-bit +limit for most other fields makes it unsuitable for modern systems. +In addition, cpio formats only store numeric UID/GID values (not +usernames and group names), which can make it very difficult to correctly +transfer archives across systems with dissimilar user numbering. +.Ss Shar Formats +A +.Dq shell archive +is a shell script that, when executed on a POSIX-compliant +system, will recreate a collection of file system objects. +The libarchive library can write two different kinds of shar archives: +.Bl -tag -width indent +.It Cm shar +The traditional shar format uses a limited set of POSIX +commands, including +.Xr echo 1 , +.Xr mkdir 1 , +and +.Xr sed 1 . +It is suitable for portably archiving small collections of plain text files. +However, it is not generally well-suited for large archives +(many implementations of +.Xr sh 1 +have limits on the size of a script) nor should it be used with non-text files. +.It Cm shardump +This format is similar to shar but encodes files using +.Xr uuencode 1 +so that the result will be a plain text file regardless of the file contents. +It also includes additional shell commands that attempt to reproduce as +many file attributes as possible, including owner, mode, and flags. +The additional commands used to restore file attributes make +shardump archives less portable than plain shar archives. +.El +.Ss ISO9660 format +Libarchive can read and extract from files containing ISO9660-compliant +CDROM images. +In many cases, this can remove the need to burn a physical CDROM +just in order to read the files contained in an ISO9660 image. +It also avoids security and complexity issues that come with +virtual mounts and loopback devices. +Libarchive supports the most common Rockridge extensions and has partial +support for Joliet extensions. +If both extensions are present, the Joliet extensions will be +used and the Rockridge extensions will be ignored. +In particular, this can create problems with hardlinks and symlinks, +which are supported by Rockridge but not by Joliet. +.Pp +Libarchive reads ISO9660 images using a streaming strategy. +This allows it to read compressed images directly +(decompressing on the fly) and allows it to read images +directly from network sockets, pipes, and other non-seekable +data sources. +This strategy works well for optimized ISO9660 images created +by many popular programs. +Such programs collect all directory information at the beginning +of the ISO9660 image so it can be read from a physical disk +with a minimum of seeking. +However, not all ISO9660 images can be read in this fashion. +.Pp +Libarchive can also write ISO9660 images. +Such images are fully optimized with the directory information +preceding all file data. +This is done by storing all file data to a temporary file +while collecting directory information in memory. +When the image is finished, libarchive writes out the +directory structure followed by the file data. +The location used for the temporary file can be changed +by the usual environment variables. +.Ss Zip format +Libarchive can read and write zip format archives that have +uncompressed entries and entries compressed with the +.Dq deflate +, +.Dq LZMA +, +.Dq XZ +, +.Dq BZIP2 +and +.Dq ZSTD +algorithms. +Libarchive can also read, but not write, zip format archives that +have entries compressed with the +.Dq PPMd +algorithm. +Other zip compression algorithms are not supported. +The extensions supported by libarchive are Zip64, Libarchive's +extensions to better support streaming, PKZIP's traditional +ZIP encryption, Info-ZIP's Unix extra fields, extra time, and +Unicode path, as well as WinZIP's AES encryption. +It can extract jar archives, __MACOSX resource forks extension +for OS X, and self-extracting zip archives. +Libarchive can use either of two different strategies for +reading Zip archives: +a streaming strategy which is fast and can handle extremely +large archives, and a seeking strategy which can correctly +process self-extracting Zip archives and archives with +deleted members or other in-place modifications. +.Pp +The streaming reader processes Zip archives as they are read. +It can read archives of arbitrary size from tape or +network sockets, and can decode Zip archives that have +been separately compressed or encoded. +However, self-extracting Zip archives and archives with +certain types of modifications cannot be correctly +handled. +Such archives require that the reader first process the +Central Directory, which is ordinarily located +at the end of a Zip archive and is thus inaccessible +to the streaming reader. +If the program using libarchive has enabled seek support, then +libarchive will use this to processes the central directory first. +.Pp +In particular, the seeking reader must be used to +correctly handle self-extracting archives. +Such archives consist of a program followed by a regular +Zip archive. +The streaming reader cannot parse the initial program +portion, but the seeking reader starts by reading the +Central Directory from the end of the archive. +Similarly, Zip archives that have been modified in-place +can have deleted entries or other garbage data that +can only be accurately detected by first reading the +Central Directory. +.Ss Archive (library) file format +The Unix archive format (commonly created by the +.Xr ar 1 +archiver) is a general-purpose format which is +used almost exclusively for object files to be +read by the link editor +.Xr ld 1 . +The ar format has never been standardised. +There are two common variants: +the GNU format derived from SVR4, +and the BSD format, which first appeared in 4.4BSD. +The two differ primarily in their handling of filenames +longer than 15 characters: +the GNU/SVR4 variant writes a filename table at the beginning of the archive; +the BSD format stores each long filename in an extension +area adjacent to the entry. +Libarchive can read both extensions, +including archives that may include both types of long filenames. +Programs using libarchive can write GNU/SVR4 format +if they provide an entry called +.Pa // +containing a filename table to be written into the archive +before any of the entries. +Any entries whose names are not in the filename table +will be written using BSD-style long filenames. +This can cause problems for programs such as +GNU ld that do not support the BSD-style long filenames. +.Ss mtree +Libarchive can read and write files in +.Xr mtree 5 +format. +This format is not a true archive format, but rather a textual description +of a file hierarchy in which each line specifies the name of a file and +provides specific metadata about that file. +Libarchive can read all of the keywords supported by both +the NetBSD and FreeBSD versions of +.Xr mtree 8 , +although many of the keywords cannot currently be stored in an +.Tn archive_entry +object. +When writing, libarchive supports use of the +.Xr archive_write_set_options 3 +interface to specify which keywords should be included in the +output. +If libarchive was compiled with access to suitable +cryptographic libraries (such as the OpenSSL libraries), +it can compute hash entries such as +.Cm sha512 +or +.Cm md5 +from file data being written to the mtree writer. +.Pp +When reading an mtree file, libarchive will locate the corresponding +files on disk using the +.Cm contents +keyword if present or the regular filename. +If it can locate and open the file on disk, it will use that +to fill in any metadata that is missing from the mtree file +and will read the file contents and return those to the program +using libarchive. +If it cannot locate and open the file on disk, libarchive +will return an error for any attempt to read the entry +body. +.Ss 7-Zip +Libarchive can read and write 7-Zip format archives. +TODO: Need more information +.Ss CAB +Libarchive can read Microsoft Cabinet ( +.Dq CAB ) +format archives. +TODO: Need more information. +.Ss LHA +TODO: Information about libarchive's LHA support +.Ss RAR +Libarchive has limited support for reading RAR format archives. +Currently, libarchive can read RARv3 format archives +which have been either created uncompressed, or compressed using +any of the compression methods supported by the RARv3 format. +Libarchive can also read self-extracting RAR archives. +.Ss Warc +Libarchive can read and write +.Dq web archives . +TODO: Need more information +.Ss XAR +Libarchive can read and write the XAR format used by many Apple tools. +TODO: Need more information +.Sh SEE ALSO +.Xr ar 1 , +.Xr cpio 1 , +.Xr mkisofs 1 , +.Xr shar 1 , +.Xr tar 1 , +.Xr zip 1 , +.Xr zlib 3 , +.Xr cpio 5 , +.Xr mtree 5 , +.Xr tar 5 diff --git a/miniconda3/share/man/man5/mtree.5 b/miniconda3/share/man/man5/mtree.5 new file mode 100644 index 0000000000000000000000000000000000000000..5ea53613166ff7d920cc4597f26978e665c849ea --- /dev/null +++ b/miniconda3/share/man/man5/mtree.5 @@ -0,0 +1,323 @@ +.\" Copyright (c) 1989, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" From: @(#)mtree.8 8.2 (Berkeley) 12/11/93 +.\" +.Dd September 4, 2013 +.Dt MTREE 5 +.Os +.Sh NAME +.Nm mtree +.Nd format of mtree dir hierarchy files +.Sh DESCRIPTION +The +.Nm +format is a textual format that describes a collection of filesystem objects. +Such files are typically used to create or verify directory hierarchies. +.Ss General Format +An +.Nm +file consists of a series of lines, each providing information +about a single filesystem object. +Leading whitespace is always ignored. +.Pp +When encoding file or pathnames, any backslash character or +character outside of the 95 printable ASCII characters must be +encoded as a backslash followed by three +octal digits. +When reading mtree files, any appearance of a backslash +followed by three octal digits should be converted into the +corresponding character. +.Pp +Each line is interpreted independently as one of the following types: +.Bl -tag -width Cm +.It Blank +Blank lines are ignored. +.It Comment +Lines beginning with +.Cm # +are ignored. +.It Special +Lines beginning with +.Cm / +are special commands that influence +the interpretation of later lines. +.It Relative +If the first whitespace-delimited word has no +.Cm / +characters, +it is the name of a file in the current directory. +Any relative entry that describes a directory changes the +current directory. +.It dot-dot +As a special case, a relative entry with the filename +.Pa .. +changes the current directory to the parent directory. +Options on dot-dot entries are always ignored. +.It Full +If the first whitespace-delimited word has a +.Cm / +character after +the first character, it is the pathname of a file relative to the +starting directory. +There can be multiple full entries describing the same file. +.El +.Pp +Some tools that process +.Nm +files may require that multiple lines describing the same file +occur consecutively. +It is not permitted for the same file to be mentioned using +both a relative and a full file specification. +.Ss Special commands +Two special commands are currently defined: +.Bl -tag -width Cm +.It Cm /set +This command defines default values for one or more keywords. +It is followed on the same line by one or more whitespace-separated +keyword definitions. +These definitions apply to all following files that do not specify +a value for that keyword. +.It Cm /unset +This command removes any default value set by a previous +.Cm /set +command. +It is followed on the same line by one or more keywords +separated by whitespace. +.El +.Ss Keywords +After the filename, a full or relative entry consists of zero +or more whitespace-separated keyword definitions. +Each such definition consists of a key from the following +list immediately followed by an '=' sign +and a value. +Software programs reading mtree files should warn about +unrecognized keywords. +.Pp +Currently supported keywords are as follows: +.Bl -tag -width Cm +.It Cm cksum +The checksum of the file using the default algorithm specified by +the +.Xr cksum 1 +utility. +.It Cm device +The device number for +.Sy block +or +.Sy char +file types. +The value must be one of the following forms: +.Bl -tag -width 4n +.It Ar format , Ns Ar major , Ns Ar minor Ns Bo , Ns Ar subunit Bc +A device with +.Ar major , minor +and optional +.Ar subunit +fields. +Their meaning is specified by the operating's system +.Ar format . +See below for valid formats. +.It Ar number +Opaque number (as stored on the file system). +.El +.Pp +The following values for +.Ar format +are recognized: +.Sy native , +.Sy 386bsd , +.Sy 4bsd , +.Sy bsdos , +.Sy freebsd , +.Sy hpux , +.Sy isc , +.Sy linux , +.Sy netbsd , +.Sy osf1 , +.Sy sco , +.Sy solaris , +.Sy sunos , +.Sy svr3 , +.Sy svr4 , +and +.Sy ultrix . +.Pp +See +.Xr mknod 8 +for more details. +.It Cm contents +The full pathname of a file that holds the contents of this file. +.It Cm flags +The file flags as a symbolic name. +See +.Xr chflags 1 +for information on these names. +If no flags are to be set the string +.Dq none +may be used to override the current default. +.It Cm gid +The file group as a numeric value. +.It Cm gname +The file group as a symbolic name. +.It Cm ignore +Ignore any file hierarchy below this file. +.It Cm inode +The inode number. +.It Cm link +The target of the symbolic link when type=link. +.It Cm md5 +The MD5 message digest of the file. +.It Cm md5digest +A synonym for +.Cm md5 . +.It Cm mode +The current file's permissions as a numeric (octal) or symbolic +value. +.It Cm nlink +The number of hard links the file is expected to have. +.It Cm nochange +Make sure this file or directory exists but otherwise ignore all attributes. +.It Cm optional +The file is optional; do not complain about the file if it is not in +the file hierarchy. +.It Cm resdevice +The +.Dq resident +device number of the file, e.g. the ID of the device that +contains the file. +Its format is the same as the one for +.Cm device . +.It Cm ripemd160digest +The +.Tn RIPEMD160 +message digest of the file. +.It Cm rmd160 +A synonym for +.Cm ripemd160digest . +.It Cm rmd160digest +A synonym for +.Cm ripemd160digest . +.It Cm sha1 +The +.Tn FIPS +160-1 +.Pq Dq Tn SHA-1 +message digest of the file. +.It Cm sha1digest +A synonym for +.Cm sha1 . +.It Cm sha256 +The +.Tn FIPS +180-2 +.Pq Dq Tn SHA-256 +message digest of the file. +.It Cm sha256digest +A synonym for +.Cm sha256 . +.It Cm sha384 +The +.Tn FIPS +180-2 +.Pq Dq Tn SHA-384 +message digest of the file. +.It Cm sha384digest +A synonym for +.Cm sha384 . +.It Cm sha512 +The +.Tn FIPS +180-2 +.Pq Dq Tn SHA-512 +message digest of the file. +.It Cm sha512digest +A synonym for +.Cm sha512 . +.It Cm size +The size, in bytes, of the file. +.It Cm time +The last modification time of the file. +.It Cm type +The type of the file; may be set to any one of the following: +.Pp +.Bl -tag -width Cm -compact +.It Cm block +block special device +.It Cm char +character special device +.It Cm dir +directory +.It Cm fifo +fifo +.It Cm file +regular file +.It Cm link +symbolic link +.It Cm socket +socket +.El +.It Cm uid +The file owner as a numeric value. +.It Cm uname +The file owner as a symbolic name. +.El +.Sh SEE ALSO +.Xr cksum 1 , +.Xr find 1 , +.Xr mtree 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Bx 4.3 Reno . +The +.Tn MD5 +digest capability was added in +.Fx 2.1 , +in response to the widespread use of programs which can spoof +.Xr cksum 1 . +The +.Tn SHA-1 +and +.Tn RIPEMD160 +digests were added in +.Fx 4.0 , +as new attacks have demonstrated weaknesses in +.Tn MD5 . +The +.Tn SHA-256 +digest was added in +.Fx 6.0 . +Support for file flags was added in +.Fx 4.0 , +and mostly comes from +.Nx . +The +.Dq full +entry format was added by +.Nx . diff --git a/miniconda3/share/man/man5/tar.5 b/miniconda3/share/man/man5/tar.5 new file mode 100644 index 0000000000000000000000000000000000000000..725a7d68374a0b6e351c6b162edae8d6ee713228 --- /dev/null +++ b/miniconda3/share/man/man5/tar.5 @@ -0,0 +1,947 @@ +.\" Copyright (c) 2003-2009 Tim Kientzle +.\" Copyright (c) 2016 Martin Matuska +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd December 27, 2016 +.Dt TAR 5 +.Os +.Sh NAME +.Nm tar +.Nd format of tape archive files +.Sh DESCRIPTION +The +.Nm +archive format collects any number of files, directories, and other +file system objects (symbolic links, device nodes, etc.) into a single +stream of bytes. +The format was originally designed to be used with +tape drives that operate with fixed-size blocks, but is widely used as +a general packaging mechanism. +.Ss General Format +A +.Nm +archive consists of a series of 512-byte records. +Each file system object requires a header record which stores basic metadata +(pathname, owner, permissions, etc.) and zero or more records containing any +file data. +The end of the archive is indicated by two records consisting +entirely of zero bytes. +.Pp +For compatibility with tape drives that use fixed block sizes, +programs that read or write tar files always read or write a fixed +number of records with each I/O operation. +These +.Dq blocks +are always a multiple of the record size. +The maximum block size supported by early +implementations was 10240 bytes or 20 records. +This is still the default for most implementations +although block sizes of 1MiB (2048 records) or larger are +commonly used with modern high-speed tape drives. +(Note: the terms +.Dq block +and +.Dq record +here are not entirely standard; this document follows the +convention established by John Gilmore in documenting +.Nm pdtar . ) +.Ss Old-Style Archive Format +The original tar archive format has been extended many times to +include additional information that various implementors found +necessary. +This section describes the variant implemented by the tar command +included in +.At v7 , +which seems to be the earliest widely-used version of the tar program. +.Pp +The header record for an old-style +.Nm +archive consists of the following: +.Bd -literal -offset indent +struct header_old_tar { + char name[100]; + char mode[8]; + char uid[8]; + char gid[8]; + char size[12]; + char mtime[12]; + char checksum[8]; + char linkflag[1]; + char linkname[100]; + char pad[255]; +}; +.Ed +All unused bytes in the header record are filled with nulls. +.Bl -tag -width indent +.It Va name +Pathname, stored as a null-terminated string. +Early tar implementations only stored regular files (including +hardlinks to those files). +One common early convention used a trailing "/" character to indicate +a directory name, allowing directory permissions and owner information +to be archived and restored. +.It Va mode +File mode, stored as an octal number in ASCII. +.It Va uid , Va gid +User id and group id of owner, as octal numbers in ASCII. +.It Va size +Size of file, as octal number in ASCII. +For regular files only, this indicates the amount of data +that follows the header. +In particular, this field was ignored by early tar implementations +when extracting hardlinks. +Modern writers should always store a zero length for hardlink entries. +.It Va mtime +Modification time of file, as an octal number in ASCII. +This indicates the number of seconds since the start of the epoch, +00:00:00 UTC January 1, 1970. +Note that negative values should be avoided +here, as they are handled inconsistently. +.It Va checksum +Header checksum, stored as an octal number in ASCII. +To compute the checksum, set the checksum field to all spaces, +then sum all bytes in the header using unsigned arithmetic. +This field should be stored as six octal digits followed by a null and a space +character. +Note that many early implementations of tar used signed arithmetic +for the checksum field, which can cause interoperability problems +when transferring archives between systems. +Modern robust readers compute the checksum both ways and accept the +header if either computation matches. +.It Va linkflag , Va linkname +In order to preserve hardlinks and conserve tape, a file +with multiple links is only written to the archive the first +time it is encountered. +The next time it is encountered, the +.Va linkflag +is set to an ASCII +.Sq 1 +and the +.Va linkname +field holds the first name under which this file appears. +(Note that regular files have a null value in the +.Va linkflag +field.) +.El +.Pp +Early tar implementations varied in how they terminated these fields. +The tar command in +.At v7 +used the following conventions (this is also documented in early BSD manpages): +the pathname must be null-terminated; +the mode, uid, and gid fields must end in a space and a null byte; +the size and mtime fields must end in a space; +the checksum is terminated by a null and a space. +Early implementations filled the numeric fields with leading spaces. +This seems to have been common practice until the +.St -p1003.1-88 +standard was released. +For best portability, modern implementations should fill the numeric +fields with leading zeros. +.Ss Pre-POSIX Archives +An early draft of +.St -p1003.1-88 +served as the basis for John Gilmore's +.Nm pdtar +program and many system implementations from the late 1980s +and early 1990s. +These archives generally follow the POSIX ustar +format described below with the following variations: +.Bl -bullet -compact -width indent +.It +The magic value consists of the five characters +.Dq ustar +followed by a space. +The version field contains a space character followed by a null. +.It +The numeric fields are generally filled with leading spaces +(not leading zeros as recommended in the final standard). +.It +The prefix field is often not used, limiting pathnames to +the 100 characters of old-style archives. +.El +.Ss POSIX ustar Archives +.St -p1003.1-88 +defined a standard tar file format to be read and written +by compliant implementations of +.Xr tar 1 . +This format is often called the +.Dq ustar +format, after the magic value used +in the header. +(The name is an acronym for +.Dq Unix Standard TAR . ) +It extends the historic format with new fields: +.Bd -literal -offset indent +struct header_posix_ustar { + char name[100]; + char mode[8]; + char uid[8]; + char gid[8]; + char size[12]; + char mtime[12]; + char checksum[8]; + char typeflag[1]; + char linkname[100]; + char magic[6]; + char version[2]; + char uname[32]; + char gname[32]; + char devmajor[8]; + char devminor[8]; + char prefix[155]; + char pad[12]; +}; +.Ed +.Bl -tag -width indent +.It Va typeflag +Type of entry. +POSIX extended the earlier +.Va linkflag +field with several new type values: +.Bl -tag -width indent -compact +.It Dq 0 +Regular file. +NUL should be treated as a synonym, for compatibility purposes. +.It Dq 1 +Hard link. +.It Dq 2 +Symbolic link. +.It Dq 3 +Character device node. +.It Dq 4 +Block device node. +.It Dq 5 +Directory. +.It Dq 6 +FIFO node. +.It Dq 7 +Reserved. +.It Other +A POSIX-compliant implementation must treat any unrecognized typeflag value +as a regular file. +In particular, writers should ensure that all entries +have a valid filename so that they can be restored by readers that do not +support the corresponding extension. +Uppercase letters "A" through "Z" are reserved for custom extensions. +Note that sockets and whiteout entries are not archivable. +.El +It is worth noting that the +.Va size +field, in particular, has different meanings depending on the type. +For regular files, of course, it indicates the amount of data +following the header. +For directories, it may be used to indicate the total size of all +files in the directory, for use by operating systems that pre-allocate +directory space. +For all other types, it should be set to zero by writers and ignored +by readers. +.It Va magic +Contains the magic value +.Dq ustar +followed by a NUL byte to indicate that this is a POSIX standard archive. +Full compliance requires the uname and gname fields be properly set. +.It Va version +Version. +This should be +.Dq 00 +(two copies of the ASCII digit zero) for POSIX standard archives. +.It Va uname , Va gname +User and group names, as null-terminated ASCII strings. +These should be used in preference to the uid/gid values +when they are set and the corresponding names exist on +the system. +.It Va devmajor , Va devminor +Major and minor numbers for character device or block device entry. +.It Va name , Va prefix +If the pathname is too long to fit in the 100 bytes provided by the standard +format, it can be split at any +.Pa / +character with the first portion going into the prefix field. +If the prefix field is not empty, the reader will prepend +the prefix value and a +.Pa / +character to the regular name field to obtain the full pathname. +The standard does not require a trailing +.Pa / +character on directory names, though most implementations still +include this for compatibility reasons. +.El +.Pp +Note that all unused bytes must be set to +.Dv NUL . +.Pp +Field termination is specified slightly differently by POSIX +than by previous implementations. +The +.Va magic , +.Va uname , +and +.Va gname +fields must have a trailing +.Dv NUL . +The +.Va pathname , +.Va linkname , +and +.Va prefix +fields must have a trailing +.Dv NUL +unless they fill the entire field. +(In particular, it is possible to store a 256-character pathname if it +happens to have a +.Pa / +as the 156th character.) +POSIX requires numeric fields to be zero-padded in the front, and requires +them to be terminated with either space or +.Dv NUL +characters. +.Pp +Currently, most tar implementations comply with the ustar +format, occasionally extending it by adding new fields to the +blank area at the end of the header record. +.Ss Numeric Extensions +There have been several attempts to extend the range of sizes +or times supported by modifying how numbers are stored in the +header. +.Pp +One obvious extension to increase the size of files is to +eliminate the terminating characters from the various +numeric fields. +For example, the standard only allows the size field to contain +11 octal digits, reserving the twelfth byte for a trailing +NUL character. +Allowing 12 octal digits allows file sizes up to 64 GB. +.Pp +Another extension, utilized by GNU tar, star, and other newer +.Nm +implementations, permits binary numbers in the standard numeric fields. +This is flagged by setting the high bit of the first byte. +The remainder of the field is treated as a signed twos-complement +value. +This permits 95-bit values for the length and time fields +and 63-bit values for the uid, gid, and device numbers. +In particular, this provides a consistent way to handle +negative time values. +GNU tar supports this extension for the +length, mtime, ctime, and atime fields. +Joerg Schilling's star program and the libarchive library support +this extension for all numeric fields. +Note that this extension is largely obsoleted by the extended +attribute record provided by the pax interchange format. +.Pp +Another early GNU extension allowed base-64 values rather than octal. +This extension was short-lived and is no longer supported by any +implementation. +.Ss Pax Interchange Format +There are many attributes that cannot be portably stored in a +POSIX ustar archive. +.St -p1003.1-2001 +defined a +.Dq pax interchange format +that uses two new types of entries to hold text-formatted +metadata that applies to following entries. +Note that a pax interchange format archive is a ustar archive in every +respect. +The new data is stored in ustar-compatible archive entries that use the +.Dq x +or +.Dq g +typeflag. +In particular, older implementations that do not fully support these +extensions will extract the metadata into regular files, where the +metadata can be examined as necessary. +.Pp +An entry in a pax interchange format archive consists of one or +two standard ustar entries, each with its own header and data. +The first optional entry stores the extended attributes +for the following entry. +This optional first entry has an "x" typeflag and a size field that +indicates the total size of the extended attributes. +The extended attributes themselves are stored as a series of text-format +lines encoded in the portable UTF-8 encoding. +Each line consists of a decimal number, a space, a key string, an equals +sign, a value string, and a new line. +The decimal number indicates the length of the entire line, including the +initial length field and the trailing newline. +An example of such a field is: +.Dl 25 ctime=1084839148.1212\en +Keys in all lowercase are standard keys. +Vendors can add their own keys by prefixing them with an all uppercase +vendor name and a period. +Note that, unlike the historic header, numeric values are stored using +decimal, not octal. +A description of some common keys follows: +.Bl -tag -width indent +.It Cm atime , Cm ctime , Cm mtime +File access, inode change, and modification times. +These fields can be negative or include a decimal point and a fractional value. +.It Cm hdrcharset +The character set used by the pax extension values. +By default, all textual values in the pax extended attributes +are assumed to be in UTF-8, including pathnames, user names, +and group names. +In some cases, it is not possible to translate local +conventions into UTF-8. +If this key is present and the value is the six-character ASCII string +.Dq BINARY , +then all textual values are assumed to be in a platform-dependent +multi-byte encoding. +Note that there are only two valid values for this key: +.Dq BINARY +or +.Dq ISO-IR\ 10646\ 2000\ UTF-8 . +No other values are permitted by the standard, and +the latter value should generally not be used as it is the +default when this key is not specified. +In particular, this flag should not be used as a general +mechanism to allow filenames to be stored in arbitrary +encodings. +.It Cm uname , Cm uid , Cm gname , Cm gid +User name, group name, and numeric UID and GID values. +The user name and group name stored here are encoded in UTF8 +and can thus include non-ASCII characters. +The UID and GID fields can be of arbitrary length. +.It Cm linkpath +The full path of the linked-to file. +Note that this is encoded in UTF8 and can thus include non-ASCII characters. +.It Cm path +The full pathname of the entry. +Note that this is encoded in UTF8 and can thus include non-ASCII characters. +.It Cm realtime.* , Cm security.* +These keys are reserved and may be used for future standardization. +.It Cm size +The size of the file. +Note that there is no length limit on this field, allowing conforming +archives to store files much larger than the historic 8GB limit. +.It Cm SCHILY.* +Vendor-specific attributes used by Joerg Schilling's +.Nm star +implementation. +.It Cm SCHILY.acl.access , Cm SCHILY.acl.default , Cm SCHILY.acl.ace +Stores the access, default and NFSv4 ACLs as textual strings in a format +that is an extension of the format specified by POSIX.1e draft 17. +In particular, each user or group access specification can include +an additional colon-separated field with the numeric UID or GID. +This allows ACLs to be restored on systems that may not have complete +user or group information available (such as when NIS/YP or LDAP services +are temporarily unavailable). +.It Cm SCHILY.devminor , Cm SCHILY.devmajor +The full minor and major numbers for device nodes. +.It Cm SCHILY.fflags +The file flags. +.It Cm SCHILY.realsize +The full size of the file on disk. +XXX explain? XXX +.It Cm SCHILY.dev , Cm SCHILY.ino , Cm SCHILY.nlinks +The device number, inode number, and link count for the entry. +In particular, note that a pax interchange format archive using Joerg +Schilling's +.Cm SCHILY.* +extensions can store all of the data from +.Va struct stat . +.It Cm LIBARCHIVE.* +Vendor-specific attributes used by the +.Nm libarchive +library and programs that use it. +.It Cm LIBARCHIVE.creationtime +The time when the file was created. +(This should not be confused with the POSIX +.Dq ctime +attribute, which refers to the time when the file +metadata was last changed.) +.It Cm LIBARCHIVE.xattr . Ns Ar namespace . Ns Ar key +Libarchive stores POSIX.1e-style extended attributes using +keys of this form. +The +.Ar key +value is URL-encoded: +All non-ASCII characters and the two special characters +.Dq = +and +.Dq % +are encoded as +.Dq % +followed by two uppercase hexadecimal digits. +The value of this key is the extended attribute value +encoded in base 64. +XXX Detail the base-64 format here XXX +.It Cm VENDOR.* +XXX document other vendor-specific extensions XXX +.El +.Pp +Any values stored in an extended attribute override the corresponding +values in the regular tar header. +Note that compliant readers should ignore the regular fields when they +are overridden. +This is important, as existing archivers are known to store non-compliant +values in the standard header fields in this situation. +There are no limits on length for any of these fields. +In particular, numeric fields can be arbitrarily large. +All text fields are encoded in UTF8. +Compliant writers should store only portable 7-bit ASCII characters in +the standard ustar header and use extended +attributes whenever a text value contains non-ASCII characters. +.Pp +In addition to the +.Cm x +entry described above, the pax interchange format +also supports a +.Cm g +entry. +The +.Cm g +entry is identical in format, but specifies attributes that serve as +defaults for all subsequent archive entries. +The +.Cm g +entry is not widely used. +.Pp +Besides the new +.Cm x +and +.Cm g +entries, the pax interchange format has a few other minor variations +from the earlier ustar format. +The most troubling one is that hardlinks are permitted to have +data following them. +This allows readers to restore any hardlink to a file without +having to rewind the archive to find an earlier entry. +However, it creates complications for robust readers, as it is no longer +clear whether or not they should ignore the size field for hardlink entries. +.Ss GNU Tar Archives +The GNU tar program started with a pre-POSIX format similar to that +described earlier and has extended it using several different mechanisms: +It added new fields to the empty space in the header (some of which was later +used by POSIX for conflicting purposes); +it allowed the header to be continued over multiple records; +and it defined new entries that modify following entries +(similar in principle to the +.Cm x +entry described above, but each GNU special entry is single-purpose, +unlike the general-purpose +.Cm x +entry). +As a result, GNU tar archives are not POSIX compatible, although +more lenient POSIX-compliant readers can successfully extract most +GNU tar archives. +.Bd -literal -offset indent +struct header_gnu_tar { + char name[100]; + char mode[8]; + char uid[8]; + char gid[8]; + char size[12]; + char mtime[12]; + char checksum[8]; + char typeflag[1]; + char linkname[100]; + char magic[6]; + char version[2]; + char uname[32]; + char gname[32]; + char devmajor[8]; + char devminor[8]; + char atime[12]; + char ctime[12]; + char offset[12]; + char longnames[4]; + char unused[1]; + struct { + char offset[12]; + char numbytes[12]; + } sparse[4]; + char isextended[1]; + char realsize[12]; + char pad[17]; +}; +.Ed +.Bl -tag -width indent +.It Va typeflag +GNU tar uses the following special entry types, in addition to +those defined by POSIX: +.Bl -tag -width indent +.It "7" +GNU tar treats type "7" records identically to type "0" records, +except on one obscure RTOS where they are used to indicate the +pre-allocation of a contiguous file on disk. +.It "D" +This indicates a directory entry. +Unlike the POSIX-standard "5" +typeflag, the header is followed by data records listing the names +of files in this directory. +Each name is preceded by an ASCII "Y" +if the file is stored in this archive or "N" if the file is not +stored in this archive. +Each name is terminated with a null, and +an extra null marks the end of the name list. +The purpose of this +entry is to support incremental backups; a program restoring from +such an archive may wish to delete files on disk that did not exist +in the directory when the archive was made. +.Pp +Note that the "D" typeflag specifically violates POSIX, which requires +that unrecognized typeflags be restored as normal files. +In this case, restoring the "D" entry as a file could interfere +with subsequent creation of the like-named directory. +.It "K" +The data for this entry is a long linkname for the following regular entry. +.It "L" +The data for this entry is a long pathname for the following regular entry. +.It "M" +This is a continuation of the last file on the previous volume. +GNU multi-volume archives guarantee that each volume begins with a valid +entry header. +To ensure this, a file may be split, with part stored at the end of one volume, +and part stored at the beginning of the next volume. +The "M" typeflag indicates that this entry continues an existing file. +Such entries can only occur as the first or second entry +in an archive (the latter only if the first entry is a volume label). +The +.Va size +field specifies the size of this entry. +The +.Va offset +field at bytes 369-380 specifies the offset where this file fragment +begins. +The +.Va realsize +field specifies the total size of the file (which must equal +.Va size +plus +.Va offset ) . +When extracting, GNU tar checks that the header file name is the one it is +expecting, that the header offset is in the correct sequence, and that +the sum of offset and size is equal to realsize. +.It "N" +Type "N" records are no longer generated by GNU tar. +They contained a +list of files to be renamed or symlinked after extraction; this was +originally used to support long names. +The contents of this record +are a text description of the operations to be done, in the form +.Dq Rename %s to %s\en +or +.Dq Symlink %s to %s\en ; +in either case, both +filenames are escaped using K&R C syntax. +Due to security concerns, "N" records are now generally ignored +when reading archives. +.It "S" +This is a +.Dq sparse +regular file. +Sparse files are stored as a series of fragments. +The header contains a list of fragment offset/length pairs. +If more than four such entries are required, the header is +extended as necessary with +.Dq extra +header extensions (an older format that is no longer used), or +.Dq sparse +extensions. +.It "V" +The +.Va name +field should be interpreted as a tape/volume header name. +This entry should generally be ignored on extraction. +.El +.It Va magic +The magic field holds the five characters +.Dq ustar +followed by a space. +Note that POSIX ustar archives have a trailing null. +.It Va version +The version field holds a space character followed by a null. +Note that POSIX ustar archives use two copies of the ASCII digit +.Dq 0 . +.It Va atime , Va ctime +The time the file was last accessed and the time of +last change of file information, stored in octal as with +.Va mtime . +.It Va longnames +This field is apparently no longer used. +.It Sparse Va offset / Va numbytes +Each such structure specifies a single fragment of a sparse +file. +The two fields store values as octal numbers. +The fragments are each padded to a multiple of 512 bytes +in the archive. +On extraction, the list of fragments is collected from the +header (including any extension headers), and the data +is then read and written to the file at appropriate offsets. +.It Va isextended +If this is set to non-zero, the header will be followed by additional +.Dq sparse header +records. +Each such record contains information about as many as 21 additional +sparse blocks as shown here: +.Bd -literal -offset indent +struct gnu_sparse_header { + struct { + char offset[12]; + char numbytes[12]; + } sparse[21]; + char isextended[1]; + char padding[7]; +}; +.Ed +.It Va realsize +A binary representation of the file's complete size, with a much larger range +than the POSIX file size. +In particular, with +.Cm M +type files, the current entry is only a portion of the file. +In that case, the POSIX size field will indicate the size of this +entry; the +.Va realsize +field will indicate the total size of the file. +.El +.Ss GNU tar pax archives +GNU tar 1.14 (XXX check this XXX) and later will write +pax interchange format archives when you specify the +.Fl -posix +flag. +This format follows the pax interchange format closely, +using some +.Cm SCHILY +tags and introducing new keywords to store sparse file information. +There have been three iterations of the sparse file support, referred to +as +.Dq 0.0 , +.Dq 0.1 , +and +.Dq 1.0 . +.Bl -tag -width indent +.It Cm GNU.sparse.numblocks , Cm GNU.sparse.offset , Cm GNU.sparse.numbytes , Cm GNU.sparse.size +The +.Dq 0.0 +format used an initial +.Cm GNU.sparse.numblocks +attribute to indicate the number of blocks in the file, a pair of +.Cm GNU.sparse.offset +and +.Cm GNU.sparse.numbytes +to indicate the offset and size of each block, +and a single +.Cm GNU.sparse.size +to indicate the full size of the file. +This is not the same as the size in the tar header because the +latter value does not include the size of any holes. +This format required that the order of attributes be preserved and +relied on readers accepting multiple appearances of the same attribute +names, which is not officially permitted by the standards. +.It Cm GNU.sparse.map +The +.Dq 0.1 +format used a single attribute that stored a comma-separated +list of decimal numbers. +Each pair of numbers indicated the offset and size, respectively, +of a block of data. +This does not work well if the archive is extracted by an archiver +that does not recognize this extension, since many pax implementations +simply discard unrecognized attributes. +.It Cm GNU.sparse.major , Cm GNU.sparse.minor , Cm GNU.sparse.name , Cm GNU.sparse.realsize +The +.Dq 1.0 +format stores the sparse block map in one or more 512-byte blocks +prepended to the file data in the entry body. +The pax attributes indicate the existence of this map +(via the +.Cm GNU.sparse.major +and +.Cm GNU.sparse.minor +fields) +and the full size of the file. +The +.Cm GNU.sparse.name +holds the true name of the file. +To avoid confusion, the name stored in the regular tar header +is a modified name so that extraction errors will be apparent +to users. +.El +.Ss Solaris Tar +XXX More Details Needed XXX +.Pp +Solaris tar (beginning with SunOS XXX 5.7 ?? XXX) supports an +.Dq extended +format that is fundamentally similar to pax interchange format, +with the following differences: +.Bl -bullet -compact -width indent +.It +Extended attributes are stored in an entry whose type is +.Cm X , +not +.Cm x , +as used by pax interchange format. +The detailed format of this entry appears to be the same +as detailed above for the +.Cm x +entry. +.It +An additional +.Cm A +header is used to store an ACL for the following regular entry. +The body of this entry contains a seven-digit octal number +followed by a zero byte, followed by the +textual ACL description. +The octal value is the number of ACL entries +plus a constant that indicates the ACL type: 01000000 +for POSIX.1e ACLs and 03000000 for NFSv4 ACLs. +.El +.Ss AIX Tar +XXX More details needed XXX +.Pp +AIX Tar uses a ustar-formatted header with the type +.Cm A +for storing coded ACL information. +Unlike the Solaris format, AIX tar writes this header after the +regular file body to which it applies. +The pathname in this header is either +.Cm NFS4 +or +.Cm AIXC +to indicate the type of ACL stored. +The actual ACL is stored in platform-specific binary format. +.Ss Mac OS X Tar +The tar distributed with Apple's Mac OS X stores most regular files +as two separate files in the tar archive. +The two files have the same name except that the first +one has +.Dq ._ +prepended to the last path element. +This special file stores an AppleDouble-encoded +binary blob with additional metadata about the second file, +including ACL, extended attributes, and resources. +To recreate the original file on disk, each +separate file can be extracted and the Mac OS X +.Fn copyfile +function can be used to unpack the separate +metadata file and apply it to th regular file. +Conversely, the same function provides a +.Dq pack +option to encode the extended metadata from +a file into a separate file whose contents +can then be put into a tar archive. +.Pp +Note that the Apple extended attributes interact +badly with long filenames. +Since each file is stored with the full name, +a separate set of extensions needs to be included +in the archive for each one, doubling the overhead +required for files with long names. +.Ss Summary of tar type codes +The following list is a condensed summary of the type codes +used in tar header records generated by different tar implementations. +More details about specific implementations can be found above: +.Bl -tag -compact -width XXX +.It NUL +Early tar programs stored a zero byte for regular files. +.It Cm 0 +POSIX standard type code for a regular file. +.It Cm 1 +POSIX standard type code for a hard link description. +.It Cm 2 +POSIX standard type code for a symbolic link description. +.It Cm 3 +POSIX standard type code for a character device node. +.It Cm 4 +POSIX standard type code for a block device node. +.It Cm 5 +POSIX standard type code for a directory. +.It Cm 6 +POSIX standard type code for a FIFO. +.It Cm 7 +POSIX reserved. +.It Cm 7 +GNU tar used for pre-allocated files on some systems. +.It Cm A +Solaris tar ACL description stored prior to a regular file header. +.It Cm A +AIX tar ACL description stored after the file body. +.It Cm D +GNU tar directory dump. +.It Cm K +GNU tar long linkname for the following header. +.It Cm L +GNU tar long pathname for the following header. +.It Cm M +GNU tar multivolume marker, indicating the file is a continuation of a file from the previous volume. +.It Cm N +GNU tar long filename support. +Deprecated. +.It Cm S +GNU tar sparse regular file. +.It Cm V +GNU tar tape/volume header name. +.It Cm X +Solaris tar general-purpose extension header. +.It Cm g +POSIX pax interchange format global extensions. +.It Cm x +POSIX pax interchange format per-file extensions. +.El +.Sh SEE ALSO +.Xr ar 1 , +.Xr pax 1 , +.Xr tar 1 +.Sh STANDARDS +The +.Nm tar +utility is no longer a part of POSIX or the Single Unix Standard. +It last appeared in +.St -susv2 . +It has been supplanted in subsequent standards by +.Xr pax 1 . +The ustar format is currently part of the specification for the +.Xr pax 1 +utility. +The pax interchange file format is new with +.St -p1003.1-2001 . +.Sh HISTORY +A +.Nm tar +command appeared in Seventh Edition Unix, which was released in January, 1979. +It replaced the +.Nm tp +program from Fourth Edition Unix which in turn replaced the +.Nm tap +program from First Edition Unix. +John Gilmore's +.Nm pdtar +public-domain implementation (circa 1987) was highly influential +and formed the basis of +.Nm GNU tar +(circa 1988). +Joerg Shilling's +.Nm star +archiver is another open-source (CDDL) archiver (originally developed +circa 1985) which features complete support for pax interchange +format. +.Pp +This documentation was written as part of the +.Nm libarchive +and +.Nm bsdtar +project by +.An Tim Kientzle Aq kientzle@FreeBSD.org . diff --git a/miniconda3/share/man/man8/genccode.8 b/miniconda3/share/man/man8/genccode.8 new file mode 100644 index 0000000000000000000000000000000000000000..1c7ce1020bd01fbd5916e3aeb0ff87c0eb6a4ca4 --- /dev/null +++ b/miniconda3/share/man/man8/genccode.8 @@ -0,0 +1,108 @@ +.\" Hey, Emacs! This is -*-nroff-*- you know... +.\" +.\" genccode.8: manual page for the gennames utility +.\" +.\" Copyright (C) 2016 and later: Unicode, Inc. and others. +.\" License & terms of use: http://www.unicode.org/copyright.html +.\" Copyright (C) 2003-2004 IBM, Inc. and others. +.\" +.TH GENCCODE 8 "11 March 2004" "ICU MANPAGE" "ICU 73.1 Manual" +.SH NAME +.B genccode +\- generate C or platform specific assembly code from an ICU data file. +.SH SYNOPSIS +.B genccode +[ +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +] +[ +.BI "\-a\fP, \fB\-\-assembly" " name" +] +[ +.BI "\-d\fP, \fB\-\-destdir" " destination" +] +[ +.BI "\-n\fP, \fB\-\-name" " name" +] +[ +.BI "\-e\fP, \fB\-\-entrypoint" " name" +] +[ +.BI "\-f\fP, \fB\-\-filename" " name" +] +[ +.IR filename " .\|.\|." +] +.SH DESCRIPTION +.B genccode +reads each of the supplied +.I filename +and writes out a C file containing a compilable definition of the data in +the data file. +The C file name is made by taking the base name of the data +.IR filename , +replacing dots by underscores, and adding a +.I .c +file extension. +.PP +If the \fB-a\fP option is used, platform specific assembly +code is generated instead of C code. +Most C compilers will accept both C and assembly files. +Instead of writing a filename with a +.I .c +file extension, a filename with a +.I .s +will be written instead. +.PP +If +.B genccode +is called with no +.I filename +it terminates gracefully. +.SH OPTIONS +.TP +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +Print help about usage and exit. +.TP +.BI "\-a\fP, \fB\-\-assembly" " name" +Output assembly code instead of C code. +Use \fB-h\fP to see the list of available types of assembly to generate and +to specify for this option. +.TP +.BI "\-d\fP, \fB\-\-destdir" " destination" +Set the destination directory to +.IR destination . +The default destination directory is the current directory. +.TP +.BI "\-n\fP, \fB\-\-name" " name" +Set the data name to +.I name +instead of the default. This name is also used as the base name of the +output. The default name is made of the +.I icudt +prefix, followed by a two-digit version number corresponding to +the current version of the ICU release, and a single letter indicating +the endianness of the data (the letter +.I b +indicated big endian data, and the letter +.I l +indicates little endian ones). +.TP +.BI "\-f\fP, \fB\-\-filename" " name" +Normally, an ICU data file such as mydata.icu will be turned into mydata_icu.c and mydata_icu.o. +However, if this parameter was set to "somedata", the output files will be somedata.o and +somedata.c, respectively. +.TP +.BI "\-e\fP, \fB\-\-entrypoint" " name" +Set the data entry point (used for linking against the data in a +shared library form) to +.IR name . +The default entry point name is made of the data (set by the +.BI "\-n\fP, \fB\-\-name" +option) followed by an underscore and the type of the data (set by the +.BI "\-t\fP, \fB\-\-type" +option). +.SH VERSION +73.1 +.SH COPYRIGHT +Copyright (C) 2000-2004 IBM, Inc. and others. diff --git a/miniconda3/share/man/man8/gencmn.8 b/miniconda3/share/man/man8/gencmn.8 new file mode 100644 index 0000000000000000000000000000000000000000..d502ba7b21e06ec3d3a4f2a8ef9883527bd05509 --- /dev/null +++ b/miniconda3/share/man/man8/gencmn.8 @@ -0,0 +1,131 @@ +.\" Hey, Emacs! This is -*-nroff-*- you know... +.\" +.\" gencmn.8: manual page for the gencmn utility +.\" +.\" Copyright (C) 2016 and later: Unicode, Inc. and others. +.\" License & terms of use: http://www.unicode.org/copyright.html +.\" Copyright (C) 2000-2001 IBM, Inc. and others. +.\" +.\" Manual page by Yves Arrouye . +.\" +.TH GENCMN 8 "5 November 2001" "ICU MANPAGE" "ICU 73.1 Manual" +.SH NAME +.B gencmn +\- generate an ICU memory-mappable data file +.SH SYNOPSIS +.B gencmn +[ +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +] +[ +.BR "\-v\fP, \fB\-\-verbose" +] +[ +.BR "\-c\fP, \fB\-\-copyright" +| +.BI "\-C\fP, \fB\-\-comment" " comment" +] +[ +.BI "\-d\fP, \fB\-\-destdir" " destination" +] +[ +.BI "\-n\fP, \fB\-\-name" " name" +] +[ +.BI "\-t\fP, \fB\-\-type" " fileext" +] +[ +.BI "\-S\fP, \fB\-\-source" +] +[ +.BI "\-e\fP, \fB\-\-entrypoint" " name" +] +.I maxsize +[ +.I listfilename +] +.SH DESCRIPTION +.B gencmn +takes a set of files and packages them as an ICU memory-mappable data +file. The resulting data file can then be used directly by ICU. +.PP +.B gencmn +reads a list of files to be packaged from either the +supplied +.I listfilename +file, or from its standard output. It packages all the files from +the list that are not bigger than +.I maxsize +bytes, except if +.I maxsize +is 0, which indicates that there is no size limit on files. +.SH OPTIONS +.TP +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +Print help about usage and exit. +.TP +.BR "\-v\fP, \fB\-\-verbose" +Display extra informative messages during execution. +.TP +.BR \-c\fP, \fB\-\-copyright +Include the ICU copyright notice in the resulting data. +.TP +.BI "\-C\fP, \fB\-\-comment" " comment" +Include the specified +.I comment +in the resulting data instead of the ICU copyright notice. +.TP +.BI "\-d\fP, \fB\-\-destdir" " destination" +Set the destination directory to +.IR destination . +The default destination directory is specified by the environment variable +.BR ICU_DATA . +.TP +.BI "\-n\fP, \fB\-\-name" " name" +Set the data name to +.I name +instead of the default. This name is also used as the base name of the +output. The default name is made of the +.I icudt +prefix, followed by a two-digit version number corresponding to +the current version of the ICU release, and a single letter indicating +the endianness of the data (the letter +.I b +indicated big endian data, and the letter +.I l +indicates little endian ones). +.TP +.BI "\-t\fP, \fB\-\-type" " type" +Use +.I type +as the type of the data. This type is also used as the extension of +the generated data file. The default type ie +.IR dat . +.TP +.BI "\-S\fP, \fB\-\-source" +Write a C source file with the table of contents of the data. +.TP +.BI "\-e\fP, \fB\-\-entrypoint" " name" +Set the data entry point (used for linking against the data in a +shared library form) to +.IR name . +The default entry point name is made of the data (set by the +.BI "\-n\fP, \fB\-\-name" +option) followed by an underscore and the type of the data (set by the +.BI "\-t\fP, \fB\-\-type" +option). +.SH ENVIRONMENT +.TP 10 +.B ICU_DATA +Specifies the directory containing ICU data. Defaults to +.BR ${prefix}/share/icu/73.1/ . +Some tools in ICU depend on the presence of the trailing slash. It is thus +important to make sure that it is present if +.B ICU_DATA +is set. +.SH VERSION +73.1 +.SH COPYRIGHT +Copyright (C) 2000-2001 IBM, Inc. and others. +.SH SEE ALSO +.BR decmn (8) diff --git a/miniconda3/share/man/man8/gensprep.8 b/miniconda3/share/man/man8/gensprep.8 new file mode 100644 index 0000000000000000000000000000000000000000..6ed0b54328320b48567377c9a379b76cff575172 --- /dev/null +++ b/miniconda3/share/man/man8/gensprep.8 @@ -0,0 +1,104 @@ +.\" Hey, Emacs! This is -*-nroff-*- you know... +.\" +.\" gensprep.8: manual page for the gensprep utility +.\" +.\" Copyright (C) 2016 and later: Unicode, Inc. and others. +.\" License & terms of use: http://www.unicode.org/copyright.html +.\" Copyright (C) 2003 IBM, Inc. and others. +.\" +.TH gensprep 8 "18 March 2003" "ICU MANPAGE" "ICU 73.1 Manual" +.SH NAME +.B gensprep +\- compile StringPrep data from files filtered by filterRFC3454.pl +.SH SYNOPSIS +.B gensprep +[ +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +] +[ +.BR "\-v\fP, \fB\-\-verbose" +] +[ +.BI "\-c\fP, \fB\-\-copyright" +] +[ +.BI "\-s\fP, \fB\-\-sourcedir" " source" +] +[ +.BI "\-d\fP, \fB\-\-destdir" " destination" +] +.SH DESCRIPTION +.B gensprep +reads filtered RFC 3454 files and compiles their +information into a binary form. +The resulting file, +.BR .icu , +can then be read directly by ICU, or used by +.BR pkgdata (8) +for incorporation into a larger archive or library. +.LP +The files read by +.B gensprep +are described in the +.B FILES +section. +.SH OPTIONS +.TP +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +Print help about usage and exit. +.TP +.BR "\-v\fP, \fB\-\-verbose" +Display extra informative messages during execution. +.TP +.BI "\-c\fP, \fB\-\-copyright" +Include a copyright notice into the binary data. +.TP +.BI "\-s\fP, \fB\-\-sourcedir" " source" +Set the source directory to +.IR source . +The default source directory is specified by the environment variable +.BR ICU_DATA . +.TP +.BI "\-d\fP, \fB\-\-destdir" " destination" +Set the destination directory to +.IR destination . +The default destination directory is specified by the environment variable +.BR ICU_DATA . +.SH ENVIRONMENT +.TP 10 +.B ICU_DATA +Specifies the directory containing ICU data. Defaults to +.BR ${prefix}/share/icu/73.1/ . +Some tools in ICU depend on the presence of the trailing slash. It is thus +important to make sure that it is present if +.B ICU_DATA +is set. +.SH FILES +The following files are read by +.B gensprep +and are looked for in the +.I source +/misc for rfc3454_*.txt files and in +.I source +/unidata for NormalizationCorrections.txt. +.TP 20 +.B rfc3453_A_1.txt +Contains the list of unassigned codepoints in Unicode version 3.2.0.\|.\|.. +.TP +.B rfc3454_B_1.txt +Contains the list of code points that are commonly mapped to nothing.\|.\|.. +.TP +.B rfc3454_B_2.txt +Contains the list of mappings for casefolding of code points when Normalization form NFKC is specified.\|.\|.. +.TP +.B rfc3454_C_X.txt +Contains the list of code points that are prohibited for IDNA. +.TP +.B NormalizationCorrections.txt +Contains the list of code points whose normalization has changed since Unicode Version 3.2.0. +.SH VERSION +73.1 +.SH COPYRIGHT +Copyright (C) 2000-2002 IBM, Inc. and others. +.SH SEE ALSO +.BR pkgdata (8) diff --git a/miniconda3/share/man/man8/icupkg.8 b/miniconda3/share/man/man8/icupkg.8 new file mode 100644 index 0000000000000000000000000000000000000000..e34aa56bbc6b790bf115663bf7bcee30aae000e0 --- /dev/null +++ b/miniconda3/share/man/man8/icupkg.8 @@ -0,0 +1,206 @@ +.\" Hey, Emacs! This is -*-nroff-*- you know... +.\" +.\" icupkg.8: manual page for the icupkg utility +.\" +.\" Copyright (C) 2016 and later: Unicode, Inc. and others. +.\" License & terms of use: http://www.unicode.org/copyright.html +.\" Copyright (C) 2000-2006 IBM, Inc. and others. +.\" +.TH ICUPKG 8 "18 August 2006" "ICU MANPAGE" "ICU 73.1 Manual" +.SH NAME +.B icupkg +\- extract or modify an ICU +.B .dat +archive +.SH SYNOPSIS +.B icupkg +[ +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +] +[ +.BR "\-tl\fP, \fB\-\-type" " l" +| +.BR "\-tb\fP, \fB\-\-type" " b" +| +.BR "\-te\fP, \fB\-\-type" " e" +] +[ +.BR "\-c\fP, \fB\-\-copyright" +| +.BI "\-C\fP, \fB\-\-comment" " comment" +] +[ +.BI "\-a\fP, \fB\-\-add" " list" +] +[ +.BI "\-r\fP, \fB\-\-remove" " list" +] +[ +.BI "\-x\fP, \fB\-\-extract" " list" +] +[ +.BI "\-l\fP, \fB\-\-list" +] +[ +.BI "\-s\fP, \fB\-\-sourcedir" " source" +] +[ +.BI "\-d\fP, \fB\-\-destdir" " destination" +] +[ +.BI "\-w\fP, \fB\-\-writepkg" +] +[ +.BI "\-m\fP, \fB\-\-matchmode" " mode" +] +.IR infilename +[ +.BI "outfilename" +] +.SH DESCRIPTION +.B icupkg +reads the input ICU +.B .dat +package file, modify it according to the options, +swap it to the desired platform properties (charset & endianness), +and optionally write the resulting ICU +.B .dat +package to the output file. +Items are removed, then added, then extracted and listed. +An ICU +.B .dat +package is written if items are removed or added, +or if the input and output filenames differ, +or if the +.BR "\-w\fP, \fB\-\-writepkg" +option is set. +.PP +If the input filename is "new" then an empty package is created. +If the output filename is missing, then it is automatically generated +from the input filename. If the input filename ends with an l, b, or e +matching its platform properties, then the output filename will +contain the letter from the +.BI "\-t\fP, \fB\-\-type" +option. +.PP +This tool can also be used to just swap a single ICU data file, replacing the +former icuswap tool. For this mode, provide the infilename (and optional +outfilename) for a non-package ICU data file. +Allowed options include +.BI "\-t\fP, \fB\-w\fP, \fB\-s\fP" +and +.BI \-d +. +The filenames can be absolute, or relative to the source/dest dir paths. +Other options are not allowed in this mode. +.SH OPTIONS +.TP +.BR "\-h\fP, \fB\-?\fP, \fB\-\-help" +Print help about usage and exit. +.TP +.BI "\-tl\fP, \fB\-\-type" " l" +Output for little-endian/ASCII charset family. +The output type defaults to the input type. +.TP +.BI "\-tb\fP, \fB\-\-type" " b" +Output for big-endian/ASCII charset family. +The output type defaults to the input type. +.TP +.BI "\-te\fP, \fB\-\-type" " e" +Output for big-endian/EBCDIC charset family. +The output type defaults to the input type. +.TP +.BR \-c\fP, \fB\-\-copyright +Include the ICU copyright notice in the resulting data. +.TP +.BI "\-C\fP, \fB\-\-comment" " comment" +Include the specified +.I comment +in the resulting data instead of the ICU copyright notice. +.TP +.BI "\-a\fP, \fB\-\-add" " list" +Add items from the +.I list +to the package. The list can be a single filename with a +.B .txt +file extension containing a list of item filenames, or an ICU +.B .dat +package filename. +.TP +.BI "\-r\fP, \fB\-\-remove" " list" +Remove items from the +.I list +from the package. The list can be a single filename with a +.B .txt +file extension containing a list of item filenames, or an ICU +.B .dat +package filename. +.TP +.BI "\-x\fP, \fB\-\-extract" " list" +Extract items from the +.I list +from the package. The list can be a single filename with a +.B .txt +file extension containing a list of item filenames, or an ICU +.B .dat +package filename. +.TP +.BI "\-m\fP, \fB\-\-matchmode" " mode" +Set the matching mode for item names with wildcards. +.TP +.BI "\-s\fP, \fB\-\-sourcedir" " source" +Set the source directory to +.IR source . +The default source directory is the current directory. +.TP +.BI "\-d\fP, \fB\-\-destdir" " destination" +Set the destination directory to +.IR destination . +The default destination directory is the current directory. +.TP +.BI "\-l\fP, \fB\-\-list" +List the package items to stdout (after modifying the package). +.SH LIST FILE SYNTAX +Items are listed on one or more lines and separated by whitespace (space+tab). +Comments begin with +.B # +and are ignored. Empty lines are ignored. Lines where the first non-whitespace +character is one of "%&'()*+,-./:;<=>?_ are also ignored +to reserve for future syntax. +.PP +Items for removal or extraction may contain a single +.B * +wildcard character. The +.B * +matches zero or more characters. If +.BI "\-m\fP, \fB\-\-matchmode" " noslash" +is set, then the +.B * +character does not match the +.B / +character. +.PP +Items must be listed relative to the package, and the +.B "\fB\-\-sourcedir" +or the +.B "\fB\-\-destdir" +path will be prepended. The paths are only prepended to item +filenames while adding or extracting items, not to ICU .dat package or list +filenames. +.PP +Paths may contain +.B / +instead of the platform's file separator character and are converted as +appropriate. +.SH AUTHORS +Markus Scherer +.br +George Rhoten +.SH VERSION +1.0 +.SH COPYRIGHT +Copyright (C) 2006 IBM, Inc. and others. +.SH SEE ALSO +.BR pkgdata (1) +.BR genrb (1) + diff --git a/miniconda3/share/man/pt_BR/man1/lzcat.1 b/miniconda3/share/man/pt_BR/man1/lzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/lzcat.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/lzless.1 b/miniconda3/share/man/pt_BR/man1/lzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..a39dabb94a2bcc67dfe99963c489e76222de6af8 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/lzless.1 @@ -0,0 +1,48 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NOME +xzless, lzless \- visualiza arquivos (texto) compactados em xz ou lzma +.SH SINOPSE +\fBxzless\fP [\fIarquivo\fP...] +.br +\fBlzless\fP [\fIfile\fP...] (DEPRECATED) +.SH DESCRIÇÃO +\fBxzless\fP is a filter that displays text from compressed files to a +terminal. Files supported by \fBxz\fP(1) are decompressed; other files are +assumed to be in uncompressed form already. If no \fIfiles\fP are given, +\fBxzless\fP reads from standard input. +.PP +\fBxzless\fP usa \fBless\fP(1) para apresentar sua saída. Ao contrário de +\fBxzmore\fP, sua escolha de pager não pode ser alterada pela configuração de +uma variável de ambiente. Os comandos são baseados em \fBmore\fP(1) e \fBvi\fP(1) +e permitem movimento e busca para frente e para trás. Consulte o manual +\fBless\fP(1) para obter mais informações. +.PP +The command named \fBlzless\fP is provided for backward compatibility with LZMA +Utils. It is deprecated and will be removed in a future version. +.SH AMBIENTE +.TP +\fBLESSMETACHARS\fP +Uma lista de caracteres especiais para o shell. Definido por \fBxzless\fP a +menos que já esteja definido no ambiente. +.TP +\fBLESSOPEN\fP +Defina como uma linha de comando para invocar o descompactador \fBxz\fP(1) para +pré\-processar os arquivos de entrada para \fBless\fP(1). +.SH "VEJA TAMBÉM" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/pt_BR/man1/lzma.1 b/miniconda3/share/man/pt_BR/man1/lzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/lzma.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/lzmadec.1 b/miniconda3/share/man/pt_BR/man1/lzmadec.1 new file mode 100644 index 0000000000000000000000000000000000000000..996139d902e42586500e065920dcaa01e8630344 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/lzmadec.1 @@ -0,0 +1,87 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 2024\-04\-08 Tukaani "XZ Utils" +.SH NOME +xzdec, lzmadec \- Pequenos descompactadores .xz e .lzma +.SH SINOPSE +\fBxzdec\fP [\fIopção...\fP] [\fIarquivo...\fP] +.br +\fBlzmadec\fP [\fIopção...\fP] [\fIarquivo...\fP] +.SH DESCRIÇÃO +\fBxzdec\fP é uma ferramenta de descompactação baseada em liblzma somente para +arquivos \fB.xz\fP (e somente \fB.xz\fP). \fBxzdec\fP destina\-se a funcionar como um +substituto para \fBxz\fP(1) nas situações mais comuns em que um script foi +escrito para usar \fBxz \-\-decompress \-\-stdout\fP (e possivelmente alguns outras +opções comumente usadas) para descompactar arquivos \fB.xz\fP. \fBlzmadec\fP é +idêntico a \fBxzdec\fP exceto que \fBlzmadec\fP tem suporte a arquivos \fB.lzma\fP em +vez de arquivos \fB.xz\fP. +.PP +Para reduzir o tamanho do executável, \fBxzdec\fP não tem suporte ao uso de +várias threads ou a localização, e não lê opções de variáveis de ambiente +\fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP. \fBxzdec\fP não tem suporte à exibição de +informações de progresso intermediárias: enviar \fBSIGINFO\fP para \fBxzdec\fP não +faz nada, mas enviar \fBSIGUSR1\fP encerra o processo em vez de exibir +informações de progresso. +.SH OPÇÕES +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP tem suporte a apenas +descompactação. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP nunca cria ou remove +quaisquer arquivos. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP sempre grava os dados +descompactados para a saída padrão. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Especificar isso uma vez não faz nada, pois \fBxzdec\fP nunca exibe nenhum +aviso ou notificação. Especifique isso duas vezes para suprimir erros. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP nunca usa o status de saída +2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda e sai com sucesso. +.TP +\fB\-V\fP, \fB\-\-version\fP +Mostra o número da versão do \fBxzdec\fP e liblzma. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Correu tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.PP +\fBxzdec\fP não possui nenhuma mensagem de aviso como o \fBxz\fP(1), portanto, o +status de saída 2 não é usado por \fBxzdec\fP. +.SH NOTAS +Use \fBxz\fP(1) em vez de \fBxzdec\fP ou \fBlzmadec\fP para uso diário +normal. \fBxzdec\fP ou \fBlzmadec\fP destinam\-se apenas a situações em que é +importante ter um descompactador menor do que o \fBxz\fP(1) completo. +.PP +\fBxzdec\fP e \fBlzmadec\fP não são realmente tão pequenos. O tamanho pode ser +reduzido ainda mais eliminando recursos do liblzma no tempo de compilação, +mas isso geralmente não deve ser feito para executáveis distribuídos em +distribuições típicas de sistemas operacionais não embarcados. Se você +precisa de um descompactador \fB.xz\fP realmente pequeno, considere usar o XZ +Embedded. +.SH "VEJA TAMBÉM" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/pt_BR/man1/lzmainfo.1 b/miniconda3/share/man/pt_BR/man1/lzmainfo.1 new file mode 100644 index 0000000000000000000000000000000000000000..5566566aaab6c61810ba235dc1961b23312bde05 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/lzmainfo.1 @@ -0,0 +1,45 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LZMAINFO 1 2013\-06\-30 Tukaani "XZ Utils" +.SH NOME +lzmainfo \- mostra informações armazenadas no cabeçalho do arquivo .lzma +.SH SINOPSE +\fBlzmainfo\fP [\fB\-\-help\fP] [\fB\-\-version\fP] [\fIarquivo...\fP] +.SH DESCRIÇÃO +\fBlzmainfo\fP mostra as informações armazenadas no cabeçalho do arquivo +\&\fB.lzma\fP. Ele lê os primeiros 13 bytes do \fIarquivo\fP especificado, +decodifica o cabeçalho e o imprime na saída padrão em formato legível por +humanos. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for \fB\-\fP, a +entrada padrão será lida. +.PP +Normalmente, as informações mais interessantes são o tamanho descompactado e +o tamanho do dicionário. O tamanho não compactado pode ser mostrado apenas +se o arquivo estiver na variante de formato \fB.lzma\fP não transmitido. A +quantidade de memória necessária para descompactar o arquivo é de algumas +dezenas de kilobytes mais o tamanho do dicionário. +.PP +\fBlzmainfo\fP está incluído no XZ Utils principalmente para compatibilidade +com versões anteriores do LZMA Utils. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.SH BUGS +\fBlzmainfo\fP usa \fBMB\fP enquanto o sufixo correto seria \fBMiB\fP (2^20 +bytes). Isso é para manter a saída compatível com LZMA Utils. +.SH "VEJA TAMBÉM" +\fBxz\fP(1) diff --git a/miniconda3/share/man/pt_BR/man1/unlzma.1 b/miniconda3/share/man/pt_BR/man1/unlzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/unlzma.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/unxz.1 b/miniconda3/share/man/pt_BR/man1/unxz.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/unxz.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/xz.1 b/miniconda3/share/man/pt_BR/man1/xz.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/xz.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/xzcat.1 b/miniconda3/share/man/pt_BR/man1/xzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..0f85fc96ac66488096221e723d837e7d28ff6bc2 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/xzcat.1 @@ -0,0 +1,1994 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NOME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Compacta ou descompacta arquivos .xz +e .lzma +. +.SH SINOPSE +\fBxz\fP [\fIopção...\fP] [\fIarquivo...\fP] +. +.SH "COMANDOS APELIDOS" +\fBunxz\fP é equivalente a \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP é equivalente a \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP é equivalente a \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP é equivalente a \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Ao escrever scripts que precisam descompactar arquivos, é recomendável +sempre usar o nome \fBxz\fP com os argumentos apropriados (\fBxz \-d\fP ou \fBxz \-dc\fP) em vez dos nomes \fBunxz\fP e \fBxzcat\fP. +. +.SH DESCRIÇÃO +\fBxz\fP é uma ferramenta de compactação de dados de uso geral com sintaxe de +linha de comando semelhante ao \fBgzip\fP(1) e ao \fBbzip2\fP(1). O formato de +arquivo nativo é o formato \fB.xz\fP, mas o formato legado \fB.lzma\fP usado por +LZMA Utils e fluxos compactados brutos sem cabeçalhos de formato de +contêiner também são suportados. Além disso, a descompactação do formato +\&\fB.lz\fP usado por \fBlzip\fP é suportada. +.PP +\fBxz\fP compacta ou descompacta cada \fIarquivo\fP de acordo com o modo de +operação selecionado. Se nenhum \fIarquivo\fP for fornecido ou \fIarquivo\fP for +\fB\-\fP, \fBxz\fP lê da entrada padrão e grava os dados processados na saída +padrão. \fBxz\fP recusará (exibirá um erro e ignorará o \fIarquivo\fP) para gravar +dados compactados na saída padrão se for um terminal. Da mesma forma, \fBxz\fP +se recusará a ler dados compactados da entrada padrão se for um terminal. +.PP +A menos que \fB\-\-stdout\fP seja especificado, \fIarquivos\fP diferentes de \fB\-\fP +são gravados em um novo arquivo cujo nome é derivado do nome \fIarquivo\fP de +origem: +.IP \(bu 3 +Ao compactar, o sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.lzma\fP) +é anexado ao nome do arquivo de origem para obter o nome do arquivo de +destino. +.IP \(bu 3 +Ao descompactar, o sufixo \fB.xz\fP, \fB.lzma\fP ou \fB.lz\fP é removido do nome do +arquivo para obter o nome do arquivo de destino. \fBxz\fP também reconhece os +sufixos \fB.txz\fP e \fB.tlz\fP e os substitui pelo sufixo \fB.tar\fP. +.PP +Se o arquivo de destino já existir, um erro será exibido e \fIarquivo\fP será +ignorado. +.PP +A menos que grave na saída padrão, \fBxz\fP exibirá um aviso e pulará o +\fIarquivo\fP se qualquer um dos seguintes se aplicar: +.IP \(bu 3 +\fIArquivo\fP não é um arquivo normal. Links simbólicos não são seguidos e, +portanto, não são considerados arquivos comuns. +.IP \(bu 3 +\fIArquivo\fP tem mais de um link físico. +.IP \(bu 3 +\fIFile\fP tem setuid, setgid ou sticky bit definido. +.IP \(bu 3 +O modo de operação está definido para compactar e o \fIarquivo\fP já possui um +sufixo do formato de arquivo de destino (\fB.xz\fP ou \fB.txz\fP ao compactar para +o formato \fB.xz\fP e \fB.lzma \fP ou \fB.tlz\fP ao compactar para o formato +\&\fB.lzma\fP). +.IP \(bu 3 +O modo de operação está definido para descompactar e o \fIarquivo\fP não possui +um sufixo de nenhum dos formatos de arquivo suportados (\fB.xz\fP, \fB.txz\fP, +\&\fB.lzma\fP, \fB.tlz\fP , ou \fB.lz\fP). +.PP +Depois de compactar ou descompactar com êxito o \fIarquivo\fP, o \fBxz\fP copia o +dono, grupo, permissões, horário de acesso e horário de modificação do +\fIarquivo\fP de origem para o arquivo de destino. Se a cópia do grupo falhar, +as permissões serão modificadas para que o arquivo de destino não se torne +acessível a usuários que não têm permissão para acessar o \fIarquivo\fP de +origem. \fBxz\fP ainda não oferece suporte à cópia de outros metadados, como +listas de controle de acesso ou atributos estendidos. +.PP +Depois que o arquivo de destino for fechado com êxito, o \fIarquivo\fP de +origem será removido, a menos que \fB\-\-keep\fP tenha sido especificado. O +\fIarquivo\fP de origem nunca é removido se a saída for gravada na saída padrão +ou se ocorrer um erro. +.PP +O envio de \fBSIGINFO\fP ou \fBSIGUSR1\fP para o processo do \fBxz\fP faz com que ele +imprima informações de andamento para erro padrão. Isso tem uso limitado, +pois quando o erro padrão é um terminal, usar \fB\-\-verbose\fP exibirá um +indicador de progresso de atualização automática. +. +.SS "Uso de memória" +O uso de memória de \fBxz\fP varia de algumas centenas de kilobytes a vários +gigabytes, dependendo das configurações de compactação. As configurações +usadas ao compactar um arquivo determinam os requisitos de memória do +descompactador. Normalmente, o descompactador precisa de 5\ % a 20\ % da +quantidade de memória que o compactador precisou ao criar o arquivo. Por +exemplo, descompactar um arquivo criado com \fBxz \-9\fP atualmente requer 65\ MiB de memória. Ainda assim, é possível ter arquivos \fB.xz\fP que requerem +vários gigabytes de memória para descompactar. +.PP +Especialmente os usuários de sistemas mais antigos podem achar irritante a +possibilidade de uso de memória muito grande. Para evitar surpresas +desconfortáveis, o \fBxz\fP possui um limitador de uso de memória embutido, que +está desabilitado por padrão. Embora alguns sistemas operacionais forneçam +maneiras de limitar o uso de memória dos processos, confiar nele não foi +considerado flexível o suficiente (por exemplo, usar \fBulimit\fP(1) para +limitar a memória virtual tende a prejudicar \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +O limitador de uso de memória pode ser ativado com a opção de linha de +comando \fB\-\-memlimit=\fP\fIlimite\fP. Geralmente é mais conveniente habilitar o +limitador por padrão definindo a variável de ambiente \fBXZ_DEFAULTS\fP, por +exemplo, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. É possível definir os limites +separadamente para compactação e descompactação usando +\fB\-\-memlimit\-compress=\fP\fIlimite\fP e \fB\-\-memlimit\-decompress=\fP\fIlimite\fP. Usar +essas duas opções fora de \fBXZ_DEFAULTS\fP raramente é útil porque uma única +execução de \fBxz\fP não pode fazer compactação e descompactação e +\fB\-\-memlimit=\fP\fIlimite\fP (ou \fB\-M\fP \fIlimite\fP ) é mais curto para digitar na +linha de comando. +.PP +Se o limite de uso de memória especificado for excedido durante a +descompactação, \fBxz\fP exibirá um erro e a descompactação do arquivo +falhará. Se o limite for excedido durante a compactação, \fBxz\fP tentará +reduzir as configurações para que o limite não seja mais excedido (exceto ao +usar \fB\-\-format=raw\fP ou \fB\-\-no\-adjust\fP). Dessa forma, a operação não +falhará, a menos que o limite seja muito pequeno. A escala das configurações +é feita em etapas que não correspondem às predefinições do nível de +compactação, por exemplo, se o limite for apenas um pouco menor que o valor +necessário para \fBxz \-9\fP, as configurações serão reduzidas apenas um pouco , +não até \fBxz \-8\fP. +. +.SS "Concatenação e preenchimento com arquivos .xz" +É possível concatenar arquivos \fB.xz\fP como estão. \fBxz\fP irá descompactar +tais arquivos como se fossem um único arquivo \fB.xz\fP. +.PP +É possível inserir preenchimento entre as partes concatenadas ou após a +última parte. O preenchimento deve consistir em bytes nulos e o tamanho do +preenchimento deve ser um múltiplo de quatro bytes. Isso pode ser útil, por +exemplo, se o arquivo \fB.xz\fP for armazenado em uma mídia que mede tamanhos +de arquivo em blocos de 512 bytes. +.PP +Concatenação e preenchimento não são permitidos com arquivos \fB.lzma\fP ou +fluxos brutos. +. +.SH OPÇÕES +. +.SS "Sufixos inteiros e valores especiais" +Na maioria dos lugares onde um argumento inteiro é esperado, um sufixo +opcional é suportado para indicar facilmente números inteiros grandes. Não +deve haver espaço entre o número inteiro e o sufixo. +.TP +\fBKiB\fP +Multiplica o inteiro por 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP e \fBKB\fP são +aceitos como sinônimos de \fBKiB\fP. +.TP +\fBMiB\fP +Multiplica o número inteiro por 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP e \fBMB\fP +são aceitos como sinônimos de \fBMiB\fP. +.TP +\fBGiB\fP +Multiplica o número inteiro por 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP e +\fBGB\fP são aceitos como sinônimos de \fBGiB\fP. +.PP +O valor especial \fBmax\fP pode ser usado para indicar o valor inteiro máximo +suportado pela opção. +. +.SS "Modo de operação" +Se várias opções de modo de operação forem dadas, a última entrará em vigor. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Compacta. Este é o modo de operação padrão quando nenhuma opção de modo de +operação é especificada e nenhum outro modo de operação está implícito no +nome do comando (por exemplo, \fBunxz\fP implica em \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +After successful compression, the source file is removed unless writing to +standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decompress. After successful decompression, the source file is removed +unless writing to standard output or \fB\-\-keep\fP was specified. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa a integridade de \fIarquivos\fP compactados. Esta opção é equivalente a +\fB\-\-decompress \-\-stdout\fP exceto que os dados descompactados são descartados +em vez de serem gravados na saída padrão. Nenhum arquivo é criado ou +removido. +.TP +\fB\-l\fP, \fB\-\-list\fP +Imprime informações sobre \fIarquivos\fP compactados. Nenhuma saída +descompactada é produzida e nenhum arquivo é criado ou removido. No modo de +lista, o programa não pode ler os dados compactados da entrada padrão ou de +outras fontes não pesquisáveis. +.IP "" +A listagem padrão mostra informações básicas sobre \fIarquivos\fP, um arquivo +por linha. Para obter informações mais detalhadas, use também a opção +\fB\-\-verbose\fP. Para obter ainda mais informações, use \fB\-\-verbose\fP duas +vezes, mas observe que isso pode ser lento, porque obter todas as +informações extras requer muitas buscas. A largura da saída detalhada excede +80 caracteres, portanto, canalizar a saída para, por exemplo, \fBless\ \-S\fP +pode ser conveniente se o terminal não tiver largura o suficiente. +.IP "" +A saída exata pode variar entre versões \fBxz\fP e localidades diferentes. Para +saída legível por máquina, \fB\-\-robot \-\-list\fP deve ser usado. +. +.SS "Modificadores de operação" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Não exclui os arquivos de entrada. +.IP "" +Desde \fBxz\fP 5.2.6, esta opção também faz \fBxz\fP compactar ou descompactar +mesmo se a entrada for um link simbólico para um arquivo comum, tiver mais +de um link físico ou tiver o setuid, setgid ou sticky bit definir. Os bits +setuid, setgid e sticky não são copiados para o arquivo de destino. Nas +versões anteriores, isso era feito apenas com \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Esta opção tem vários efeitos: +.RS +.IP \(bu 3 +Se o arquivo de destino já existir, o exclui antes de compactar ou +descompactar. +.IP \(bu 3 +Compacta ou descompacta, mesmo que a entrada seja um link simbólico para um +arquivo normal, tenha mais de um link físico ou tenha setuid, setgid ou +sticky bit definido. Os bits setuid, setgid e sticky não são copiados para o +arquivo de destino. +.IP \(bu 3 +Quando usado com \fB\-\-decompress\fP \fB\-\-stdout\fP e \fBxz\fP não consegue reconhecer +o tipo do arquivo de origem, copia o arquivo de origem como está na saída +padrão. Isso permite que \fBxzcat\fP \fB\-\-force\fP seja usado como \fBcat\fP(1) para +arquivos que não foram compactados com \fBxz\fP. Observe que, no futuro, o +\fBxz\fP pode oferecer suporte a novos formatos de arquivo compactado, o que +pode fazer com que o \fBxz\fP descompacte mais tipos de arquivos em vez de +copiá\-los como na saída padrão. \fB\-\-format=\fP\fIformato\fP pode ser usado para +restringir \fBxz\fP para descompactar apenas um único formato de arquivo. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Grava os dados compactados ou descompactados na saída padrão em vez de em um +arquivo. Isso implica em \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Descompacta apenas o primeiro fluxo de \fB.xz\fP e ignora silenciosamente +possíveis dados de entrada restantes após o fluxo. Normalmente, esse +restante posterior sem uso faz com que \fBxz\fP exiba um erro. +.IP "" +\fBxz\fP nunca descompacta mais de um fluxo de arquivos \fB.lzma\fP ou fluxos +brutos, mas esta opção ainda faz \fBxz\fP ignorar os possíveis dados +posteriores após o arquivo \fB.lzma\fP ou fluxo bruto. +.IP "" +Esta opção não tem efeito se o modo de operação não for \fB\-\-decompress\fP ou +\fB\-\-test\fP. +.IP "" +Since \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implies \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Desativa a criação de arquivos esparsos. Por padrão, ao descompactar em um +arquivo normal, \fBxz\fP tenta tornar o arquivo esparso se os dados +descompactados contiverem longas sequências de zeros binários. Ele também +funciona ao gravar na saída padrão, desde que a saída padrão esteja +conectada a um arquivo normal e certas condições adicionais sejam atendidas +para torná\-la segura. A criação de arquivos esparsos pode economizar espaço +em disco e acelerar a descompactação, reduzindo a quantidade de E/S do +disco. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Ao compactar, usa \fI.suf\fP como sufixo para o arquivo de destino em vez de +\&\fB.xz\fP ou \fB.lzma\fP. Se não estiver gravando na saída padrão e o arquivo de +origem já tiver o sufixo \fI.suf\fP, um aviso será exibido e o arquivo será +ignorado. +.IP "" +Ao descompactar, reconhece arquivos com o sufixo \fI.suf\fP além de arquivos +com o sufixo \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP ou \fB.lz\fP . Se o arquivo de +origem tiver o sufixo \fI.suf\fP, o sufixo será removido para obter o nome do +arquivo de destino. +.IP "" +Ao compactar ou descompactar fluxos brutos (\fB\-\-format=raw\fP), o sufixo +sempre deve ser especificado, a menos que seja gravado na saída padrão, +porque não há sufixo padrão para fluxos brutos. +.TP +\fB\-\-files\fP[\fB=\fP\fIarquivo\fP] +Lê os nomes dos arquivos a serem processados em \fIarquivo\fP; se \fIarquivo\fP +for omitido, os nomes dos arquivos serão lidos da entrada padrão. Os nomes +de arquivo devem terminar com o caractere de nova linha. Um traço (\fB\-\fP) é +considerado um nome de arquivo regular; não significa entrada padrão. Se os +nomes de arquivo forem fornecidos também como argumentos de linha de +comando, eles serão processados antes da leitura dos nomes de arquivo de +\fIarquivo\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIarquivo\fP] +Isso é idêntico a \fB\-\-files\fP[\fB=\fP\fIarquivo\fP], exceto que cada nome de +arquivo deve ser finalizado com o caractere nulo. +. +.SS "Opções básicas de formato de arquivo e de compactação" +.TP +\fB\-F\fP \fIformato\fP, \fB\-\-format=\fP\fIformato\fP +Especifica o \fIformato\fP de arquivo para compactar ou descompactar: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Este é o padrão. Ao compactar, \fBauto\fP é equivalente a \fBxz\fP. Ao +descompactar, o formato do arquivo de entrada é detectado +automaticamente. Observe que os fluxos brutos (criados com \fB\-\-format=raw\fP) +não podem ser detectados automaticamente. +.TP +\fBxz\fP +Compacta no formato de arquivo \fB.xz\fP ou aceite apenas arquivos \fB.xz\fP ao +descompactar. +.TP +\fBlzma\fP, \fBalone\fP +Compacta no formato de arquivo legado \fB.lzma\fP ou aceite apenas arquivos +\&\fB.lzma\fP ao descompactar. O nome alternativo \fBalone\fP é fornecido para +compatibilidade com versões anteriores do LZMA Utils. +.TP +\fBlzip\fP +Aceita apenas arquivos \fB.lz\fP ao descompactar. Sem suporte a compactação. +.IP "" +The \fB.lz\fP format versions 0 and 1 are supported. Version 0 files were +produced by \fBlzip\fP 1.3 and older. Such files aren't common but may be +found from file archives as a few source packages were released in this +format. People might have old personal files in this format too. +Decompression support for the format version 0 was removed in \fBlzip\fP 1.18. +\fBlzip\fP 1.4 and later create files in the format version 1. +.TP +\fBraw\fP +Compacta ou descompacta um fluxo bruto (sem cabeçalhos). Isso é destinado +apenas a usuários avançados. Para decodificar fluxos brutos, você precisa +usar \fB\-\-format=raw\fP e especificar explicitamente a cadeia de filtros, que +normalmente seria armazenada nos cabeçalhos do contêiner. +.RE +.TP +\fB\-C\fP \fIverificação\fP, \fB\-\-check=\fP\fIverificação\fP +Especifica o tipo de verificação de integridade. A verificação é calculada a +partir dos dados descompactados e armazenados no arquivo \fB.xz\fP. Esta opção +tem efeito somente ao compactar no formato \fB.xz\fP; o formato \fB.lzma\fP não +oferece suporte a verificações de integridade. A verificação de integridade +(se for o caso) é verificada quando o arquivo \fB.xz\fP é descompactado. +.IP "" +Tipos de \fIverificação\fP suportados: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Não calcula uma verificação de integridade. Isso geralmente é uma má +ideia. Pode ser útil quando a integridade dos dados é verificada por outros +meios. +.TP +\fBcrc32\fP +Calcula CRC32 usando o polinômio do IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calcula CRC64 usando o polinômio de ECMA\-182. Este é o padrão, pois é um +pouco melhor que o CRC32 na detecção de arquivos danificados e a diferença +de velocidade é insignificante. +.TP +\fBsha256\fP +Calcula SHA\-256. Isso é um pouco mais lento do que CRC32 e CRC64. +.RE +.IP "" +A integridade dos cabeçalhos de \fB.xz\fP é sempre verificada com CRC32. Não é +possível alterá\-la ou desativá\-la. +.TP +\fB\-\-ignore\-check\fP +Não confere a verificação de integridade dos dados compactados ao +descompactar. Os valores CRC32 nos cabeçalhos \fB.xz\fP ainda serão conferidos +normalmente. +.IP "" +\fBNão use esta opção a menos que saiba o que está fazendo.\fP Possíveis razões +para usar esta opção: +.RS +.IP \(bu 3 +Tentativa de recuperar dados de um arquivo .xz corrompido. +.IP \(bu 3 +Acelerar a descompactação. Isso é importante principalmente com SHA\-256 ou +com arquivos extremamente bem compactados. É recomendável não usar essa +opção para essa finalidade, a menos que a integridade do arquivo seja +verificada externamente de alguma outra forma. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Seleciona um nível de predefinição de compactação. O padrão é \fB\-6\fP. Se +vários níveis de predefinição forem especificados, o último terá efeito. Se +uma cadeia de filtro personalizada já foi especificada, especificar um nível +de predefinição de compactação limpa a cadeia de filtro personalizada. +.IP "" +As diferenças entre as predefinições são mais significativas do que com +\fBgzip\fP(1) e \fBbzip2\fP(1). As configurações de compactação selecionadas +determinam os requisitos de memória do descompactador, portanto, usar um +nível de predefinição muito alto pode dificultar a descompactação do arquivo +em um sistema antigo com pouca RAM. Especificamente, \fBnão é uma boa ideia usar cegamente \-9 para tudo\fP como costuma acontecer com \fBgzip\fP(1) e +\fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Estas são predefinições um tanto rápidas. \fB\-0\fP às vezes é mais rápida que +\fBgzip \-9\fP ao mesmo tempo que compacta muito melhor. As mais altas +geralmente têm velocidade comparável ao \fBbzip2\fP(1) com taxa de compactação +comparável ou melhor, embora os resultados dependam muito do tipo de dados +que estão sendo compactados. +.TP +\fB\-4\fP ... \fB\-6\fP +Compactação boa a muito boa, mantendo o uso de memória do descompactador +razoável mesmo para sistemas antigos. \fB\-6\fP é o padrão, que geralmente é uma +boa escolha para distribuir arquivos que precisam ser descompactáveis, mesmo +em sistemas com apenas 16\ MiB de RAM. (\fB\-5e\fP ou \fB\-6e\fP também vale a pena +considerar. Veja \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Eles são como \fB\-6\fP, mas com requisitos de memória de compressor e +descompressor mais altos. Eles são úteis apenas ao compactar arquivos +maiores que 8\ MiB, 16\ MiB e 32\ MiB, respectivamente. +.RE +.IP "" +No mesmo hardware, a velocidade de descompactação é aproximadamente um +número constante de bytes de dados compactados por segundo. Em outras +palavras, quanto melhor a compactação, mais rápida será a +descompactação. Isso também significa que a quantidade de saída não +compactada produzida por segundo pode variar muito. +.IP "" +A tabela a seguir resume os recursos das predefinições: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrições das colunas: +.RS +.IP \(bu 3 +DicTam é o tamanho do dicionário LZMA2. É desperdício de memória usar um +dicionário maior que o tamanho do arquivo descompactado. É por isso que é +bom evitar usar as predefinições \fB\-7\fP ... \fB\-9\fP quando não há real +necessidade deles. Em \fB\-6\fP e inferior, a quantidade de memória desperdiçada +geralmente é baixa o suficiente para não importar. +.IP \(bu 3 +CompCPU é uma representação simplificada das configurações LZMA2 que afetam +a velocidade de compactação. O tamanho do dicionário também afeta a +velocidade, portanto, embora o CompCPU seja o mesmo para os níveis \fB\-6\fP +\&... \fB\-9\fP, níveis mais altos ainda tendem a ser um pouco mais lentos. Para +obter uma compactação ainda mais lenta e possivelmente melhor, consulte +\fB\-\-extreme\fP. +.IP \(bu 3 +CompMem contains the compressor memory requirements in the single\-threaded +mode. It may vary slightly between \fBxz\fP versions. +.IP \(bu 3 +DecMem contém os requisitos de memória do descompactador. Ou seja, as +configurações de compactação determinam os requisitos de memória do +descompactador. O uso exato da memória do descompactador é um pouco maior do +que o tamanho do dicionário LZMA2, mas os valores na tabela foram +arredondados para o próximo MiB completo. +.RE +.IP "" +Memory requirements of the multi\-threaded mode are significantly higher than +that of the single\-threaded mode. With the default value of +\fB\-\-block\-size\fP, each thread needs 3*3*DictSize plus CompMem or DecMem. For +example, four threads with preset \fB\-6\fP needs 660\(en670\ MiB of memory. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Usa uma variante mais lenta do nível de predefinição de compactação +selecionado (\fB\-0\fP ... \fB\-9\fP) para obter uma taxa de compactação um pouco +melhor, mas, com azar, isso também pode piorar. O uso da memória do +descompressor não é afetado, mas o uso da memória do compactador aumenta um +pouco nos níveis de predefinição \fB\-0\fP ... \fB\-3\fP. +.IP "" +Como existem duas predefinições com tamanhos de dicionário 4\ MiB e 8\ MiB, +as predefinições \fB\-3e\fP e \fB\-5e\fP usam configurações um pouco mais rápidas +(CompCPU inferior) do que \fB\-4e\fP e \fB\-6e\fP, respectivamente. Dessa forma, não +há duas predefinições idênticas. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Predefinição;DicTam;CompCPU;CompMem;DecMem +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Por exemplo, há um total de quatro predefinições que usam o dicionário 8\ MiB, cuja ordem do mais rápido ao mais lento é \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP e +\fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Esses são apelidos um tanto enganosos para \fB\-0\fP e \fB\-9\fP, +respectivamente. Eles são fornecidos apenas para compatibilidade com versões +anteriores do LZMA Utils. Evite usar essas opções. +.TP +\fB\-\-block\-size=\fP\fItamanho\fP +Ao compactar para o formato \fB.xz\fP, divida os dados de entrada em blocos de +\fItamanho\fP bytes. Os blocos são compactados independentemente uns dos +outros, o que ajuda no multi\-threading e torna possível a descompactação +limitada de acesso aleatório. Essa opção normalmente é usada para substituir +o tamanho de bloco padrão no modo multi\-thread, mas também pode ser usada em +thread única. +.IP "" +In multi\-threaded mode about three times \fIsize\fP bytes will be allocated in +each thread for buffering input and output. The default \fIsize\fP is three +times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a +good value is 2\(en4 times the size of the LZMA2 dictionary or at least 1 +MiB. Using \fIsize\fP less than the LZMA2 dictionary size is waste of RAM +because then the LZMA2 dictionary buffer will never get fully used. In +multi\-threaded mode, the sizes of the blocks are stored in the block +headers. This size information is required for multi\-threaded +decompression. +.IP "" +In single\-threaded mode no block splitting is done by default. Setting this +option doesn't affect memory usage. No size information is stored in block +headers, thus files created in single\-threaded mode won't be identical to +files created in multi\-threaded mode. The lack of size information also +means that \fBxz\fP won't be able decompress the files in multi\-threaded mode. +.TP +\fB\-\-block\-list=\fP\fIitems\fP +When compressing to the \fB.xz\fP format, start a new block with an optional +custom filter chain after the given intervals of uncompressed data. +.IP "" +The \fIitems\fP are a comma\-separated list. Each item consists of an optional +filter chain number between 0 and 9 followed by a colon (\fB:\fP) and a +required size of uncompressed data. Omitting an item (two or more +consecutive commas) is a shorthand to use the size and filters of the +previous item. +.IP "" +If the input file is bigger than the sum of the sizes in \fIitems\fP, the last +item is repeated until the end of the file. A special value of \fB0\fP may be +used as the last size to indicate that the rest of the file should be +encoded as a single block. +.IP "" +An alternative filter chain for each block can be specified in combination +with the \fB\-\-filters1=\fP\fIfilters\fP \&...\& \fB\-\-filters9=\fP\fIfilters\fP options. +These options define filter chains with an identifier between 1\(en9. +Filter chain 0 can be used to refer to the default filter chain, which is +the same as not specifying a filter chain. The filter chain identifier can +be used before the uncompressed size, followed by a colon (\fB:\fP). For +example, if one specifies \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP +then blocks will be created using: +.RS +.IP \(bu 3 +The filter chain specified by \fB\-\-filters1\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters3\fP and 2 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The filter chain specified by \fB\-\-filters2\fP and 4 MiB input +.IP \(bu 3 +The default filter chain and 2 MiB input +.IP \(bu 3 +The default filter chain and 4 MiB input for every block until end of input. +.RE +.IP "" +If one specifies a size that exceeds the encoder's block size (either the +default value in threaded mode or the value specified with +\fB\-\-block\-size=\fP\fIsize\fP), the encoder will create additional blocks while +keeping the boundaries specified in \fIitems\fP. For example, if one specifies +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP and the +input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10, and 1 MiB. +.IP "" +No modo multi\-thread, os tamanhos dos blocos são armazenados nos cabeçalhos +dos blocos. Isso não é feito no modo de thread única, portanto, a saída +codificada não será idêntica à do modo multi\-thread. +.TP +\fB\-\-flush\-timeout=\fP\fItempo_limite\fP +Ao compactar, se mais de \fItempo_limite\fP milissegundos (um número inteiro +positivo) se passaram desde a liberação anterior e a leitura de mais entrada +seria bloqueada, todos os dados de entrada pendentes serão liberados do +codificador e disponibilizados no fluxo de saída. Isso pode ser útil se +\fBxz\fP for usado para compactar dados transmitidos por uma rede. Valores +\fItempo_limite\fP pequenos tornam os dados disponíveis na extremidade +receptora com um pequeno atraso, mas valores \fItempo_limite\fP grandes +oferecem melhor taxa de compactação. +.IP "" +Esse recurso está desabilitado por padrão. Se esta opção for especificada +mais de uma vez, a última terá efeito. O valor especial \fItempo_limite\fP de +\fB0\fP pode ser usado para desabilitar explicitamente esse recurso. +.IP "" +Este recurso não está disponível em sistemas não\-POSIX. +.IP "" +.\" FIXME +\fBEste recurso ainda é experimental.\fP Atualmente, \fBxz\fP não é adequado para +descompactar o fluxo em tempo real devido à forma como \fBxz\fP faz o buffer. +.TP +\fB\-\-no\-sync\fP +Do not synchronize the target file and its directory to the storage device +before removing the source file. This can improve performance if +compressing or decompressing many small files. However, if the system +crashes soon after the deletion, it is possible that the target file was not +written to the storage device but the delete operation was. In that case +neither the original source file nor the target file is available. +.IP "" +This option has an effect only when \fBxz\fP is going to remove the source +file. In other cases synchronization is never done. +.IP "" +The synchronization and \fB\-\-no\-sync\fP were added in \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimite\fP +Define um limite de uso de memória para compactação. Se esta opção for +especificada várias vezes, a última entrará em vigor. +.IP "" +Se as configurações de compactação excederem o \fIlimite\fP, \fBxz\fP tentará +ajustar as configurações para baixo para que o limite não seja mais excedido +e exibirá um aviso de que o ajuste automático foi feito. Os ajustes são +feitos nesta ordem: reduzindo o número de encadeamentos, alternando para o +modo sigle\-thread se até mesmo uma thread no modo multi\-thread exceder o +\fIlimite\fP e, finalmente, reduzindo o tamanho do dicionário LZMA2. +.IP "" +Ao compactar com \fB\-\-format=raw\fP ou se \fB\-\-no\-adjust\fP tiver sido +especificado, apenas o número de threads pode ser reduzido, pois isso pode +ser feito sem afetar a saída compactada. +.IP "" +Se o \fIlimite\fP não puder ser alcançado mesmo com os ajustes descritos acima, +um erro será exibido e \fBxz\fP sairá com status de saída 1. +.IP "" +O \fIlimite\fP pode ser especificado de várias maneiras: +.RS +.IP \(bu 3 +O \fIlimite\fP pode ser um valor absoluto em bytes. Usar um sufixo inteiro como +\fBMiB\fP pode ser útil. Exemplo: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +O \fIlimite\fP pode ser especificado como uma porcentagem da memória física +total (RAM). Isso pode ser útil especialmente ao definir a variável de +ambiente \fBXZ_DEFAULTS\fP em um script de inicialização de shell que é +compartilhado entre diferentes computadores. Dessa forma o limite é +automaticamente maior em sistemas com mais memória. Exemplo: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +O \fIlimite\fP pode ser redefinido para seu valor padrão, definindo\-o como +\fB0\fP. Atualmente, isso equivale a definir \fIlimite\fP como \fBmax\fP (sem limite +de uso de memória). +.RE +.IP "" +Para \fBxz\fP de 32 bits, há um caso especial: se o \fIlimite\fP estiver acima de +\fB4020\ MiB\fP, o \fIlimite\fP é definido como \fB4020\ MiB\fP. No MIPS32 \fB2000\ MiB\fP é usado em seu lugar. (Os valores \fB0\fP e \fBmax\fP não são afetados por +isso. Um recurso semelhante não existe para descompactação.) Isso pode ser +útil quando um executável de 32 bits tem acesso a espaço de endereço de 4\ GiB (2 GiB no MIPS32) enquanto espero não causar danos em outras situações. +.IP "" +Consulte também a seção \fBUso de memória\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação. Isso também afeta o +modo \fB\-\-list\fP. Se a operação não for possível sem exceder o \fIlimite\fP, +\fBxz\fP exibirá um erro e a descompactação do arquivo falhará. Consulte +\fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de especificar o +\fIlimite\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP +Define um limite de uso de memória para descompactação multi\-thread. Isso +pode afetar apenas o número de threads; isso nunca fará com que \fBxz\fP se +recuse a descompactar um arquivo. Se \fIlimite\fP for muito baixo para permitir +qualquer multi\-thread, o \fIlimite\fP será ignorado e \fBxz\fP continuará no modo +de thread única. Observe que se \fB\-\-memlimit\-decompress\fP também for usado, +ele sempre se aplicará aos modos de thread única e multi\-thread e, portanto, +o \fIlimite\fP efetivo para multi\-threading nunca será maior que o limite +definido com \fB\-\-memlimit\-decompress\fP. +.IP "" +Em contraste com as outras opções de limite de uso de memória, +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP tem um padrão \fIlimite\fP específico do +sistema. \fBxz \-\-info\-memory\fP pode ser usado para ver o valor atual. +.IP "" +Esta opção e seu valor padrão existem porque, sem qualquer limite, o +descompactador usando threads pode acabar alocando uma quantidade insana de +memória com alguns arquivos de entrada. Se o \fIlimite\fP padrão for muito +baixo em seu sistema, sinta\-se à vontade para aumentar o \fIlimite\fP, mas +nunca defina\-o para um valor maior que a quantidade de RAM utilizável, pois +com os arquivos de entrada apropriados \fBxz\fP tentará usar essa quantidade de +memória mesmo com um baixo número de threads. Ficar sem memória ou trocar +não melhorará o desempenho da descompactação. +.IP "" +Consulte \fB\-\-memlimit\-compress=\fP\fIlimite\fP para possíveis maneiras de +especificar o \fIlimite\fP. Definir \fIlimite\fP como \fB0\fP redefine \fIlimite\fP para +o valor padrão específico do sistema. +.TP +\fB\-M\fP \fIlimite\fP, \fB\-\-memlimit=\fP\fIlimite\fP, \fB\-\-memory=\fP\fIlimite\fP +Isso é equivalente a especificar \fB\-\-memlimit\-compress=\fP\fIlimite\fP +\fB\-\-memlimit\-decompress=\fP\fIlimite\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIlimite\fP. +.TP +\fB\-\-no\-adjust\fP +Exibe um erro e saia se o limite de uso de memória não puder ser atendido +sem ajustar as configurações que afetam a saída compactada. Ou seja, isso +evita que \fBxz\fP alterne o codificador do modo multi\-thread para o modo +encadeado único e reduza o tamanho do dicionário LZMA2. Mesmo quando esta +opção é usada, o número de threads pode ser reduzido para atender ao limite +de uso de memória, pois isso não afetará a saída compactada. +.IP "" +O ajuste automático é sempre desativado ao criar fluxos brutos +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIthreads\fP, \fB\-\-threads=\fP\fIthreads\fP +Especifica o número de threads de trabalho a serem usados. Definir +\fIthreads\fP para um valor especial \fB0\fP faz com que \fBxz\fP use tantos threads +quanto o(s) processador(es) no suporte do sistema. O número real de +encadeamentos pode ser menor que \fIthreads\fP se o arquivo de entrada não for +grande o suficiente para subdividir em threads com as configurações +fornecidas ou se o uso de mais threads exceder o limite de uso de memória. +.IP "" +Os compactadores usando thread única e várias threads produzem saídas +diferentes. O compactador de thread única fornecerá o menor tamanho de +arquivo, mas apenas a saída do compactador de várias threads pode ser +descompactada usando várias threads. Definir \fIthreads\fP como \fB1\fP usará o +modo de thread única. Definir \fIthreads\fP para qualquer outro valor, +incluindo \fB0\fP, usará o compressor de várias threads, mesmo que o sistema +tenha suporte a apenas uma thread de hardware. (\fBxz\fP 5.2.x usou o modo de +thread única nesta situação.) +.IP "" +Para usar o modo de várias threads com apenas uma thread, defina \fIthreads\fP +como \fB+1\fP. O prefixo \fB+\fP não tem efeito com valores diferentes de \fB1\fP. Um +limite de uso de memória ainda pode fazer \fBxz\fP alternar para o modo de +thread única, a menos que \fB\-\-no\-adjust\fP seja usado. O suporte para o +prefixo \fB+\fP foi adicionado no \fBxz\fP 5.4.0. +.IP "" +Se um número automático de threads foi solicitado e nenhum limite de uso de +memória foi especificado, um limite flexível padrão específico do sistema +será usado para possivelmente limitar o número de threads. É um limite +flexível no sentido de que é ignorado se o número de threads se tornar um, +portanto, um limite flexível nunca impedirá \fBxz\fP de compactar ou +descompactar. Este limite flexível padrão não fará com que \fBxz\fP alterne do +modo de várias threads para o modo de thread única. Os limites ativos podem +ser vistos com \fBxz \-\-info\-memory\fP. +.IP "" +Atualmente, o único método de threading é dividir a entrada em blocos e +comprimi\-los independentemente um do outro. O tamanho padrão do bloco +depende do nível de compactação e pode ser substituído com a opção +\fB\-\-block\-size=\fP\fItamanho\fP. +.IP "" +A descompactação em threads funciona apenas em arquivos que contêm vários +blocos com informações de tamanho nos cabeçalhos dos blocos. Todos os +arquivos grandes o suficiente compactados no modo de várias thread atendem a +essa condição, mas os arquivos compactados no modo de thread única não +atendem, mesmo se \fB\-\-block\-size=\fP\fItamanho\fP tiver sido usado. +.IP "" +The default value for \fIthreads\fP is \fB0\fP. In \fBxz\fP 5.4.x and older the +default is \fB1\fP. +. +.SS "Cadeias de filtro de compressor personalizadas" +Uma cadeia de filtro personalizada permite especificar as configurações de +compactação em detalhes, em vez de confiar nas configurações associadas às +predefinições. Quando uma cadeia de filtro personalizada é especificada, as +opções predefinidas (\fB\-0\fP \&...\& \fB\-9\fP e \fB\-\-extreme\fP) anteriores na linha +de comando são esquecidas. Se uma opção predefinida for especificada após +uma ou mais opções de cadeia de filtros personalizados, a nova predefinição +entrará em vigor e as opções de cadeia de filtros personalizados +especificadas anteriormente serão esquecidas. +.PP +Uma cadeia de filtro é comparável à tubulação na linha de comando. Ao +compactar, a entrada descompactada vai para o primeiro filtro, cuja saída +vai para o próximo filtro (se houver). A saída do último filtro é gravada no +arquivo compactado. O número máximo de filtros na cadeia é quatro, mas +normalmente uma cadeia de filtros tem apenas um ou dois filtros. +.PP +Muitos filtros têm limitações sobre onde podem estar na cadeia de filtros: +alguns filtros podem funcionar apenas como o último filtro na cadeia, alguns +apenas como filtro não\-último e alguns funcionam em qualquer posição na +cadeia. Dependendo do filtro, essa limitação é inerente ao projeto do filtro +ou existe para evitar problemas de segurança. +.PP +A custom filter chain can be specified in two different ways. The options +\fB\-\-filters=\fP\fIfilters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP allow specifying an entire filter chain in one +option using the liblzma filter string syntax. Alternatively, a filter +chain can be specified by using one or more individual filter options in the +order they are wanted in the filter chain. That is, the order of the +individual filter options is significant! When decoding raw streams +(\fB\-\-format=raw\fP), the filter chain must be specified in the same order as +it was specified when compressing. Any individual filter or preset options +specified before the full chain option (\fB\-\-filters=\fP\fIfilters\fP) will be +forgotten. Individual filters specified after the full chain option will +reset the filter chain. +.PP +Both the full and individual filter options take filter\-specific \fIoptions\fP +as a comma\-separated list. Extra commas in \fIoptions\fP are ignored. Every +option has a default value, so specify those you want to change. +.PP +Para ver toda a cadeia de filtros e \fIopções\fP, use \fBxz \-vv\fP (isto é, use +\fB\-\-verbose\fP duas vezes). Isso também funciona para visualizar as opções da +cadeia de filtros usadas pelas predefinições. +.TP +\fB\-\-filters=\fP\fIfilters\fP +Specify the full filter chain or a preset in a single option. Each filter +can be separated by spaces or two dashes (\fB\-\-\fP). \fIfilters\fP may need to be +quoted on the shell command line so it is parsed as a single option. To +denote \fIoptions\fP, use \fB:\fP or \fB=\fP. A preset can be prefixed with a \fB\-\fP +and followed with zero or more flags. The only supported flag is \fBe\fP to +apply the same options as \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilters\fP ... \fB\-\-filters9\fP=\fIfilters\fP +Specify up to nine additional filter chains that can be used with +\fB\-\-block\-list\fP. +.IP "" +For example, when compressing an archive with executable files followed by +text files, the executable part could use a filter chain with a BCJ filter +and the text part only the LZMA2 filter. +.TP +\fB\-\-filters\-help\fP +Display a help message describing how to specify presets and custom filter +chains in the \fB\-\-filters\fP and \fB\-\-filters1=\fP\fIfilters\fP \&...\& +\fB\-\-filters9=\fP\fIfilters\fP options, and exit successfully. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona o filtro LZMA1 ou LZMA2 à cadeia de filtros. Esses filtros podem +ser usados apenas como o último filtro na cadeia. +.IP "" +LZMA1 é um filtro legado, que é suportado quase exclusivamente devido ao +formato de arquivo legado \fB.lzma\fP, que suporta apenas LZMA1. LZMA2 é uma +versão atualizada do LZMA1 para corrigir alguns problemas práticos do +LZMA1. O formato \fB.xz\fP usa LZMA2 e não suporta LZMA1. A velocidade de +compactação e as proporções de LZMA1 e LZMA2 são praticamente as mesmas. +.IP "" +LZMA1 e LZMA2 compartilham o mesmo conjunto de \fIopções\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIpredefinição\fP +Redefine todas as \fIopções\fP de LZMA1 ou LZMA2 para +\fIpredefinição\fP. \fIPredefinição\fP consiste em um número inteiro, que pode ser +seguido por modificadores de predefinição de uma única letra. O inteiro pode +ser de \fB0\fP a \fB9\fP, correspondendo às opções de linha de comando \fB\-0\fP +\&...\& \fB\-9\fP. O único modificador suportado atualmente é \fBe\fP, que +corresponde a \fB\-\-extreme\fP. Se nenhum \fBpreset\fP for especificado, os valores +padrão das \fIopções\fP LZMA1 ou LZMA2 serão obtidos da predefinição \fB6\fP. +.TP +\fBdict=\fP\fItamanho\fP +O \fItamanho\fP do dicionário (buffer de histórico) indica quantos bytes dos +dados não compactados processados recentemente são mantidos na memória. O +algoritmo tenta encontrar sequências de bytes repetidos (correspondências) +nos dados não compactados e substituí\-los por referências aos dados +atualmente no dicionário. Quanto maior o dicionário, maior a chance de +encontrar uma correspondência. Portanto, aumentar o dicionário \fItamanho\fP +geralmente melhora a taxa de compactação, mas um dicionário maior que o +arquivo não compactado é um desperdício de memória. +.IP "" +Um \fItamanho\fP de dicionário típico é de 64\ KiB a 64\ MiB. O mínimo é 4\ KiB. O máximo para compactação é atualmente 1,5\ GiB (1536\ MiB). O +descompactador já oferece suporte a dicionários de até um byte a menos de 4\ GiB, que é o máximo para os formatos de fluxo LZMA1 e LZMA2. +.IP "" +O \fItamanho\fP de dicionário e o localizador de correspondência (\fImf\fP) juntos +determinam o uso de memória do codificador LZMA1 ou LZMA2. O mesmo (ou +maior) \fItamanho\fP de dicionário é necessário para descompactar que foi usado +durante a compactação, portanto, o uso de memória do decodificador é +determinado pelo tamanho do dicionário usado durante a compactação. Os +cabeçalhos \fB.xz\fP armazenam o \fItamanho\fP de dicionário como 2^\fIn\fP ou 2^\fIn\fP ++ 2^(\fIn\fP\-1), então esses \fItamanhos\fP são um tanto preferidos para +compactação. Outros \fItamanhos\fP serão arredondados quando armazenados nos +cabeçalhos \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Especifica o número de bits de contexto literais. O mínimo é 0 e o máximo é +4; o padrão é 3. Além disso, a soma de \fIlc\fP e \fIlp\fP não deve exceder 4. +.IP "" +Todos os bytes que não podem ser codificados como correspondências são +codificados como literais. Ou seja, literais são simplesmente bytes de 8 +bits que são codificados um de cada vez. +.IP "" +A codificação literal assume que os bits \fIlc\fP mais altos do byte não +compactado anterior se correlacionam com o próximo byte. Por exemplo, em um +texto típico em inglês, uma letra maiúscula geralmente é seguida por uma +letra minúscula, e uma letra minúscula geralmente é seguida por outra letra +minúscula. No conjunto de caracteres US\-ASCII, os três bits mais altos são +010 para letras maiúsculas e 011 para letras minúsculas. Quando \fIlc\fP é pelo +menos 3, a codificação literal pode aproveitar essa propriedade nos dados +não compactados. +.IP "" +O valor padrão (3) geralmente é bom. Se você deseja compactação máxima, +experimente \fBlc=4\fP. Às vezes ajuda um pouco, às vezes piora a +compactação. Se piorar, experimente \fBlc=2\fP também. +.TP +\fBlp=\fP\fIlp\fP +Especifica o número de bits de posição literal. O mínimo é 0 e o máximo é 4; +o padrão é 0. +.IP "" +\fILp\fP afeta que tipo de alinhamento nos dados não compactados é assumido ao +codificar literais. Consulte \fIpb\fP abaixo para obter mais informações sobre +alinhamento. +.TP +\fBpb=\fP\fIpb\fP +Especifica o número de bits de posição. O mínimo é 0 e o máximo é 4; o +padrão é 2. +.IP "" +\fIPb\fP afeta que tipo de alinhamento nos dados não compactados é assumido em +geral. O padrão significa alinhamento de quatro bytes (2^\fIpb\fP=2^2=4), que +geralmente é uma boa escolha quando não há melhor estimativa. +.IP "" +Quando o alinhamento é conhecido, definir \fIpb\fP adequadamente pode reduzir +um pouco o tamanho do arquivo. Por exemplo, com arquivos de texto com +alinhamento de um byte (US\-ASCII, ISO\-8859\-*, UTF\-8), a configuração \fBpb=0\fP +pode melhorar um pouco a compactação. Para texto UTF\-16, \fBpb=1\fP é uma boa +escolha. Se o alinhamento for um número ímpar como 3 bytes, \fBpb=0\fP pode ser +a melhor escolha. +.IP "" +Embora o alinhamento assumido possa ser ajustado com \fIpb\fP e \fIlp\fP, LZMA1 e +LZMA2 ainda favorecem ligeiramente o alinhamento de 16 bytes. Pode valer a +pena levar em consideração ao projetar formatos de arquivo que provavelmente +serão compactados com LZMA1 ou LZMA2. +.TP +\fBmf=\fP\fImf\fP +O localizador de correspondência tem um efeito importante na velocidade do +codificador, uso de memória e taxa de compactação. Normalmente, os +localizadores de correspondência de Hash Chain são mais rápidos do que os +localizadores de correspondência de árvore binária. O padrão depende do +\fIpredefinição\fP: 0 usa \fBhc3\fP, 1\(en3 usa \fBhc4\fP e o resto usa \fBbt4\fP. +.IP "" +Os seguintes localizadores de correspondência são suportados. As fórmulas de +uso de memória abaixo são aproximações aproximadas, que estão mais próximas +da realidade quando \fIdict\fP é uma potência de dois. +.RS +.TP +\fBhc3\fP +Cadeia de hashs com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 5.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Cadeia de hashs com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 7.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 6.5 (if \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Árvore binária com hashing de 2 bytes +.br +Valor mínimo para \fInice\fP: 2 +.br +Uso de memória: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Árvore binária com hashing de 2 e 3 bytes +.br +Valor mínimo para \fInice\fP: 3 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 16 MiB); +.br +\fIdict\fP * 9.5 + 64 MiB (if \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Árvore binária com hashing de 2, 3 e 4 bytes +.br +Valor mínimo para \fInice\fP: 4 +.br +Uso de memória: +.br +\fIdict\fP * 11.5 (if \fIdict\fP <= 32 MiB); +.br +\fIdict\fP * 10.5 (if \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fImodo\fP +O \fImodo\fP de compactação especifica o método para analisar os dados +produzidos pelo localizador de correspondência. Os \fImodos\fP suportados são +\fBfast\fP e \fBnormal\fP. O padrão é \fBfast\fP para \fIpredefinições\fP 0\(en3 e +\fBnormal\fP para \fIpredefinições\fP 4\(en9. +.IP "" +Normalmente, \fBfast\fP é usado com localizadores de correspondência cadeia de +hashs e \fBnormal\fP com localizadores de correspondência de árvore +binária. Isso também é o que os \fIpredefinições\fP fazem. +.TP +\fBnice=\fP\fInice\fP +Especifica o que é considerado um bom comprimento para uma +correspondência. Uma vez que uma correspondência de pelo menos \fInice\fP bytes +é encontrada, o algoritmo para de procurar correspondências possivelmente +melhores. +.IP "" +\fINice\fP pode ser 2\(en273 bytes. Valores mais altos tendem a fornecer melhor +taxa de compactação em detrimento da velocidade. O padrão depende do +\fIpredefinição\fP. +.TP +\fBdepth=\fP\fIprofundidade\fP +Especifica a profundidade máxima de pesquisa no localizador de +correspondências. O padrão é o valor especial de 0, que faz com que o +compressor determine um \fIprofundidade\fP razoável de \fImf\fP e \fInice\fP. +.IP "" +Uma \fIprofundidade\fP razoável para cadeias de hash é 4\(en100 e 16\(en1000 +para árvores binárias. Usar valores muito altos para \fIprofundidade\fP pode +tornar o codificador extremamente lento com alguns arquivos. Evite definir +\fIprofundidade\fP acima de 1000 a menos que você esteja preparado para +interromper a compactação caso ela esteja demorando muito. +.RE +.IP "" +Ao decodificar fluxos brutos (\fB\-\-format=raw\fP), o LZMA2 precisa apenas do +dicionário \fItamanho\fP. LZMA1 também precisa de \fIlc\fP, \fIlp\fP e \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopções\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopções\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopções\fP] +.PD +Adiciona um filtro de ramificação/chamada/salto (BCJ) à cadeia de +filtros. Esses filtros podem ser usados apenas como um filtro não último na +cadeia de filtros. +.IP "" +Um filtro BCJ converte endereços relativos no código de máquina em suas +contrapartes absolutas. Isso não altera o tamanho dos dados, mas aumenta a +redundância, o que pode ajudar o LZMA2 a produzir um arquivo \fB.xz\fP 0\(en15\ % menor. Os filtros BCJ são sempre reversíveis, portanto, usar um filtro BCJ +para o tipo errado de dados não causa nenhuma perda de dados, embora possa +piorar um pouco a taxa de compactação.Os filtros BCJ são muito rápidos e +usam uma quantidade insignificante de memória. +.IP "" +Esses filtros BCJ têm problemas conhecidos relacionados à taxa de +compactação: +.RS +.IP \(bu 3 +Alguns tipos de arquivos contendo código executável (por exemplo, arquivos +de objeto, bibliotecas estáticas e módulos do kernel do Linux) têm os +endereços nas instruções preenchidos com valores de preenchimento. Esses +filtros BCJ ainda vão fazer a conversão de endereço, o que vai piorar a +compactação desses arquivos. +.IP \(bu 3 +Se um filtro BCJ for aplicado em um arquivo, é possível que isso torne a +taxa de compactação pior do que não usar um filtro BCJ. Por exemplo, se +houver executáveis semelhantes ou mesmo idênticos, a filtragem provavelmente +tornará os arquivos menos semelhantes e, portanto, a compactação será +pior. O conteúdo de arquivos não executáveis no mesmo arquivo também pode +ser importante. Na prática tem que tentar com e sem filtro BCJ para ver qual +é melhor em cada situação. +.RE +.IP "" +Conjuntos de instruções diferentes têm alinhamento diferente: o arquivo +executável deve ser alinhado a um múltiplo desse valor nos dados de entrada +para fazer o filtro funcionar. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtro;Alinhamento;Observações +x86;1;x86 32 bits ou 64 bits +ARM;4; +ARM\-Thumb;2; +ARM64;4;Alinhamento de 4096 bytes +;;é melhor +PowerPC;4;Somente big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Since the BCJ\-filtered data is usually compressed with LZMA2, the +compression ratio may be improved slightly if the LZMA2 options are set to +match the alignment of the selected BCJ filter. Examples: +.RS +.IP \(bu 3 +IA\-64 filter has 16\-byte alignment so \fBpb=4,lp=4,lc=0\fP is good with LZMA2 +(2^4=16). +.IP \(bu 3 +RISC\-V code has 2\-byte or 4\-byte alignment depending on whether the file +contains 16\-bit compressed instructions (the C extension). When 16\-bit +instructions are used, \fBpb=2,lp=1,lc=3\fP or \fBpb=1,lp=1,lc=3\fP is good. When +16\-bit instructions aren't present, \fBpb=2,lp=2,lc=2\fP is the best. +\fBreadelf \-h\fP can be used to check if "RVC" appears on the "Flags" line. +.IP \(bu 3 +ARM64 is always 4\-byte aligned so \fBpb=2,lp=2,lc=2\fP is the best. +.IP \(bu 3 +The x86 filter is an exception. It's usually good to stick to LZMA2's +defaults (\fBpb=2,lp=0,lc=3\fP) when compressing x86 executables. +.RE +.IP "" +Todos os filtros BCJ suportam as mesmas \fIopções\fP: +.RS +.TP +\fBstart=\fP\fIdeslocamento\fP +Especifica o \fIdeslocamento\fP inicial que é usado na conversão entre +endereços relativos e absolutos. O \fIdeslocamento\fP deve ser um múltiplo do +alinhamento do filtro (ver tabela acima). O padrão é zero. Na prática, o +padrão é bom; especificar um \fIdeslocamento\fP personalizado quase nunca é +útil. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopções\fP] +Adiciona o filtro Delta à cadeia de filtros. O filtro Delta só pode ser +usado como filtro não\-último na cadeia de filtros. +.IP "" +Atualmente, apenas o cálculo simples de delta byte a byte é suportado. Pode +ser útil ao compactar, por exemplo, imagens bitmap não compactadas ou áudio +PCM não compactado. No entanto, algoritmos de propósito especial podem +fornecer resultados significativamente melhores do que Delta + LZMA2. Isso é +verdade especialmente com áudio, que compacta mais rápido e melhor, por +exemplo, com \fBflac\fP(1). +.IP "" +\fIOpções\fP suportadas: +.RS +.TP +\fBdist=\fP\fIdistância\fP +Especifica a \fIdistância\fP do cálculo delta em bytes. \fIdistância\fP deve ser +1\(en256. O padrão é 1. +.IP "" +Por exemplo, com \fBdist=2\fP e entrada de oito bytes A1 B1 A2 B3 A3 B5 A4 B7, +a saída será A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Outras opções" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprime avisos e avisos. Especifique isso duas vezes para suprimir erros +também. Esta opção não tem efeito no status de saída. Ou seja, mesmo que um +aviso tenha sido suprimido, o status de saída para indicar um aviso ainda é +usado. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Ser detalhado. Se o erro padrão estiver conectado a um terminal, \fBxz\fP +exibirá um indicador de progresso. Especifique \fB\-\-verbose\fP duas vezes dará +uma saída ainda mais detalhada. +.IP "" +O indicador de progresso mostra as seguintes informações: +.RS +.IP \(bu 3 +A porcentagem de conclusão é mostrada se o tamanho do arquivo de entrada for +conhecido. Ou seja, a porcentagem não pode ser mostrada em encadeamentos +(pipe). +.IP \(bu 3 +Quantidade de dados compactados produzidos (compactando) ou consumidos +(descompactando). +.IP \(bu 3 +Quantidade de dados não compactados consumidos (compactação) ou produzidos +(descompactação). +.IP \(bu 3 +Taxa de compactação, que é calculada dividindo a quantidade de dados +compactados processados até o momento pela quantidade de dados não +compactados processados até o momento. +.IP \(bu 3 +Velocidade de compactação ou descompactação. Isso é medido como a quantidade +de dados não compactados consumidos (compactação) ou produzidos +(descompactação) por segundo. É mostrado após alguns segundos desde que +\fBxz\fP começou a processar o arquivo. +.IP \(bu 3 +Tempo decorrido no formato M:SS ou H:MM:SS. +.IP \(bu 3 +O tempo restante estimado é mostrado apenas quando o tamanho do arquivo de +entrada é conhecido e alguns segundos já se passaram desde que \fBxz\fP começou +a processar o arquivo. A hora é mostrada em um formato menos preciso que +nunca tem dois pontos, por exemplo, 2 min 30 s. +.RE +.IP "" +Quando o erro padrão não é um terminal, \fB\-\-verbose\fP fará com que \fBxz\fP +imprima o nome do arquivo, tamanho compactado, tamanho não compactado, taxa +de compactação e possivelmente também a velocidade e o tempo decorrido em +uma única linha para o erro padrão após a compactação ou descompactando o +arquivo. A velocidade e o tempo decorrido são incluídos apenas quando a +operação leva pelo menos alguns segundos. Se a operação não foi concluída, +por exemplo, devido à interrupção do usuário, também é impressa a +porcentagem de conclusão se o tamanho do arquivo de entrada for conhecido. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Não define o status de saída como 2, mesmo que uma condição digna de um +aviso tenha sido detectada. Esta opção não afeta o nível de detalhamento, +portanto, tanto \fB\-\-quiet\fP quanto \fB\-\-no\-warn\fP devem ser usados para não +exibir avisos e não alterar o status de saída. +.TP +\fB\-\-robot\fP +Imprime mensagens em um formato analisável por máquina. Isso visa facilitar +a criação de frontends que desejam usar \fBxz\fP em vez de liblzma, o que pode +ser o caso de vários scripts. A saída com esta opção habilitada deve ser +estável em versões \fBxz\fP. Consulte a seção \fBMODO ROBÔ\fP para obter detalhes. +.TP +\fB\-\-info\-memory\fP +Exibe, em formato legível por humanos, quanta memória física (RAM) e quantos +threads de processador \fBxz\fP acredita que o sistema possui e os limites de +uso de memória para compactação e descompactação e saia com êxito. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda descrevendo as opções mais usadas e sai com +sucesso. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Exibe uma mensagem de ajuda descrevendo todos os recursos de \fBxz\fP e sai com +sucesso +.TP +\fB\-V\fP, \fB\-\-version\fP +Exibe o número da versão de \fBxz\fP e liblzma em formato legível por +humanos. Para obter uma saída analisável por máquina, especifique \fB\-\-robot\fP +antes de \fB\-\-version\fP. +. +.SH "MODO ROBÔ" +The robot mode is activated with the \fB\-\-robot\fP option. It makes the output +of \fBxz\fP easier to parse by other programs. Currently \fB\-\-robot\fP is +supported only together with \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, +and \fB\-\-version\fP. It will be supported for compression and decompression in +the future. +. +.SS "Modo lista" +\fBxz \-\-robot \-\-list\fP usa saída separada por tabulações. A primeira coluna de +cada linha possui uma string que indica o tipo de informação encontrada +naquela linha: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Esta é sempre a primeira linha ao começar a listar um arquivo. A segunda +coluna na linha é o nome do arquivo. +.TP +\fBfile\fP +Esta linha contém informações gerais sobre o arquivo \fB.xz\fP. Esta linha é +sempre impressa após a linha \fBname\fP. +.TP +\fBstream\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas de \fBstream\fP quanto fluxos no arquivo +\&\fB.xz\fP. +.TP +\fBblock\fP +Este tipo de linha é usado somente quando \fB\-\-verbose\fP foi +especificado. Existem tantas linhas \fBblock\fP quanto blocos no arquivo +\&\fB.xz\fP. As linhas \fBblock\fP são mostradas após todas as linhas \fBstream\fP; +diferentes tipos de linha não são intercalados. +.TP +\fBsummary\fP +Este tipo de linha é usado apenas quando \fB\-\-verbose\fP foi especificado duas +vezes. Esta linha é impressa após todas as linhas de \fBblock\fP. Assim como a +linha \fBarquivo\fP, a linha \fBsummary\fP contém informações gerais sobre o +arquivo \fB.xz\fP. +.TP +\fBtotals\fP +Esta linha é sempre a última linha da saída da lista. Ele mostra as +contagens totais e tamanhos. +.PP +As colunas das linhas \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos no arquivo +.IP 3. 4 +Número total de blocos no(s) fluxo(s) +.IP 4. 4 +Tamanho compactado do arquivo +.IP 5. 4 +Uncompressed size of the file +.IP 6. 4 +Taxa de compactação, por exemplo, \fB0.123\fP. Se a proporção for superior a +9.999, serão exibidos três traços (\fB\-\-\-\fP) em vez da proporção. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista separada por vírgulas de nomes de verificação de integridade. As +seguintes strings são usadas para os tipos de verificação conhecidos: +\fBNone\fP, \fBCRC32\fP, \fBCRC64\fP e \fBSHA\-256\fP. Para tipos de verificações +desconhecidos, \fBUnknown\-\fP\fIN\fP é usado, onde \fIN\fP é o ID do cheque como um +número decimal (um ou dois dígitos). +.IP 8. 4 +Tamanho total do preenchimento de fluxo no arquivo +.RE +.PD +.PP +As colunas das linhas \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo (o primeiro fluxo é 1) +.IP 3. 4 +Número de blocos no fluxo +.IP 4. 4 +Deslocamento inicial compactado +.IP 5. 4 +Deslocamento inicial descompactado +.IP 6. 4 +Tamanho compactado (não inclui preenchimento de fluxo) +.IP 7. 4 +Tamanho descompactado +.IP 8. 4 +Taxa de compactação +.IP 9. 4 +Nome da verificação de integridade +.IP 10. 4 +Tamanho do preenchimento do fluxo +.RE +.PD +.PP +As colunas das linhas \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Número do fluxo que contém este bloco +.IP 3. 4 +Número do bloco relativo ao início do fluxo (o primeiro bloco é 1) +.IP 4. 4 +Número do bloco relativo ao início do arquivo +.IP 5. 4 +Deslocamento inicial compactado em relação ao início do arquivo +.IP 6. 4 +Deslocamento inicial descompactado em relação ao início do arquivo +.IP 7. 4 +Tamanho total compactado do bloco (inclui cabeçalhos) +.IP 8. 4 +Tamanho descompactado +.IP 9. 4 +Taxa de compactação +.IP 10. 4 +Nome da verificação de integridade +.RE +.PD +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas nas linhas \fBblock\fP. Eles não são exibidos com um único +\fB\-\-verbose\fP, porque obter essas informações requer muitas buscas e, +portanto, pode ser lento: +.PD 0 +.RS +.IP 11. 4 +Valor da verificação de integridade em hexadecimal +.IP 12. 4 +Tamanho do cabeçalho do bloco +.IP 13. 4 +Sinalizadores de bloco: \fBc\fP indica que o tamanho compactado está presente e +\fBu\fP indica que o tamanho não compactado está presente. Se o sinalizador não +estiver definido, um traço (\fB\-\fP) será exibido para manter o comprimento da +string fixo. Novos sinalizadores podem ser adicionados ao final da string no +futuro. +.IP 14. 4 +Tamanho dos dados reais compactados no bloco (isso exclui o cabeçalho do +bloco, o preenchimento do bloco e os campos de verificação) +.IP 15. 4 +Quantidade de memória (em bytes) necessária para descompactar este bloco com +esta versão \fBxz\fP +.IP 16. 4 +Cadeia de filtro. Observe que a maioria das opções usadas no momento da +compactação não pode ser conhecida, pois apenas as opções necessárias para a +descompactação são armazenadas nos cabeçalhos \fB.xz\fP. +.RE +.PD +.PP +As colunas das linhas \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Quantidade de memória (em bytes) necessária para descompactar este arquivo +com esta versão do \fBxz\fP +.IP 3. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +As colunas da linha \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Número de fluxos +.IP 3. 4 +Número de blocos +.IP 4. 4 +Tamanho compactado +.IP 5. 4 +Tamanho descompactado +.IP 6. 4 +Taxa de compactação média +.IP 7. 4 +Lista separada por vírgulas de nomes de verificação de integridade que +estavam presentes nos arquivos +.IP 8. 4 +Tamanho do preenchimento do fluxo +.IP 9. 4 +Número de arquivos. Isso está aqui para manter a ordem das colunas +anteriores a mesma das linhas \fBfile\fP. +.PD +.RE +.PP +Se \fB\-\-verbose\fP for especificado duas vezes, colunas adicionais serão +incluídas na linha \fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Quantidade máxima de memória (em bytes) necessária para descompactar os +arquivos com esta versão do \fBxz\fP +.IP 11. 4 +\fByes\fP ou \fBno\fP indicando se todos os cabeçalhos de bloco têm tamanho +compactado e tamanho não compactado armazenados neles +.PP +\fIDesde\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versão mínima do \fBxz\fP necessária para descompactar o arquivo +.RE +.PD +.PP +Versões futuras podem adicionar novos tipos de linha e novas colunas podem +ser adicionadas aos tipos de linha existentes, mas as colunas existentes não +serão alteradas. +. +.SS "Filters help" +\fBxz \-\-robot \-\-filters\-help\fP prints the supported filters in the following +format: +.PP +\fIfilter\fP\fB:\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>,\fP\fIoption\fP\fB=<\fP\fIvalue\fP\fB>\fP... +.TP +\fIfilter\fP +Name of the filter +.TP +\fIoption\fP +Name of a filter specific option +.TP +\fIvalue\fP +Numeric \fIvalue\fP ranges appear as \fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. String +\fIvalue\fP choices are shown within \fB< >\fP and separated by a \fB|\fP +character. +.PP +Each filter is printed on its own line. +. +.SS "Informações de limite de memória" +\fBxz \-\-robot \-\-info\-memory\fP prints a single line with multiple tab\-separated +columns: +.IP 1. 4 +Quantidade total de memória física (RAM) em bytes. +.IP 2. 4 +Limite de uso de memória para compactação em bytes +(\fB\-\-memlimit\-compress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 3. 4 +Limite de uso de memória para descompactação em bytes +(\fB\-\-memlimit\-decompress\fP). Um valor especial de \fB0\fP indica a configuração +padrão que para o modo de thread única é o mesmo que sem limite. +.IP 4. 4 +Desde \fBxz\fP 5.3.4alpha: Uso de memória para descompactação com várias thread +em bytes (\fB\-\-memlimit\-mt\-decompress\fP). Isso nunca é zero porque um valor +padrão específico do sistema mostrado na coluna 5 é usado se nenhum limite +for especificado explicitamente. Isso também nunca é maior que o valor na +coluna 3, mesmo que um valor maior tenha sido especificado com +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Desde \fBxz\fP 5.3.4alpha: Um limite de uso de memória padrão específico do +sistema que é usado para limitar o número de threads ao compactar com um +número automático de threads (\fB\-\-threads=0\fP) e nenhum limite de uso de +memória foi especificado (\fB\-\-memlimit\-compress\fP). Isso também é usado como +o valor padrão para \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Desde \fBxz\fP 5.3.4alpha: Número de threads de processador disponíveis. +.PP +No futuro, a saída de \fBxz \-\-robot \-\-info\-memory\fP pode ter mais colunas, mas +nunca mais do que uma única linha. +. +.SS Versão +\fBxz \-\-robot \-\-version\fP prints the version number of \fBxz\fP and liblzma in +the following format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versão principal. +.TP +\fIYYY\fP +Versão menor. Números pares são estáveis. Os números ímpares são versões +alfa ou beta. +.TP +\fIZZZ\fP +Nível de patch para versões estáveis ou apenas um contador para versões de +desenvolvimento. +.TP +\fIS\fP +Estabilidade. 0 é alfa, 1 é beta e 2 é estável. \fIS\fP deve ser sempre 2 +quando \fIYYY\fP for par. +.PP +\fIXYYYZZZS\fP são iguais em ambas as linhas se \fBxz\fP e liblzma forem da mesma +versão do XZ Utils. +.PP +Exemplos: 4.999.9beta é \fB49990091\fP e 5.0.0 é \fB50000002\fP. +. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Está tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.TP +\fB2\fP +Algo digno de um aviso ocorreu, mas ocorreu nenhum erro real. +.PP +Observações (não avisos ou erros) impressas no erro padrão não afetam o +status de saída. +. +.SH AMBIENTE +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analisa listas de opções separadas por espaços das variáveis de +ambiente \fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP, nesta ordem, antes de analisar as +opções da linha de comando. Observe que apenas as opções são analisadas a +partir das variáveis de ambiente; todas as não opções são silenciosamente +ignoradas. A análise é feita com \fBgetopt_long\fP(3) que também é usado para +os argumentos da linha de comando. +.PP +\fBWarning:\fP By setting these environment variables, one is effectively +modifying programs and scripts that run \fBxz\fP. Most of the time it is safe +to set memory usage limits, number of threads, and compression options via +the environment variables. However, some options can break scripts. An +obvious example is \fB\-\-help\fP which makes \fBxz\fP show the help text instead of +compressing or decompressing a file. More subtle examples are \fB\-\-quiet\fP +and \fB\-\-verbose\fP. In many cases it works well to enable the progress +indicator using \fB\-\-verbose\fP, but in some situations the extra messages +create problems. The verbosity level also affects the behavior of +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +User\-specific or system\-wide default options. Typically this is set in a +shell initialization script to enable \fBxz\fP's memory usage limiter by +default or set the default number of threads. Excluding shell +initialization scripts and similar special cases, scripts should never set +or unset \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Isso é para passar opções para \fBxz\fP quando não é possível definir as opções +diretamente na linha de comando \fBxz\fP. Este é o caso quando \fBxz\fP é +executado por um script ou ferramenta, por exemplo, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Os scripts podem usar \fBXZ_OPT\fP, por exemplo, para definir opções de +compactação padrão específicas do script. Ainda é recomendável permitir que +os usuários substituam \fBXZ_OPT\fP se isso for razoável. Por exemplo, em +scripts \fBsh\fP(1) pode\-se usar algo assim: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILIDADE COM LZMA UTILS" +A sintaxe da linha de comando do \fBxz\fP é praticamente um superconjunto de +\fBlzma\fP, \fBunlzma\fP e \fBlzcat\fP conforme encontrado no LZMA Utils 4.32.x. Na +maioria dos casos, é possível substituir LZMA Utils por XZ Utils sem +interromper os scripts existentes. Existem algumas incompatibilidades, +porém, que às vezes podem causar problemas. +. +.SS "Níveis de predefinição de compactação" +A numeração das predefinições de nível de compactação não é idêntica em +\fBxz\fP e LZMA Utils. A diferença mais importante é como os tamanhos dos +dicionários são mapeados para diferentes predefinições. O tamanho do +dicionário é aproximadamente igual ao uso de memória do descompactador. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils +\-0;256 KiB;N/D +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +As diferenças de tamanho do dicionário também afetam o uso da memória do +compressor, mas existem algumas outras diferenças entre LZMA Utils e XZ +Utils, que tornam a diferença ainda maior: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nível;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/D +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +O nível de predefinição padrão no LZMA Utils é \fB\-7\fP enquanto no XZ Utils é +\fB\-6\fP, então ambos usam um dicionário de 8 MiB por padrão. +. +.SS "Arquivos .lzma em um fluxo versus sem ser em um fluxo" +O tamanho descompactado do arquivo pode ser armazenado no cabeçalho de +\&\fB.lzma\fP. O LZMA Utils faz isso ao compactar arquivos comuns. A alternativa +é marcar que o tamanho não compactado é desconhecido e usar o marcador de +fim de carga útil para indicar onde o descompactador deve parar. O LZMA +Utils usa este método quando o tamanho não compactado não é conhecido, como +é o caso, por exemplo, de encadeamentos (pipes). +.PP +\fBxz\fP oferece suporte à descompactação de arquivos \fB.lzma\fP com ou sem +marcador de fim de carga útil, mas todos os arquivos \fB.lzma\fP criados por +\fBxz\fP usarão marcador de fim de carga útil e terão o tamanho descompactado +marcado como desconhecido no cabeçalho de \fB.lzma\fP. Isso pode ser um +problema em algumas situações incomuns. Por exemplo, um descompactador de +\&\fB.lzma\fP em um dispositivo embarcado pode funcionar apenas com arquivos que +tenham tamanho descompactado conhecido. Se você encontrar esse problema, +precisará usar o LZMA Utils ou o LZMA SDK para criar arquivos \fB.lzma\fP com +tamanho descompactado conhecido. +. +.SS "Arquivos .lzma não suportados" +O formato \fB.lzma\fP permite valores \fIlc\fP até 8 e valores \fIlp\fP até 4. LZMA +Utils pode descompactar arquivos com qualquer \fIlc\fP e \fIlp\fP, mas sempre cria +arquivos com \fBlc=3\fP e \fBlp=0\fP. Criar arquivos com outros \fIlc\fP e \fIlp\fP é +possível com \fBxz\fP e com LZMA SDK. +.PP +A implementação do filtro LZMA1 em liblzma requer que a soma de \fIlc\fP e +\fIlp\fP não exceda 4. Assim, arquivos \fB.lzma\fP, que excedam esta limitação, +não podem ser descompactados com \fBxz\fP. +.PP +LZMA Utils cria apenas arquivos \fB.lzma\fP que possuem um tamanho de +dicionário de 2^\fIn\fP (uma potência de 2), mas aceita arquivos com qualquer +tamanho de dicionário. liblzma aceita apenas arquivos \fB.lzma\fP que tenham um +tamanho de dicionário de 2^\fIn\fP ou 2^\fIn\fP + 2^(\fIn\fP\-1). Isso é para diminuir +os falsos positivos ao detectar arquivos \fB.lzma\fP. +.PP +Essas limitações não devem ser um problema na prática, já que praticamente +todos os arquivos \fB.lzma\fP foram compactados com configurações que o liblzma +aceitará. +. +.SS "Lixo à direita" +Ao descompactar, o LZMA Utils silenciosamente ignora tudo após o primeiro +fluxo \fB.lzma\fP. Na maioria das situações, isso é um bug. Isso também +significa que o LZMA Utils não oferece suporte a descompactação de arquivos +\&\fB.lzma\fP concatenados. +.PP +Se houver dados restantes após o primeiro fluxo de \fB.lzma\fP, \fBxz\fP considera +o arquivo corrompido, a menos que \fB\-\-single\-stream\fP tenha sido usado. Isso +pode quebrar scripts obscuros que presumiram que o lixo à direita é +ignorado. +. +.SH NOTAS +. +.SS "A saída compactada pode variar" +A saída compactada exata produzida a partir do mesmo arquivo de entrada não +compactado pode variar entre as versões do XZ Utils, mesmo se as opções de +compactação forem idênticas. Isso ocorre porque o codificador pode ser +aprimorado (compactação mais rápida ou melhor) sem afetar o formato do +arquivo. A saída pode variar mesmo entre diferentes compilações da mesma +versão do XZ Utils, se diferentes opções de compilação forem usadas. +.PP +A informação acima significa que, uma vez que \fB\-\-rsyncable\fP tenha sido +implementado, os arquivos resultantes não serão necessariamente +"rsyncáveis", a menos que os arquivos antigos e novos tenham sido +compactados com a mesma versão xz. Esse problema pode ser corrigido se uma +parte da implementação do codificador for congelada para manter a saída de +rsyncable estável nas versões do xz. +. +.SS "Descompactadores .xz embarcados" +As implementações do descompactador \fB.xz\fP embarcados, como o XZ Embedded, +não oferecem necessariamente suporte a arquivos criados com tipos de +\fIverificações\fP de integridade diferentes de \fBnone\fP e \fBcrc32\fP. Como o +padrão é \fB\-\-check=crc64\fP, você deve usar \fB\-\-check=none\fP ou +\fB\-\-check=crc32\fP ao criar arquivos para sistemas embarcados. +.PP +Fora dos sistemas embarcados, todos os descompactadores de formato \fB.xz\fP +oferecem suporte a todos os tipos de \fIverificação\fP ou, pelo menos, são +capazes de descompactar o arquivo sem verificar a verificação de integridade +se a \fIverificação\fP específica não for suportada. +.PP +XZ Embedded oferece suporte a filtros BCJ, mas apenas com o deslocamento +inicial padrão. +. +.SH EXEMPLOS +. +.SS Básico +Compactar o arquivo \fIfoo\fP em \fIfoo.xz\fP usando o nível de compactação padrão +(\fB\-6\fP) e remover \fIfoo\fP se a compactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Descompactar \fIbar.xz\fP em \fIbar\fP e não remover \fIbar.xz\fP mesmo se a +descompactação for bem\-sucedida: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Criar \fIbaz.tar.xz\fP com a predefinição \fB\-4e\fP (\fB\-4 \-\-extreme\fP), que é mais +lenta que o padrão \fB\-6\fP, mas precisa de menos memória para compactação e +descompactação (48 \ MiB e 5\ MiB, respectivamente): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Uma mistura de arquivos compactados e descompactados pode ser descompactada +para a saída padrão com um único comando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Compactação paralela de muitos arquivos" +No GNU e *BSD, \fBfind\fP(1) e \fBxargs\fP(1) podem ser usados para paralelizar a +compactação de muitos arquivos: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +A opção \fB\-P\fP para \fBxargs\fP(1) define o número de processos paralelos do +\fBxz\fP. O melhor valor para a opção \fB\-n\fP depende de quantos arquivos devem +ser compactados. Se houver apenas alguns arquivos, o valor provavelmente +deve ser 1; com dezenas de milhares de arquivos, 100 ou até mais podem ser +apropriados para reduzir o número de processos de \fBxz\fP que \fBxargs\fP(1) +eventualmente criará. +.PP +A opção \fB\-T1\fP para \fBxz\fP existe para forçá\-lo ao modo de thread única, +porque \fBxargs\fP(1) é usado para controlar a quantidade de paralelização. +. +.SS "Modo robô" +Calcular quantos bytes foram salvos no total depois de compactar vários +arquivos: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Um script pode querer saber que está usando \fBxz\fP novo o suficiente. O +seguinte script \fBsh\fP(1) verifica se o número da versão da ferramenta \fBxz\fP +é pelo menos 5.0.0. Este método é compatível com versões beta antigas, que +não suportavam a opção \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Definir um limite de uso de memória para descompactação usando \fBXZ_OPT\fP, +mas se um limite já tiver sido definido, não o aumentar: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Cadeias de filtro de compressor personalizadas" +O uso mais simples para cadeias de filtro personalizadas é personalizar uma +predefinição LZMA2. Isso pode ser útil, porque as predefinições abrangem +apenas um subconjunto das combinações potencialmente úteis de configurações +de compactação. +.PP +As colunas CompCPU das tabelas das descrições das opções \fB\-0\fP ... \fB\-9\fP e +\fB\-\-extreme\fP são úteis ao personalizar as predefinições LZMA2. Aqui estão as +partes relevantes coletadas dessas duas tabelas: +.RS +.PP +.TS +tab(;); +c c +n n. +Predefinição;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Se você sabe que um arquivo requer um dicionário um tanto grande (por +exemplo, 32\ MiB) para compactar bem, mas deseja comprimi\-lo mais +rapidamente do que \fBxz \-8\fP faria, uma predefinição com um valor CompCPU +baixo (por exemplo, 1) pode ser modificado para usar um dicionário maior: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Com certos arquivos, o comando acima pode ser mais rápido que \fBxz \-6\fP +enquanto compacta significativamente melhor. No entanto, deve\-se enfatizar +que apenas alguns arquivos se beneficiam de um grande dicionário, mantendo o +valor CompCPU baixo. A situação mais óbvia, onde um grande dicionário pode +ajudar muito, é um arquivo contendo arquivos muito semelhantes de pelo menos +alguns megabytes cada. O tamanho do dicionário deve ser significativamente +maior do que qualquer arquivo individual para permitir que o LZMA2 aproveite +ao máximo as semelhanças entre arquivos consecutivos. +.PP +Se o uso muito alto de memória do compactador e do descompactador for bom e +o arquivo que está sendo compactado tiver pelo menos várias centenas de +megabytes, pode ser útil usar um dicionário ainda maior do que os 64 MiB que +o \fBxz \-9\fP usaria: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Usar \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) como no exemplo acima pode ser útil +para ver os requisitos de memória do compactador e do +descompactador. Lembre\-se que usar um dicionário maior que o tamanho do +arquivo descompactado é desperdício de memória, então o comando acima não é +útil para arquivos pequenos. +.PP +Às vezes, o tempo de compactação não importa, mas o uso de memória do +descompactador deve ser mantido baixo, por exemplo, para possibilitar a +descompactação do arquivo em um sistema embarcado. O comando a seguir usa +\fB\-6e\fP (\fB\-6 \-\-extreme\fP) como base e define o dicionário como apenas 64\ KiB. O arquivo resultante pode ser descompactado com XZ Embedded (é por isso +que existe \fB\-\-check=crc32\fP) usando cerca de 100\ KiB de memória. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Se você deseja espremer o máximo de bytes possível, ajustar o número de bits +de contexto literal (\fIlc\fP) e o número de bits de posição (\fIpb\fP) às vezes +pode ajudar. Ajustar o número de bits de posição literal (\fIlp\fP) também pode +ajudar, mas geralmente \fIlc\fP e \fIpb\fP são mais importantes. Por exemplo, um +arquivo de código\-fonte contém principalmente texto US\-ASCII, então algo +como o seguinte pode fornecer um arquivo ligeiramente (como 0,1\ %) menor +que \fBxz \-6e\fP (tente também sem \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +O uso de outro filtro junto com o LZMA2 pode melhorar a compactação com +determinados tipos de arquivo. Por exemplo, para compactar uma biblioteca +compartilhada x86\-32 ou x86\-64 usando o filtro x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Observe que a ordem das opções de filtro é significativa. Se \fB\-\-x86\fP for +especificado após \fB\-\-lzma2\fP, \fBxz\fP dará um erro, porque não pode haver +nenhum filtro após LZMA2 e também porque o filtro x86 BCJ não pode ser usado +como o último filtro em a corrente. +.PP +O filtro Delta junto com LZMA2 pode dar bons resultados com imagens +bitmap. Ele geralmente deve superar o PNG, que possui alguns filtros mais +avançados do que o delta simples, mas usa Deflate para a compactação real. +.PP +A imagem deve ser salva em formato não compactado, por exemplo, como TIFF +não compactado. O parâmetro de distância do filtro Delta é definido para +corresponder ao número de bytes por pixel na imagem. Por exemplo, bitmap RGB +de 24 bits precisa de \fBdist=3\fP, e também é bom passar \fBpb=0\fP para LZMA2 +para acomodar o alinhamento de três bytes: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Se várias imagens foram colocadas em um único arquivo (por exemplo, +\&\fB.tar\fP), o filtro Delta também funcionará, desde que todas as imagens +tenham o mesmo número de bytes por pixel. +. +.SH "VEJA TAMBÉM" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/pt_BR/man1/xzdec.1 b/miniconda3/share/man/pt_BR/man1/xzdec.1 new file mode 100644 index 0000000000000000000000000000000000000000..996139d902e42586500e065920dcaa01e8630344 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/xzdec.1 @@ -0,0 +1,87 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 2024\-04\-08 Tukaani "XZ Utils" +.SH NOME +xzdec, lzmadec \- Pequenos descompactadores .xz e .lzma +.SH SINOPSE +\fBxzdec\fP [\fIopção...\fP] [\fIarquivo...\fP] +.br +\fBlzmadec\fP [\fIopção...\fP] [\fIarquivo...\fP] +.SH DESCRIÇÃO +\fBxzdec\fP é uma ferramenta de descompactação baseada em liblzma somente para +arquivos \fB.xz\fP (e somente \fB.xz\fP). \fBxzdec\fP destina\-se a funcionar como um +substituto para \fBxz\fP(1) nas situações mais comuns em que um script foi +escrito para usar \fBxz \-\-decompress \-\-stdout\fP (e possivelmente alguns outras +opções comumente usadas) para descompactar arquivos \fB.xz\fP. \fBlzmadec\fP é +idêntico a \fBxzdec\fP exceto que \fBlzmadec\fP tem suporte a arquivos \fB.lzma\fP em +vez de arquivos \fB.xz\fP. +.PP +Para reduzir o tamanho do executável, \fBxzdec\fP não tem suporte ao uso de +várias threads ou a localização, e não lê opções de variáveis de ambiente +\fBXZ_DEFAULTS\fP e \fBXZ_OPT\fP. \fBxzdec\fP não tem suporte à exibição de +informações de progresso intermediárias: enviar \fBSIGINFO\fP para \fBxzdec\fP não +faz nada, mas enviar \fBSIGUSR1\fP encerra o processo em vez de exibir +informações de progresso. +.SH OPÇÕES +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP tem suporte a apenas +descompactação. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP nunca cria ou remove +quaisquer arquivos. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP sempre grava os dados +descompactados para a saída padrão. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Especificar isso uma vez não faz nada, pois \fBxzdec\fP nunca exibe nenhum +aviso ou notificação. Especifique isso duas vezes para suprimir erros. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignorada para compatibilidade \fBxz\fP(1). \fBxzdec\fP nunca usa o status de saída +2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Exibe uma mensagem de ajuda e sai com sucesso. +.TP +\fB\-V\fP, \fB\-\-version\fP +Mostra o número da versão do \fBxzdec\fP e liblzma. +.SH "STATUS DE SAÍDA" +.TP +\fB0\fP +Correu tudo bem. +.TP +\fB1\fP +Ocorreu um erro. +.PP +\fBxzdec\fP não possui nenhuma mensagem de aviso como o \fBxz\fP(1), portanto, o +status de saída 2 não é usado por \fBxzdec\fP. +.SH NOTAS +Use \fBxz\fP(1) em vez de \fBxzdec\fP ou \fBlzmadec\fP para uso diário +normal. \fBxzdec\fP ou \fBlzmadec\fP destinam\-se apenas a situações em que é +importante ter um descompactador menor do que o \fBxz\fP(1) completo. +.PP +\fBxzdec\fP e \fBlzmadec\fP não são realmente tão pequenos. O tamanho pode ser +reduzido ainda mais eliminando recursos do liblzma no tempo de compilação, +mas isso geralmente não deve ser feito para executáveis distribuídos em +distribuições típicas de sistemas operacionais não embarcados. Se você +precisa de um descompactador \fB.xz\fP realmente pequeno, considere usar o XZ +Embedded. +.SH "VEJA TAMBÉM" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/pt_BR/man1/xzless.1 b/miniconda3/share/man/pt_BR/man1/xzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..a39dabb94a2bcc67dfe99963c489e76222de6af8 --- /dev/null +++ b/miniconda3/share/man/pt_BR/man1/xzless.1 @@ -0,0 +1,48 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Brazilian Portuguese translations for xz package +.\" Traduções em português brasileiro para o pacote xz. +.\" Rafael Fontenelle , 2022-2023. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NOME +xzless, lzless \- visualiza arquivos (texto) compactados em xz ou lzma +.SH SINOPSE +\fBxzless\fP [\fIarquivo\fP...] +.br +\fBlzless\fP [\fIfile\fP...] (DEPRECATED) +.SH DESCRIÇÃO +\fBxzless\fP is a filter that displays text from compressed files to a +terminal. Files supported by \fBxz\fP(1) are decompressed; other files are +assumed to be in uncompressed form already. If no \fIfiles\fP are given, +\fBxzless\fP reads from standard input. +.PP +\fBxzless\fP usa \fBless\fP(1) para apresentar sua saída. Ao contrário de +\fBxzmore\fP, sua escolha de pager não pode ser alterada pela configuração de +uma variável de ambiente. Os comandos são baseados em \fBmore\fP(1) e \fBvi\fP(1) +e permitem movimento e busca para frente e para trás. Consulte o manual +\fBless\fP(1) para obter mais informações. +.PP +The command named \fBlzless\fP is provided for backward compatibility with LZMA +Utils. It is deprecated and will be removed in a future version. +.SH AMBIENTE +.TP +\fBLESSMETACHARS\fP +Uma lista de caracteres especiais para o shell. Definido por \fBxzless\fP a +menos que já esteja definido no ambiente. +.TP +\fBLESSOPEN\fP +Defina como uma linha de comando para invocar o descompactador \fBxz\fP(1) para +pré\-processar os arquivos de entrada para \fBless\fP(1). +.SH "VEJA TAMBÉM" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzcat.1 b/miniconda3/share/man/ro/man1/lzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzcat.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/lzcmp.1 b/miniconda3/share/man/ro/man1/lzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..cebad3bb3ad049a59a6f1d29360d76fa73a915e4 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzcmp.1 @@ -0,0 +1,70 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzcmp, xzdiff, lzcmp, lzdiff \- compară fișierele comprimate +. +.SH REZUMAT +\fBxzcmp\fP [\fIopțiune...\fP] \fIfișier1\fP [\fIfișier2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (DEPRECIATĂ) +.br +\fBlzdiff\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzcmp\fP și \fBxzdiff\fP compară conținutul necomprimat a două fișiere. Datele +necomprimate și opțiunile sunt transmise la \fBcmp\fP(1) sau \fBdiff\fP(1), cu +excepția cazului în care se specifică \fB\-\-help\fP sau \fB\-\-version\fP. +.PP +Dacă sunt specificate atât \fIfișier1\fP, cât și \fIfișier2\fP, acestea pot fi +fișiere necomprimate sau fișiere în formate pe care \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) le poate +decomprima. Comenzile de decomprimare necesare sunt determinate de sufixele +numelor de fișiere \fIfișier1\fP și \fIfișier2\fP. Se presupune că un fișier cu un +sufix necunoscut este fie necomprimat, fie într\-un format pe care \fBxz\fP(1) +îl poate decomprima. +.PP +În cazul în care se furnizează un singur nume de fișier, \fIfișier1\fP trebuie +să aibă un sufix al unui format de comprimare acceptat, iar numele pentru +\fIfișier2\fP se presupune că este \fIfișier1\fP fără sufixul formatului de +comprimare. +.PP +Comenzile \fBlzcmp\fP și \fBlzdiff\fP sunt furnizate pentru compatibilitate +retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi eliminate +într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +În cazul în care apare o eroare de decomprimare, starea de ieșire este +\fB2\fP. În caz contrar, se utilizează starea de ieșire \fBcmp\fP(1) sau +\fBdiff\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzdiff.1 b/miniconda3/share/man/ro/man1/lzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..cebad3bb3ad049a59a6f1d29360d76fa73a915e4 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzdiff.1 @@ -0,0 +1,70 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzcmp, xzdiff, lzcmp, lzdiff \- compară fișierele comprimate +. +.SH REZUMAT +\fBxzcmp\fP [\fIopțiune...\fP] \fIfișier1\fP [\fIfișier2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (DEPRECIATĂ) +.br +\fBlzdiff\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzcmp\fP și \fBxzdiff\fP compară conținutul necomprimat a două fișiere. Datele +necomprimate și opțiunile sunt transmise la \fBcmp\fP(1) sau \fBdiff\fP(1), cu +excepția cazului în care se specifică \fB\-\-help\fP sau \fB\-\-version\fP. +.PP +Dacă sunt specificate atât \fIfișier1\fP, cât și \fIfișier2\fP, acestea pot fi +fișiere necomprimate sau fișiere în formate pe care \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) le poate +decomprima. Comenzile de decomprimare necesare sunt determinate de sufixele +numelor de fișiere \fIfișier1\fP și \fIfișier2\fP. Se presupune că un fișier cu un +sufix necunoscut este fie necomprimat, fie într\-un format pe care \fBxz\fP(1) +îl poate decomprima. +.PP +În cazul în care se furnizează un singur nume de fișier, \fIfișier1\fP trebuie +să aibă un sufix al unui format de comprimare acceptat, iar numele pentru +\fIfișier2\fP se presupune că este \fIfișier1\fP fără sufixul formatului de +comprimare. +.PP +Comenzile \fBlzcmp\fP și \fBlzdiff\fP sunt furnizate pentru compatibilitate +retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi eliminate +într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +În cazul în care apare o eroare de decomprimare, starea de ieșire este +\fB2\fP. În caz contrar, se utilizează starea de ieșire \fBcmp\fP(1) sau +\fBdiff\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzegrep.1 b/miniconda3/share/man/ro/man1/lzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzegrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzfgrep.1 b/miniconda3/share/man/ro/man1/lzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzfgrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzgrep.1 b/miniconda3/share/man/ro/man1/lzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzgrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzless.1 b/miniconda3/share/man/ro/man1/lzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..9bd9b2c296d7b6921c54b05a3508a9b2dd281db7 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzless.1 @@ -0,0 +1,60 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzless, lzless \- vizualizează fișierele (text) comprimate xz sau lzma +.SH REZUMAT +\fBxzless\fP [\fIfișier\fP...] +.br +\fBlzless\fP [\fIfișier\fP...] (DEPRECIATĂ) +.SH DESCRIERE +\fBxzless\fP este un filtru care afișează textul din fișierele comprimate pe un +terminal. Fișierele acceptate de \fBxz\fP(1) sunt decomprimate; se presupune că +celelalte fișiere sunt deja în format necomprimat. Dacă nu se dă nici un +\fIfișier\fP, \fBxzless\fP citește de la intrarea standard. +.PP +\fBxzless\fP folosește \fBless\fP(1) pentru a\-și prezenta rezultatul. Spre +deosebire de \fBxzmore\fP, alegerea sa de pager nu poate fi modificată prin +definirea unei variabile de mediu. Comenzile se bazează atât pe \fBmore\fP(1) +cât și pe \fBvi\fP(1) și permit mișcarea înainte și înapoi și +căutarea. Consultați manualul \fBless\fP(1) pentru mai multe informații. +.PP +Comanda numită \fBlzless\fP este furnizată pentru compatibilitatea cu LZMA +Utils. Aceasta este depreciată și va fi eliminată într\-o versiune viitoare. +.SH "VARIABILE DE MEDIU" +.TP +\fBLESSMETACHARS\fP +O listă de caractere speciale pentru shell. Definită de \fBxzless\fP, cu +excepția cazului în care este deja definită în mediu. +.TP +\fBLESSOPEN\fP +Aceasta este definită în linia de comandă pentru a invoca instrumentul de +decomprimare \fBxz\fP(1) pentru preprocesarea fișierelor de intrare pentru +\fBless\fP(1). +.SH "CONSULTAȚI ȘI" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzma.1 b/miniconda3/share/man/ro/man1/lzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzma.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/lzmadec.1 b/miniconda3/share/man/ro/man1/lzmadec.1 new file mode 100644 index 0000000000000000000000000000000000000000..2ba0113bc2dc5fc4bcde0c55e3c252171781c716 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzmadec.1 @@ -0,0 +1,101 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 "8 aprilie 2024" Tukaani "Utilități XZ" +.SH NUME +xzdec, lzmadec \- Programe de decomprimare mici de fișiere .xz și .lzma +.SH REZUMAT +\fBxzdec\fP [\fIopțiune...\fP] [\fIfișier...\fP] +.br +\fBlzmadec\fP [\fIopțiune...\fP] [\fIfișier...\fP] +.SH DESCRIERE +\fBxzdec\fP este un instrument de decomprimare bazat pe liblzma pentru +fișierele \fB.xz\fP (și numai \fB.xz\fP). \fBxzdec\fP este destinat să funcționeze ca +un înlocuitor pentru \fBxz\fP(1) în cele mai frecvente situații în care un +script a fost scris pentru a utiliza \fBxz \-\-decompress \-\-stdout\fP (și posibil +câteva alte opțiuni frecvent utilizate) pentru a decomprima fișierele +\&\fB.xz\fP. \fBlzmadec\fP este identic cu \fBxzdec\fP cu excepția faptului că +\fBlzmadec\fP acceptă fișierele \fB.lzma\fP în loc de fișierele \fB.xz\fP. +.PP +Pentru a reduce dimensiunea executabilului, \fBxzdec\fP nu acceptă modul cu mai +multe fire de execuție sau localizarea(afișarea mesajelor în limba stabilită +de configurările regionale) și nu citește opțiunile din variabilele de mediu +\fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP. \fBxzdec\fP nu acceptă afișarea informațiilor +intermediare de progres: trimiterea semnalului \fBSIGINFO\fP la \fBxzdec\fP nu +face nimic, iar trimiterea semnalului \fBSIGUSR1\fP încheie procesul în loc să +afișeze informații despre progres. +.SH OPȚIUNI +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP acceptă numai +decomprimarea. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP nu creează sau elimină +niciodată niciun fișier. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP scrie întotdeauna +datele decomprimate la ieșirea standard. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Specificarea acestui lucru o dată nu face nimic, deoarece \fBxzdec\fP nu +afișează niciodată avertismente sau notificări. Specificați acest lucru de +două ori pentru a suprima erorile. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP nu folosește niciodată +starea de ieșire 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor și iese cu succes. +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxzdec\fP și liblzma. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Toate au fost bine. +.TP +\fB1\fP +A apărut o eroare. +.PP +\fBxzdec\fP nu are niciun mesaj de avertizare precum \fBxz\fP(1), astfel că starea +de ieșire 2 nu este folosită de \fBxzdec\fP. +.SH NOTE +Utilizați \fBxz\fP(1) în loc de \fBxzdec\fP sau \fBlzmadec\fP pentru utilizarea +normală de zi cu zi. \fBxzdec\fP sau \fBlzmadec\fP sunt destinate numai +situațiilor în care este important să aveți un instrument de decomprimare +mai mic decât \fBxz\fP(1), cu funcții complete. +.PP +\fBxzdec\fP și \fBlzmadec\fP nu sunt chiar atât de mici. Dimensiunea poate fi +redusă și mai mult prin eliminarea caracteristicilor din liblzma în timpul +compilării, dar acest lucru nu ar trebui să se facă de obicei pentru +executabilele distribuite în distribuții tipice de sisteme de operare +neîncorporate. Dacă aveți nevoie de un instrument de decomprimare \fB.xz\fP cu +adevărat mic, luați în considerare utilizarea XZ Embedded. +.SH "CONSULTAȚI ȘI" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/ro/man1/lzmainfo.1 b/miniconda3/share/man/ro/man1/lzmainfo.1 new file mode 100644 index 0000000000000000000000000000000000000000..7a533bd6e3b433364b95f4e6e0bc8934e082335d --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzmainfo.1 @@ -0,0 +1,57 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LZMAINFO 1 30.06.2013 Tukaani "Utilități XZ" +.SH NUME +lzmainfo \- afișează informațiile stocate în antetul fișierului .lzma +.SH REZUMAT +\fBlzmainfo\fP [\fB\-\-help\fP] [\fB\-\-version\fP] [\fIfișier...\fP] +.SH DESCRIERE +\fBlzmainfo\fP afișează informațiile stocate în antetul fișierului +\&\fB.lzma\fP. Citește primii 13 octeți din \fIfișierul\fP specificat, decodifică +antetul și îl afișează la ieșirea standard în format care poate fi citit de +om. Dacă nu sunt date \fIfișiere\fP sau dacă \fIfișier\fP este \fB\-\fP, se citește +intrarea standard. +.PP +De obicei, cele mai interesante informații sunt dimensiunea necomprimată și +dimensiunea dicționarului. Dimensiunea necomprimată poate fi afișată numai +dacă fișierul este în varianta formatului \fB.lzma\fP netransmis în +flux. Cantitatea de memorie necesară pentru a decomprima fișierul este de +câteva zeci de kiloocteți plus dimensiunea dicționarului. +.PP +\fBlzmainfo\fP este inclus în XZ Utils în primul rând pentru compatibilitatea +cu LZMA Utils. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.SH ERORI +\fBlzmainfo\fP folosește sufixul \fBMB\fP în timp ce sufixul corect ar fi \fBMiB\fP +(2^20 octeți). Acest lucru este pentru a menține ieșirea compatibilă cu LZMA +Utils. +.SH "CONSULTAȚI ȘI" +\fBxz\fP(1) diff --git a/miniconda3/share/man/ro/man1/lzmore.1 b/miniconda3/share/man/ro/man1/lzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..dbc1541830568b68b48e9d554a71a90eff23a612 --- /dev/null +++ b/miniconda3/share/man/ro/man1/lzmore.1 @@ -0,0 +1,62 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzmore, lzmore \- vizualizează fișierele (text) comprimate xz sau lzma +. +.SH REZUMAT +\fBxzmore\fP [\fIfișier\fP...] +.br +\fBlzmore\fP [\fIfișier\fP...] (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzmore\fP afișează textul din fișierele comprimate pe un terminal folosind +\fBmore\fP(1). Fișierele acceptate de \fBxz\fP(1) sunt decomprimate; se presupune +că celelalte fișiere sunt deja în format necomprimat. Dacă nu se dă nici un +\fIfișiere\fP, \fBxzmore\fP citește de la intrarea standard. Consultați manualul +\fBmore\fP(1) pentru comenzile de la tastatură. +.PP +Rețineți că este posibil ca derularea înapoi să nu fie posibilă în funcție +de implementarea lui \fBmore\fP(1). Acest lucru se datorează faptului că +\fBxzmore\fP utilizează o conductă pentru a transmite datele decomprimate către +\fBmore\fP(1). \fBxzless\fP(1) utilizează \fBless\fP(1) care oferă caracteristici mai +avansate. +.PP +Comanda \fBlzmore\fP este furnizată pentru compatibilitate retroactivă cu LZMA +Utils. Aceasta este depreciată și va fi eliminată într\-o versiune viitoare. +. +.SH "VARIABILE DE MEDIU" +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Dacă variabila de mediu \fBPAGER\fP, este definită, valoarea sa este utilizată +ca paginator în loc de \fBmore\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/ro/man1/unlzma.1 b/miniconda3/share/man/ro/man1/unlzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/unlzma.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/unxz.1 b/miniconda3/share/man/ro/man1/unxz.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/unxz.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/xz.1 b/miniconda3/share/man/ro/man1/xz.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xz.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/xzcat.1 b/miniconda3/share/man/ro/man1/xzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..1555445592944b4f24e548fc0dc0b1c3af876030 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzcat.1 @@ -0,0 +1,2111 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 martie 2025" Tukaani "Utilități XZ" +. +.SH NUME +xz, unxz, xzcat, lzma, unlzma, lzcat \- Comprimă sau decomprimă fișiere .xz +și .lzma +. +.SH REZUMAT +\fBxz\fP [\fIopțiune...\fP] [\fIfișier...\fP] +. +.SH "ALIAS COMENZI" +\fBunxz\fP este echivalent cu \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP este echivalent cu \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP este echivalent cu \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP este echivalent cu \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Când scrieți scripturi care trebuie să decomprime fișiere, este recomandat +să folosiți întotdeauna comanda \fBxz\fP cu argumentele adecvate (\fBxz \-d\fP sau +\fBxz \-dc\fP) în loc de comenzile \fBunxz\fP și \fBxzcat\fP. +. +.SH DESCRIERE +\fBxz\fP este un instrument de comprimare a datelor de uz general cu sintaxă de +linie de comandă similară cu \fBgzip\fP(1) și \fBbzip2\fP(1). Formatul de fișier +nativ este formatul \fB.xz\fP, dar formatul vechi \fB.lzma\fP folosit de LZMA +Utils și fluxurile comprimate brute fără anteturi de format container sunt +de asemenea acceptate. În plus, este acceptată decomprimarea formatului +\&\fB.lz\fP folosit de \fBlzip\fP. +.PP +\fBxz\fP comprimă sau decomprimă fiecare \fIfișier\fP în funcție de modul de +operare selectat. Dacă nu sunt date \fIfișiere\fP sau \fIfișier\fP este \fB\-\fP, +\fBxz\fP citește de la intrarea standard și scrie datele procesate la ieșirea +standard. \fBxz\fP va refuza (afișează o eroare și omite \fIfișier\fP) să scrie +date comprimate la ieșirea standard dacă este un terminal. În mod similar, +\fBxz\fP va refuza să citească datele comprimate de la intrarea standard dacă +este un terminal. +.PP +Cu excepția cazului în care este specificată opțiunea \fB\-\-stdout\fP, +\fIfișierele\fP altele decât \fB\-\fP sunt scrise într\-un fișier nou al cărui nume +este derivat din numele \fIfișierului\fP sursă: +.IP \(bu 3 +La comprimare, sufixul formatului de fișier țintă (\fB.xz\fP sau \fB.lzma\fP) este +atașat la numele fișierului sursă pentru a se obține numele fișierului +țintă. +.IP \(bu 3 +La decomprimare, sufixul \fB.xz\fP, \fB.lzma\fP sau \fB.lz\fP este eliminat din +numele fișierului pentru a se obține numele fișierului țintă. \fBxz\fP +recunoaște și sufixele \fB.txz\fP și \fB.tlz\fP și le înlocuiește cu sufixul +\&\fB.tar\fP. +.PP +Dacă fișierul țintă există deja, este afișată o eroare și \fIfișier\fP este +omis. +.PP +Cu excepția cazului în care scrie la ieșirea standard, \fBxz\fP va afișa un +avertisment și va omite \fIfișier\fPul dacă se aplică oricare dintre +următoarele: +.IP \(bu 3 +\fIFișierul\fP nu este un fișier obișnuit. Legăturile simbolice nu sunt urmate +și, prin urmare, nu sunt considerate fișiere obișnuite. +.IP \(bu 3 +\fIFișierul\fP are mai mult de o legătură dură. +.IP \(bu 3 +\fIFișierul\fP are activat bitul «setuid», «setgid» sau cel lipicios(sticky). +.IP \(bu 3 +Modul de operare este stabilit la comprimare și \fIfișier\fP are deja un sufix +al formatului de fișier țintă (\fB.xz\fP sau \fB.txz\fP când se comprimă în +formatul \fB.xz\fP și \fB.lzma\fP sau \fB.tlz\fP când se comprimă în formatul +\&\fB.lzma\fP). +.IP \(bu 3 +Modul de operare este stabilit la decomprimare și \fIfișierul\fP nu are un +sufix al niciunui format de fișier acceptat (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, +\&\fB.tlz\fP, sau \fB.lz\fP). +.PP +După comprimarea sau decomprimarea cu succes a \fIfișierului\fP, \fBxz\fP copiază +proprietarul, grupul, permisiunile, timpul de acces și timpul de modificare +din \fIfișierul\fP sursă în fișierul țintă. Dacă copierea grupului eșuează, +permisiunile sunt modificate astfel încât fișierul țintă să nu devină +accesibil utilizatorilor care nu aveau permisiunea de a accesa \fIfișierul\fP +sursă. \fBxz\fP nu acceptă încă copierea altor metadate, cum ar fi listele de +control al accesului sau atributele extinse. +.PP +Odată ce fișierul țintă a fost închis cu succes, \fIfișierul\fP sursă este +eliminat dacă nu a fost specificată opțiunea \fB\-\-keep\fP. \fIFișierul\fP sursă nu +este niciodată eliminat dacă rezultatul este scris la ieșirea standard sau +dacă apare o eroare. +.PP +Trimiterea unui semnal \fBSIGINFO\fP sau \fBSIGUSR1\fP către procesul \fBxz\fP face +ca acesta să imprime informații despre progres la ieșirea de eroare +standard. Acest lucru are o utilizare limitată, deoarece atunci când ieșirea +de eroare standard este un terminal, folosind opțiunea \fB\-\-verbose\fP va afișa +un indicator de progres de actualizare automată. +. +.SS "Utilizarea memoriei" +Cantitatea de memorie utilizată de \fBxz\fP variază de la câteva sute de +kiloocteți la câțiva gigaocteți, în funcție de opțiunile de +comprimare. Opțiunile utilizate la comprimarea unui fișier determină +cerințele de memorie ale instrumentului de decomprimare. De obicei, +instrumentul de decomprimare are nevoie de 5% până la 20% din cantitatea de +memorie de care a avut nevoie instrumentul de comprimare la crearea +fișierului. De exemplu, decomprimarea unui fișier creat cu \fBxz \-9\fP necesită +în prezent 65Mio de memorie. Totuși, este posibil să aveți fișiere \fB.xz\fP +care necesită câțiva gigaocteți de memorie pentru decomprimare. +.PP +În special utilizatorii de sisteme mai vechi pot considera deranjantă +posibilitatea unei utilizări foarte mari a memoriei. Pentru a preveni +surprizele neplăcute, \fBxz\fP are încorporat un limitator de utilizare a +memoriei, care este dezactivat implicit. În timp ce unele sisteme de operare +oferă modalități de a limita utilizarea memoriei proceselor, bazarea pe +aceasta nu a fost considerată a fi suficient de flexibilă (de exemplu, +utilizarea \fBulimit\fP(1) pentru a limita memoria virtuală tinde să paralizeze +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Limitatorul de utilizare a memoriei poate fi activat cu opțiunea din linia +de comandă \fB\-\-memlimit=\fP\fIlimita\fP. Adesea este mai convenabil să activați +limitatorul în mod implicit prin definirea variabilei de mediu +\fBXZ_DEFAULTS\fP, de exemplu, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Este posibil +să stabiliți limitele separat pentru comprimare și decomprimare folosind +\fB\-\-memlimit\-compress=\fP\fIlimita\fP și +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP. Utilizarea acestor două opțiuni în afara +\fBXZ_DEFAULTS\fP este foarte rar utilă, deoarece o singură rulare a \fBxz\fP nu +poate face atât comprimarea, cât și decomprimarea și \fB\-\-memlimit=\fP\fIlimita\fP +(sau \fB\-M\fP \fIlimita\fP ) este mai scurt de tastat pe linia de comandă. +.PP +Dacă limita de utilizare a memoriei specificată este depășită la +decomprimare, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Dacă limita este depășită la comprimare, \fBxz\fP va încerca să reducă +valorile stabilite astfel încât limita să nu mai fie depășită (cu excepția +cazului în care se utilizează opțiunea \fB\-\-format=raw\fP sau +\fB\-\-no\-adjust\fP). În acest fel, operațiunea nu va eșua decât dacă limita +stabilită este foarte mică. Scalarea valorilor stabilite se face în pași +care nu se potrivesc cu valorile prestabilite ale nivelului de comprimare, +de exemplu, dacă limita este doar puțin mai mică decât cantitatea necesară +pentru \fBxz \-9\fP, valorile stabilite vor fi reduse doar puțin , nu până la +valoarea prestabilită a lui \fBxz \-8\fP. +. +.SS "Concatenare și completare (prin umplere cu octeți nuli) cu fișiere .xz" +Este posibil să concatenați fișierele \fB.xz\fP așa cum sunt. \fBxz\fP va +decomprima astfel de fișiere ca și cum ar fi un singur fișier \fB.xz\fP. +.PP +Este posibil să se introducă umplutură între părțile concatenate sau după +ultima parte. Umplutura trebuie să fie compusă din octeți nuli, iar +dimensiunea umpluturii trebuie să fie un multiplu de patru octeți. Acest +lucru poate fi util, de exemplu, dacă fișierul \fB.xz\fP este stocat pe un +mediu care măsoară dimensiunile fișierelor în blocuri de 512 de octeți. +.PP +Concatenarea și completarea nu sunt permise cu fișierele \fB.lzma\fP sau +fluxurile brute. +. +.SH OPȚIUNI +. +.SS "Sufixe de numere întregi și valori speciale" +În majoritatea locurilor în care este de așteptat un număr întreg ca +argument, un sufix opțional este acceptat pentru a indica cu ușurință +numerele întregi mari. Nu trebuie să existe spațiu între numărul întreg și +sufix. +.TP +\fBKiB\fP +Înmulțește numărul întreg cu 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP și +\fBKB\fP sunt acceptate ca sinonime pentru \fBKiB\fP. +.TP +\fBMiB\fP +Înmulțește numărul întreg cu 1,048,576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, și \fBMB\fP +sunt acceptate ca sinonime pentru \fBMiB\fP. +.TP +\fBGiB\fP +Înmulțește numărul întreg cu 1,073,741,824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, și +\fBGB\fP sunt acceptate ca sinonime pentru \fBGiB\fP. +.PP +Valoarea specială \fBmax\fP poate fi utilizată pentru a indica valoarea maximă +întreagă suportată de opțiune. +. +.SS "Mod de operare" +Dacă sunt date mai multe opțiuni de mod de funcționare, ultima dintre ele, +este cea care va avea efect. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Comprimare. Acesta este modul de operare implicit atunci când nu este +specificată nicio opțiune de mod de funcționare și nici un alt mod de +operare nu este implicat din numele comenzii (de exemplu, \fBunxz\fP implică +\fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +După o comprimare reușită, fișierul sursă este eliminat, cu excepția cazului +în care a fost specificată scrierea la ieșirea standard sau opțiunea +\fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Decomprimare. După o decomprimare reușită, fișierul sursă este eliminat, cu +excepția cazului în care a fost specificată scrierea la ieșirea standard sau +opțiunea \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testează integritatea \fIfișierelor\fP comprimate. Această opțiune este +echivalentă cu \fB\-\-decompress \-\-stdout\fP cu excepția faptului că datele +decomprimate sunt înlăturate în loc să fie scrise la ieșirea standard. Nu +sunt create sau eliminate fișiere. +.TP +\fB\-l\fP, \fB\-\-list\fP +Afișează informații despre \fIfișiere\fP comprimate. Nu are loc nicio +decomprimare la ieșire și nu sunt create sau eliminate fișiere. În modul +listă, programul nu poate citi datele comprimate din intrarea standard sau +din alte surse care nu pot fi explorate. +.IP "" +Listarea implicită arată informații de bază despre \fIfișiere\fP, câte un +fișier pe linie. Pentru a obține informații mai detaliate, utilizați și +opțiunea \fB\-\-verbose\fP. Pentru și mai multe informații, utilizați opțiunea +\fB\-\-verbose\fP de două ori, dar rețineți că acest lucru poate fi lent, +deoarece obținerea tuturor informațiilor suplimentare necesită multe +căutări. Lățimea ieșirii detaliate depășește 80 de caractere, deci +canalizarea ieșirii către, de exemplu, \fBless\ \-S\fP poate fi convenabilă dacă +terminalul nu este suficient de lat. +.IP "" +Ieșirea exactă poate varia între versiunile \fBxz\fP și diferitele +localizări(configurările regionale). Pentru ieșiri care pot fi citite de +mașină, ar trebui utilizată opțiunea \fB\-\-robot \-\-list\fP. +. +.SS "Modificatori de operare" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Nu șterge fișierele de intrare. +.IP "" +Începând cu \fBxz\fP 5.2.6, această opțiune face ca \fBxz\fP să comprime sau să +decomprime, chiar dacă intrarea este o legătură simbolică către un fișier +obișnuit, are mai mult de\-o legătură dură sau are marcați biții setuid, +setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu sunt +copiați în fișierul țintă. În versiunile anterioare acest lucru se făcea +numai cu ajutorul opțiunii \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Această opțiune are mai multe efecte: +.RS +.IP \(bu 3 +Dacă fișierul țintă există deja, îl șterge înainte de comprimare sau +decomprimare. +.IP \(bu 3 +Comprimă sau decomprimă chiar dacă intrarea este o legătură simbolică către +un fișier obișnuit, are mai mult de\-o legătură dură sau are marcați biții +setuid, setgid sau bitul lipicios. Biții setuid, setgid și bitul lipicios nu +sunt copiați în fișierul țintă. +.IP \(bu 3 +Când este utilizată cu opțiunile \fB\-\-decompress\fP și \fB\-\-stdout\fP, comanda +\fBxz\fP nu poate recunoaște tipul fișierului sursă, și copiază fișierul sursă +așa cum este la ieșirea standard. Acest lucru permite comenzii \fBxzcat\fP +\fB\-\-force\fP să fie folosită drept comanda \fBcat\fP(1) pentru fișierele care nu +au fost comprimate cu \fBxz\fP. Rețineți că, în viitor, \fBxz\fP ar putea să +accepte noi formate de fișiere comprimate, ceea ce poate face ca \fBxz\fP să +decomprime mai multe tipuri de fișiere în loc să le copieze așa cum sunt la +ieșirea standard. Opțiunea \fB\-\-format=\fP\fIformat\fP poate fi folosită pentru a +restricționa \fBxz\fP să decomprime doar un singur format de fișier. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Scrie datele comprimate sau decomprimate la ieșirea standard în loc de +într\-un fișier. Aceasta implică \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Decomprimă numai primul flux \fB.xz\fP și ignoră în tăcere posibilele date de +intrare rămase în urma fluxului. În mod normal, astfel de resturi rămase +face ca \fBxz\fP să afișeze o eroare. +.IP "" +\fBxz\fP nu decomprimă niciodată mai mult de un flux din fișierele \fB.lzma\fP sau +din fluxurile brute, dar această opțiune face ca \fBxz\fP să ignore posibilele +resturi de date rămase după fișierul \fB.lzma\fP sau fluxul brut. +.IP "" +Această opțiune nu are efect dacă modul de funcționare nu este +\fB\-\-decompress\fP sau \fB\-\-test\fP. +.IP "" +Începând cu \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP implică \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Dezactivează crearea de fișiere dispersate. În mod implicit, dacă decomprimă +într\-un fișier obișnuit, \fBxz\fP încearcă să facă fișierul dispersat dacă +datele decomprimate conțin secvențe lungi de zerouri binare. De asemenea, +funcționează atunci când scrie la ieșirea standard, atâta timp cât ieșirea +standard este conectată la un fișier obișnuit și sunt îndeplinite anumite +condiții suplimentare pentru a o face în siguranță. Crearea de fișiere +dispersate poate economisi spațiu pe disc și poate accelera decomprimarea +prin reducerea cantității de date de In/Ieș pe disc. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Când comprimă, utilizează \fI.suf\fP ca sufix pentru fișierul țintă în loc de +\&\fB.xz\fP sau \fB.lzma\fP. Dacă nu scrie la ieșirea standard și fișierul sursă are +deja sufixul \fI.suf\fP, este afișat un avertisment și fișierul este omis. +.IP "" +Când decomprimă, recunoaște fișierele cu sufixul \fI.suf\fP în plus față de +fișierele cu sufixul \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP sau \fB.lz\fP. Dacă +fișierul sursă are sufixul \fI.suf\fP, sufixul este eliminat pentru a obține +numele fișierului țintă. +.IP "" +La comprimarea sau decomprimarea fluxurilor brute (\fB\-\-format=raw\fP), sufixul +trebuie să fie întotdeauna specificat, cu excepția cazului în care se scrie +la ieșirea standard, deoarece nu există un sufix implicit pentru fluxurile +brute. +.TP +\fB\-\-files\fP[\fB=\fP\fIfișier\fP] +Citește numele fișierelor de procesat din \fIfișier\fP; dacă \fIfișierul\fP este +omis, numele fișierelor sunt citite de la intrarea standard. Numele de +fișiere trebuie să fie terminate cu caracterul de linie nouă. O liniuță +(\fB\-\fP) este luată ca nume de fișier obișnuit; nu înseamnă intrarea +standard. Dacă numele de fișiere sunt date și ca argumente în linia de +comandă, ele sunt procesate înainte ca numele fișierelor să fie citite din +\fIfișier\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfișier\fP] +Această opțiune este identică cu \fB\-\-files\fP[\fB=\fP\fIfișier\fP], cu excepția +faptului că fiecare nume de fișier trebuie să fie terminat cu caracterul +nul. +. +.SS "Formatul de bază al fișierului și opțiunile de comprimare" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Specifică \fIformatul\fP fișierului pentru comprimare sau decomprimare: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Aceasta este valoarea implicită. La comprimare, \fBauto\fP este echivalent cu +\fBxz\fP. La decomprimare, formatul fișierului de intrare este detectat +automat. Rețineți că fluxurile brute (create cu \fB\-\-format=raw\fP) nu pot fi +detectate automat. +.TP +\fBxz\fP +Comprimă în formatul de fișier \fB.xz\fP sau acceptă numai fișierele \fB.xz\fP +când decomprimă. +.TP +\fBlzma\fP, \fBalone\fP +Comprimă în formatul de fișier \fB.lzma\fP vechi sau acceptă numai fișierele +\&\fB.lzma\fP când decomprimă. Numele alternativ \fBalone\fP este furnizat pentru +compatibilitatea cu versiunile mai vechi de LZMA Utils. +.TP +\fBlzip\fP +Acceptă numai fișierele \fB.lz\fP când decomprimă. Comprimarea nu este +acceptată. +.IP "" +Sunt acceptate versiunile 0 și 1 ale formatului \fB.lz\fP. Fișierele versiunii +0 au fost create cu \fBlzip\fP 1.3 și versiuni mai vechi. Astfel de fișiere nu +sunt comune, dar pot fi găsite în arhivele de fișiere, deoarece câteva +pachete sursă au fost lansate în acest format. Este posibil ca oamenii să +aibă și fișiere personale vechi în acest format. Suportul pentru +decomprimare pentru versiunea 0 a formatului a fost eliminat în \fBlzip\fP +1.18. \fBlzip\fP 1.4 și versiunile ulterioare creează fișiere în versiunea 1 a +formatului. +.TP +\fBraw\fP +Comprimă sau decomprimă un flux brut (fără anteturi). Acest lucru este +destinat doar utilizatorilor avansați. Pentru a decodifica fluxurile brute, +trebuie să utilizați opțiunea \fB\-\-format=raw\fP și să specificați în mod +explicit lanțul de filtre, care în mod normal ar fi fost stocat în +anteturile containerului. +.RE +.TP +\fB\-C\fP \fIverificarea\fP, \fB\-\-check=\fP\fIverificarea\fP +Specifică tipul verificării integrității. Verificarea este calculată din +datele necomprimate și stocată în fișierul \fB.xz\fP. Această opțiune are efect +numai la comprimarea în format \fB.xz\fP; formatul \fB.lzma\fP nu acceptă +verificări de integritate. Verificarea integrității (dacă există) este +efectuată atunci când fișierul \fB.xz\fP este decomprimat. +.IP "" +Tipuri de \fIverificare\fP acceptate: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Nu calculează deloc o verificare a integrității. Aceasta este de obicei o +idee proastă. Acest lucru poate fi util atunci când integritatea datelor +este oricum verificată prin alte mijloace. +.TP +\fBcrc32\fP +Calculează CRC32 folosind polinomul din IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Calculează CRC64 folosind polinomul din ECMA\-182. Aceasta este valoarea +implicită, deoarece este ceva mai bună decât CRC32 la detectarea fișierelor +deteriorate, iar diferența de viteză este neglijabilă. +.TP +\fBsha256\fP +Calculează SHA\-256. Acest lucru este oarecum mai lent decât CRC32 și CRC64. +.RE +.IP "" +Integritatea antetelor \fB.xz\fP este întotdeauna verificată cu CRC32. Nu este +posibilă modificarea sau dezactivarea acesteia. +.TP +\fB\-\-ignore\-check\fP +Nu efectuează verificarea integrității datelor comprimate la +decomprimare. Valorile CRC32 din antetele \fB.xz\fP vor fi însă verificate +normal. +.IP "" +\fBNu utilizați această opțiune decât dacă știți ce faceți\fP. Motive posibile +pentru a utiliza această opțiune: +.RS +.IP \(bu 3 +Încercarea de a recupera datele dintr\-un fișier .xz corupt. +.IP \(bu 3 +Accelerarea decomprimării. Acest lucru contează mai ales cu SHA\-256 sau cu +fișierele care s\-au comprimat extrem de bine. Este recomandat să nu +utilizați această opțiune în acest scop decât dacă integritatea fișierului +este verificată extern într\-un alt mod. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Selectează un nivel prestabilit de comprimare. Valoarea implicită este +\fB\-6\fP. Dacă sunt specificate mai multe niveluri prestabilite, ultimul are +efect. Dacă a fost deja specificat un lanț de filtre personalizat, +specificarea unui nivel prestabilit de comprimare șterge lanțul de filtre +personalizat. +.IP "" +Diferențele dintre valorile prestabilite sunt mai semnificative decât cu +\fBgzip\fP(1) și \fBbzip2\fP(1). Valorile de comprimare selectate determină +cerințele de memorie ale instrumentului de decomprimare, astfel încât +utilizarea unui nivel prea mare prestabilit ar putea face „dureroasă” +decomprimarea fișierului pe un sistem vechi cu puțină memorie RAM. Mai +exact, \fBnu este o idee bună să folosiți orbește \-9 pentru tot\fP așa cum se +întâmplă adesea cu \fBgzip\fP(1) și \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Acestea sunt valorile prestabilite oarecum rapide. \fB\-0\fP este uneori mai +rapid decât \fBgzip \-9\fP în timp ce comprimă mult mai bine. Cele mai ridicate +au adesea viteza comparabilă cu \fBbzip2\fP(1) cu un raport de comprimare +comparabil sau mai bun, deși rezultatele depind foarte mult de tipul de date +care sunt comprimate. +.TP +\fB\-4\fP ... \fB\-6\fP +Comprimare bună spre foarte bună, păstrând în același timp utilizarea +memoriei de către instrumentul de decomprimare la un nivel rezonabil chiar +și pentru sistemele vechi. \fB\-6\fP este valoarea implicită, care este de +obicei o alegere bună pentru distribuirea fișierelor care trebuie să poată +fi decomprimate chiar și pe sisteme cu doar 16Mio de memorie RAM. Opțiunile +(\fB\-5e\fP sau \fB\-6e\fP ar putea fi demne de luat în considerare. A se vedea +opțiunea \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Acestea sunt precum \fB\-6\fP, dar cu cerințe mai mari de memorie pentru +comprimare și decomprimare. Acestea sunt utile numai atunci când comprimați +fișiere mai mari de 8Mio, 16Mio și, respectiv, 32Mio. +.RE +.IP "" +Pe același hardware, viteza de decomprimare este aproximativ un număr +constant de octeți de date comprimate pe secundă. Cu alte cuvinte, cu cât +comprimarea este mai bună, cu atât decomprimarea va fi de obicei mai +rapidă. Aceasta înseamnă, de asemenea, că valoarea de la ieșire a cantității +de date necomprimate produsă pe secundă poate varia foarte mult. +.IP "" +Următorul tabel rezumă caracteristicile valorilor prestabilite: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Descrieri coloane: +.RS +.IP \(bu 3 +DimDict este dimensiunea dicționarului LZMA2. Este o risipă de memorie să +folosești un dicționar mai mare decât dimensiunea fișierului necomprimat. De +aceea este bine să evitați utilizarea valorilor prestabilite \fB\-7\fP ... \fB\-9\fP +atunci când nu este nevoie cu adevărat de ele. Pentru valoarea prestabilită +\fB\-6\fP sau alta mai mică, cantitatea de memorie irosită este de obicei +suficient de mică pentru a nu conta. +.IP \(bu 3 +CPUComp este o reprezentare simplificată a configurărilor LZMA2 care +afectează viteza de comprimare. Dimensiunea dicționarului afectează și +viteza, așa că, în timp ce CPUComp este aceeași pentru nivelurile \fB\-6\fP +\&... \fB\-9\fP, nivelurile mai mari tind să fie puțin mai lente. Pentru a obține +o comprimare și mai lentă și, astfel, posibil mai bună, consultați opțiunea +\fB\-\-extreme\fP. +.IP \(bu 3 +MemComp conține cerințele de memorie ale comprimării în modul cu un singur +fir de execuție. Poate varia ușor între versiunile \fBxz\fP. +.IP \(bu 3 +MemDec conține cerințele de memorie pentru decomprimare. Adică, +configurările de comprimare determină cerințele de memorie ale +decomprimării. Cantitatea exactă a memoriei utilizate la decomprimare este +puțin mai mare decât dimensiunea dicționarului LZMA2, dar valorile din tabel +au fost rotunjite la următorul Mio. +.RE +.IP "" +Cerințele de memorie ale modului cu mai multe fire de execuție sunt +semnificativ mai mari decât cele ale modului cu un singur fir de +execuție. Cu valoarea implicită a lui \fB\-\-block\-size\fP, fiecare fir are +nevoie de 3*3*DictSize plus MemComp sau MemDec. De exemplu, patru fire de +execuție cu valoarea prestabilită \fB\-6\fP au nevoie de 660\(en670\ Mio de +memorie. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Utilizează o variantă mai lentă a nivelului prestabilit de comprimare +selectat (\fB\-0\fP ... \fB\-9\fP) pentru a obține un raport de comprimare puțin mai +bun, dar din nefericire, acest lucru îl poate înrăutăți. Utilizarea memoriei +pentru decomprimare nu este afectată, dar utilizarea memoriei la comprimare +crește puțin la nivelurile prestabilite \fB\-0\fP ... \fB\-3\fP. +.IP "" +Deoarece există două valori prestabilite cu dimensiuni ale dicționarului de +4Mio și 8Mio, valorile prestabilite \fB\-3e\fP și \fB\-5e\fP folosesc configurări +puțin mai rapide (CPUComp mai mic) decât \fB\-4e\fP și \fB\-6e\fP, respectiv. În +acest fel, nu există două nivele prestabilite identice. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +ValPrestab;DimDict;CPUComp;MemComp;MemDec +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +De exemplu, există un total de patru nivele prestabilite care folosesc +dicționarul 8Mio, a căror ordine de la cel mai rapid la cel mai lent este +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP și \fB\-6e\fP . +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Acestea sunt alias de opțiuni, oarecum înșelătoare pentru \fB\-0\fP și, +respectiv, \fB\-9\fP. Acestea sunt furnizate numai pentru compatibilitatea cu +LZMA Utils. Evitați utilizarea acestor opțiuni. +.TP +\fB\-\-block\-size=\fP\fIdimensiunea\fP +Când comprimă în formatul \fB.xz\fP, împarte datele de intrare în blocuri de +\fIdimensiunea\fP octeți. Blocurile sunt comprimate independent unul de +celălalt, ceea ce ajută în modul cu mai multe fire de execuție și face +posibilă decomprimarea cu acces aleatoriu limitat. Această opțiune este de +obicei folosită pentru a suprascrie dimensiunea implicită a blocului în +modul cu mai multe fire de execuție, dar această opțiune poate fi folosită +și în modul cu un singur fir de execuție. +.IP "" +În modul cu mai multe fire de execuție, aproximativ de trei ori +\fIdimensiunea\fP de octeți vor fi alocați în fiecare fir pentru stocarea +intrării și ieșirii. \fIDimensiunea\fP implicită este de trei ori dimensiunea +dicționarului LZMA2 sau 1Mio, oricare dintre acestea este mai mare. În mod +obișnuit, o valoare bună este de două la patru ori dimensiunea dicționarului +LZMA2 sau de cel puțin 1Mio. Utilizarea unei \fIdimensiuni\fP mai mici decât +dimensiunea dicționarului LZMA2 este o risipă de memorie RAM, deoarece +atunci memoria tampon a dicționarului LZMA2 nu va fi niciodată utilizată pe +deplin. În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt +stocate în anteturile blocurilor. Aceste informații privind dimensiunea sunt +necesare pentru decomprimarea cu mai multe fire. +.IP "" +În modul cu un singur fir de execuție, nicio divizare a blocurilor nu se +face în mod implicit. Folosirea acestei opțiuni nu afectează utilizarea +memoriei. Nu sunt stocate informații despre dimensiune în antetele +blocurilor, astfel încât fișierele create în modul cu un singur fir de +execuție nu vor fi identice cu fișierele create în modul cu mai multe fire +de execuție. Lipsa informațiilor privind dimensiunea înseamnă, de asemenea, +că \fBxz\fP nu va putea decomprima fișierele în modul cu mai multe fire. de +execuție. +.TP +\fB\-\-block\-list=\fP\fIelemente\fP +Când comprimă în formatul \fB.xz\fP, începe un nou bloc cu un lanț de filtre +personalizat opțional după intervalele specificate de date necomprimate. +.IP "" +\fIelementele\fP sunt o listă separată prin virgule. Fiecare element este +format dintr\-un număr opțional de lanț de filtrare între 0 și 9, urmat de +două puncte (\fB:\fP) și de o dimensiune cerută a datelor +necomprimate. Omiterea unui element (două sau mai multe virgule consecutive) +este o prescurtare pentru a utiliza dimensiunea și filtrele din elementul +anterior. +.IP "" +În cazul în care fișierul de intrare este mai mare decât suma dimensiunilor +din \fIelemente\fP, ultimul element se repetă până la sfârșitul fișierului. O +valoare specială de \fB0\fP poate fi utilizată ca ultimă dimensiune pentru a +indica faptul că restul fișierului trebuie să fie codificat ca un singur +bloc. +.IP "" +Un lanț de filtre alternativ pentru fiecare bloc poate fi specificat în +combinație cu opțiunile \fB\-\-filters1=\fP\fIfiltre\fP \&...\& +\fB\-\-filters9=\fP\fIfiltre\fP. Aceste opțiuni definesc lanțuri de filtre cu un +identificator cuprins între 1\(en9. Lanțul de filtre 0 poate fi utilizat +pentru a se referi la lanțul de filtre implicit, ceea ce este același lucru +cu a nu specifica un lanț de filtre. Identificatorul lanțului de filtre +poate fi utilizat înaintea dimensiunii necomprimate, urmat de două puncte +(\fB:\fP). De exemplu, dacă se specifică +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, atunci blocurile vor fi +create folosind: +.RS +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters1\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters3\fP și 2 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre specificat de \fB\-\-filters2\fP și 4 Mio de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 2 MiB de intrare +.IP \(bu 3 +Lanțul de filtre implicit și 4 MiB de intrare pentru fiecare bloc până la +sfârșitul intrării. +.RE +.IP "" +Dacă se specifică o dimensiune care depășește dimensiunea blocului +codificatorului (fie valoarea implicită în modul cu fire de execuție, fie +valoarea specificată cu \fB\-\-block\-size=\fP\fIdimensiune\fP), codificatorul va +crea blocuri suplimentare, păstrând limitele specificate în \fIelemente\fP. De +exemplu, dacă se specifică \fB\-\-block\-size=10MiB\fP +\fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP și fișierul de intrare este de +80 MiB, se vor obține 11 blocuri: 5, 10, 8, 10, 10, 2, 10, 10, 10, 4, 10, +10, 10 și 1 Mio. +.IP "" +În modul cu mai multe fire de execuție, dimensiunile blocurilor sunt stocate +în antetele blocurilor. Acest lucru nu se face în modul cu un singur fir de +execuție, astfel încât ieșirea codificată nu va fi identică cu cea a modului +cu mai multe fire de execuție. +.TP +\fB\-\-flush\-timeout=\fP\fItimp_limită\fP +La comprimare, dacă au trecut mai mult de \fItimp_limită\fP milisecunde (un +întreg pozitiv) de la curățarea anterioară și citirea mai multor intrări +s\-ar bloca, toate datele de intrare în așteptare sunt eliminate din +codificator și puse la dispoziție în fluxul de ieșire. Acest lucru poate să +fie util dacă \fBxz\fP este utilizat pentru a comprima datele care sunt +transmise în flux printr\-o rețea. Valorile mici de \fItimp_limită\fP fac datele +disponibile la capătul de recepție cu o mică întârziere, dar valorile mari +de \fItimp_limită\fP oferă un raport de comprimare mai bun. +.IP "" +Această caracteristică este dezactivată în mod implicit. Dacă această +opțiune este specificată de mai multe ori, ultima este cea care se ia în +considerare. Valoarea specială a lui \fItimp_limită\fP de \fB0\fP, poate fi +utilizată pentru a dezactiva în mod explicit această caracteristică. +.IP "" +Această caracteristică nu este disponibilă în sistemele non\-POSIX. +.IP "" +.\" FIXME +\fBAceastă caracteristică este încă experimentală\fP. În prezent, \fBxz\fP este +nepotrivit pentru decomprimarea fluxului în timp real datorită modului în +care \fBxz\fP utilizează memoria tampon. +.TP +\fB\-\-no\-sync\fP +Nu sincronizează fișierul țintă și directorul acestuia cu dispozitivul de +stocare înainte de a elimina fișierul sursă. Acest lucru poate îmbunătăți +performanța în cazul comprimării sau decomprimării multor fișiere mici. Cu +toate acestea, dacă sistemul se blochează imediat după ștergere, este +posibil ca fișierul țintă să nu fi fost scris pe dispozitivul de stocare, +dar operația de ștergere să fi fost. În acest caz, nici fișierul sursă +original, nici fișierul țintă nu sunt disponibile. +.IP "" +Această opțiune are efect numai atunci când \fBxz\fP urmează să elimine +fișierul sursă. În alte cazuri, sincronizarea nu se face niciodată. +.IP "" +Sincronizarea și \fB\-\-no\-sync\fP au fost adăugate în \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru comprimare. Dacă această +opțiune este specificată de mai multe ori, ultima va avea efect. +.IP "" +Dacă parametrii de comprimare depășesc \fIlimita\fP, \fBxz\fP va încerca să +ajusteze parametrii scăzând valorile acestora, astfel încât limita să nu mai +fie depășită și va afișa o notificare că ajustarea automată a fost +efectuată. Ajustările se fac în această ordine: reducerea numărului de fire, +trecerea la modul un singur fir de execuție dacă chiar și un singur fir în +modul cu mai multe fire de execuție depășește \fIlimita\fP și, în final, +reducerea dimensiunii dicționarului LZMA2. +.IP "" +Când comprimă cu opțiunea \fB\-\-format=raw\fP sau dacă a fost specificată +opțiunea \fB\-\-no\-adjust\fP, numai numărul de fire poate fi redus, deoarece se +poate face fără a afecta rezultatul comprimării. +.IP "" +Dacă \fIlimita\fP nu poate fi îndeplinită chiar și cu ajustările descrise mai +sus, este afișată o eroare și \fBxz\fP va ieși cu starea de ieșire 1. +.IP "" +\fILimita\fP poate fi specificata în mai multe moduri: +.RS +.IP \(bu 3 +\fILimita\fP poate fi o valoare absolută în octeți. Utilizarea unui sufix +întreg precum \fBMiB\fP poate fi utilă. De exemplu: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fILimita\fP poate fi specificată ca procent din memoria fizică totală +(RAM). Acest lucru poate fi util mai ales atunci când definiți variabila de +mediu \fBXZ_DEFAULTS\fP într\-un script de inițializare shell care este partajat +între diferite calculatoare. În acest fel, limita este automat mai mare pe +sistemele cu mai multă memorie. De exemplu: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fILimita\fP poate fi restabilită la valoarea implicită dându\-i valoarea +\fB0\fP. În prezent, aceasta este echivalentă cu stabilirea \fIlimitei\fP la +\fBmax\fP (fără limită de utilizare a memoriei). +.RE +.IP "" +Pentru \fBxz\fP pe 32 de biți există un caz special: dacă \fIlimita\fP ar fi peste +\fB4020MiB\fP, \fIlimita\fP este stabilită la \fB4020MiB\fP. Pe MIPS32 este +stabilită în schimb la \fB2000MiB\fP; (valorile \fB0\fP și \fBmax\fP nu sunt afectate +de acest lucru \-\- o caracteristică similară nu există pentru +decomprimare). Acest lucru poate fi util atunci când un executabil pe 32 de +biți are acces la un spațiu de adrese de 4Gio (2Gio pe MIPS32), se speră că +nu produce daune în alte situații. +.IP "" +Consultați și secțiunea \fBUtilizarea memoriei\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimare. Acest lucru +afectează și modul \fB\-\-list\fP. Dacă operațiunea nu este posibilă fără a +depăși \fIlimita\fP, \fBxz\fP va afișa o eroare și decomprimarea fișierului va +eșua. Consultați \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalitățile +posibile de a specifica \fIlimita\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP +Stabilește o limită de utilizare a memoriei pentru decomprimarea cu mai +multe fire de execuție. Acest lucru poate afecta doar numărul de fire de +execuție; acest lucru nu îl va face niciodată pe \fBxz\fP să refuze +decomprimarea unui fișier. Dacă \fIlimita\fP este prea scăzută pentru a permite +orice mod cu mai multe fire de execuție, \fIlimita\fP este ignorată și \fBxz\fP va +continua în modul cu un singur fir de execuție. Rețineți că, dacă se +folosește și opțiunea \fB\-\-memlimit\-decompress\fP, se va aplica întotdeauna +atât modurilor cu un singur fir de execuție, cât și modurilor cu mai multe +fire de execuție și astfel \fIlimita\fP efectivă pentru modul cu mai multe fire +de execuție nu va fi niciodată mai mare decât limita stabilită cu opțiunea +\fB\-\-memlimit\-decompress\fP. +.IP "" +Spre deosebire de celelalte opțiuni de limită de utilizare a memoriei, +opțiunea \fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP are o \fIlimită\fP implicită +specifică sistemului. Comanda \fBxz \-\-info\-memory\fP poate fi folosită pentru a +vedea valoarea curentă. +.IP "" +Această opțiune și valoarea ei implicită există deoarece, fără nicio limită, +decomprimarea cu (mai multe) fire de execuție ar putea ajunge să aloce o +cantitate „nebună” de memorie cu unele fișiere de intrare. Dacă \fIlimita\fP +implicită este prea scăzută pe sistemul dumneavoastră, nu ezitați să +creșteți \fIlimita\fP, dar niciodată să nu o stabiliți la o valoare mai mare +decât cantitatea de memorie RAM utilizabilă și cu niște fișiere de intrare +adecvate, \fBxz\fP va încerca să utilizeze acea cantitate de memorie chiar și +cu un număr redus de fire de execuție. Rularea lui \fBxz\fP cu depășirea +cantității de memorie fizice(RAM) sau a celei de interschimb(swap) nu va +îmbunătăți performanța de decomprimare. +.IP "" +Consultați opțiunea \fB\-\-memlimit\-compress=\fP\fIlimita\fP pentru modalități +posibile de a specifica \fIlimita\fP. Stabilirea \fIlimitei\fP la \fB0\fP +restabilește \fIlimita\fP la valoarea implicită specifică sistemului. +.TP +\fB\-M\fP \fIlimita\fP, \fB\-\-memlimit=\fP\fIlimita\fP, \fB\-\-memory=\fP\fIlimita\fP +Aceasta este echivalentă cu specificarea opțiunilor: +\fB\-\-memlimit\-compress=\fP\fIlimita\fP \fB\-\-memlimit\-decompress=\fP\fIlimita\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIlimita\fP. +.TP +\fB\-\-no\-adjust\fP +Afișează o eroare și iese dacă limita de utilizare a memoriei nu poate fi +îndeplinită fără ajustarea parametrilor care afectează ieșirea +comprimată. Adică, acest lucru împiedică \fBxz\fP să comute codificatorul din +modul cu mai multe fire de execuție în modul cu un singur fir de execuție și +să reducă dimensiunea dicționarului LZMA2. Chiar și atunci când această +opțiune este utilizată, numărul de fire de execuție poate fi redus pentru a +îndeplini limita de utilizare a memoriei, deoarece aceasta nu va afecta +comprimarea. +.IP "" +Ajustarea automată este întotdeauna dezactivată la crearea fluxurilor brute +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fInumăr\fP, \fB\-\-threads=\fP\fInumăr\fP +Specifică numărul de fire de execuție de utilizat. Stabilirea \fInumărului\fP +la valoarea specială \fB0\fP, face ca \fBxz\fP să utilizeze până la atâtea fire de +execuție câte procesoare sunt în sistem. Numărul real de fire de execuție +poate fi mai mic decât \fInumăr\fP dacă fișierul de intrare nu este suficient +de mare pentru a trece la modul cu mai multe fire de execuție cu parametrii +dați, sau dacă folosirea mai multor fire de execuție ar depăși limita de +utilizare a memoriei. +.IP "" +Operațiile de comprimare cu un singur fir de execuție și cele cu mai multe +fire de execuție produc ieșiri diferite. Comprimarea cu un singur fir de +execuție va oferi cea mai mică dimensiune a fișierului, dar numai ieșirea de +la comprimarea cu mai multe fire de execuție poate fi decomprimată folosind +mai multe fire. Stabilirea \fInumărului\fP la \fB1\fP va determina ca \fBxz\fP să +folosească modul cu un singur fir de execuție. Stabilirea \fInumărului\fP la +orice altă valoare, inclusiv \fB0\fP, va determina ca \fBxz\fP să folosească +comprimarea cu mai multe fire de execuție chiar dacă sistemul acceptă doar +un fir hardware; (\fBxz\fP 5.2.x folosește modul cu un singur fir de execuție +în această situație). +.IP "" +Pentru a utiliza modul cu mai multe fire de execuție cu un singur fir, +stabiliți \fInumărul\fP la \fB+1\fP. Prefixul \fB+\fP nu are efect cu alte valori +decât \fB1\fP. O limită de utilizare a memoriei poate face în continuare \fBxz\fP +să treacă în modul cu un singur fir, cu excepția cazului în care este +utilizată opțiunea \fB\-\-no\-adjust\fP. Suportul pentru prefixul \fB+\fP a fost +adăugat în \fBxz\fP 5.4.0. +.IP "" +Dacă a fost solicitat un număr automat de fire și nu a fost specificată +nicio limită de utilizare a memoriei, atunci o limită „maleabilă” implicită +specifică sistemului va fi utilizată pentru a limita eventual numărul de +fire de execuție. Este o limită „maleabilă” în sensul că este ignorată dacă +numărul de fire devine unul, astfel o limită „maleabilă” nu va opri +niciodată \fBxz\fP să comprime sau să decomprime. Această limită „maleabilă” +implicită nu va face \fBxz\fP să treacă de la modul cu mai multe fire de +execuție la modul cu un singur fir de execuție. Limitele active pot fi +văzute rulând comanda \fBxz \-\-info\-memory\fP. +.IP "" +În prezent, singura metodă de procesare cu fire de execuție este împărțirea +intrării în blocuri și comprimarea lor independent unul de +celălalt. Dimensiunea implicită a blocului depinde de nivelul de comprimare +și poate fi înlocuită cu opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Decomprimarea cu fire de execuție funcționează numai pe fișierele care +conțin mai multe blocuri cu informații despre dimensiune în antetele +blocurilor. Toate fișierele suficient de mari comprimate în modul cu mai +multe fire de execuție îndeplinesc această condiție, dar fișierele +comprimate în modul cu un singur fir de execuție nu o îndeplinesc chiar dacă +a fost folosită opțiunea \fB\-\-block\-size=\fP\fIdimensiune\fP. +.IP "" +Valoarea implicită pentru \fIfire de execuție\fP este \fB0\fP. În \fBxz\fP 5.4.x și +mai vechi, valoarea implicită este \fB1\fP. +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Un lanț de filtrare personalizat permite specificarea parametrilor de +comprimare în detaliu, în loc să se bazeze pe cei asociați opțiunilor +prestabilite. Când este specificat un lanț de filtrare personalizat, +opțiunile prestabilite (\fB\-0\fP \&...\& \fB\-9\fP și \fB\-\-extreme\fP) de mai devreme +din linia de comandă sunt uitate. Dacă o opțiune prestabilită este +specificată după una sau mai multe opțiuni de lanț de filtrare personalizat, +noua prestabilire intră în vigoare și opțiunile lanțului de filtrare +personalizat, specificate mai devreme sunt uitate. +.PP +Un lanț de filtrare este comparabil cu conductele din linia de comandă. La +comprimare, intrarea necomprimată merge la primul filtru, a cărui ieșire +merge la următorul filtru (dacă există). Ieșirea ultimului filtru este +scrisă în fișierul comprimat. Numărul maxim de filtre din lanț este de +patru, dar de obicei un lanț de filtrare are doar unul sau două filtre. +.PP +Multe filtre au limitări în ceea ce privește locul în care se pot afla în +lanțul de filtrare: unele filtre pot funcționa doar ca ultimul filtru din +lanț, altele doar ca non\-ultim filtru și unele funcționează în orice poziție +din lanț. În funcție de filtru, această limitare este fie inerentă +proiectării filtrului, fie există pentru a preveni problemele de securitate. +.PP +Un lanț de filtre personalizat poate fi specificat în două moduri +diferite. Opțiunile \fB\-\-filters=\fP\fIfiltre\fP și \fB\-\-filters1=\fP\fIfiltre\fP +\&...\& \fB\-\-filters9=\fP\fIfiltre\fP permit specificarea unui întreg lanț de +filtre într\-o singură opțiune, folosind sintaxa șirului de filtre +liblzma. Alternativ, un lanț de filtre poate fi specificat prin utilizarea +uneia sau mai multor opțiuni de filtrare individuale în ordinea în care sunt +dorite în lanțul de filtre. Adică, ordinea opțiunilor de filtrare +individuale este semnificativă! La decodificarea fluxurilor brute +(\fB\-\-format=raw\fP), lanțul de filtre trebuie să fie specificat în aceeași +ordine în care a fost specificat la comprimare. Orice filtru individual sau +opțiuni presetate specificate înainte de opțiunea de lanț complet +(\fB\-\-filters=\fP\fIfiltre\fP) vor fi uitate. Filtrele individuale specificate +după opțiunea „lanț complet” vor reinițializa lanțul de filtre. +.PP +Atât opțiunile de filtrare completă, cât și cele de filtrare individuală +acceptă \fIopțiuni\fP specifice filtrului sub forma unei liste separate prin +virgule. Se ignoră virgulele suplimentare din \fIopțiuni\fP. Fiecare opțiune +are o valoare implicită, deci specificați\-le pe cele pe care doriți să le +modificați. +.PP +Pentru a vedea întregul lanț de filtre și \fIopțiuni\fP, utilizați \fBxz \-vv\fP +(adică folosiți \fB\-\-verbose\fP de două ori). Acest lucru funcționează și +pentru vizualizarea opțiunilor lanțului de filtre utilizate de valorile +prestabilite. +.TP +\fB\-\-filters=\fP\fIfiltre\fP +Specificați întregul lanț de filtre sau o presetare într\-o singură +opțiune. Fiecare filtru poate fi separat prin spații sau două liniuțe +(\fB\-\-\fP). Este posibil să fie necesar ca \fIfiltrele\fP să fie puse între +ghilimele în linia de comandă a shell\-ului pentru a fi analizate ca o +singură opțiune. Pentru a indica \fIopțiuni\fP, utilizați \fB:\fP sau \fB=\fP. O +presetare poate fi prefixată cu un \fB\-\fP și urmată de zero sau mai multe +indicatoare. Singurul indicator suportat este \fBe\fP pentru a aplica aceleași +opțiuni ca și \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfiltre\fP ... \fB\-\-filters9\fP=\fIfiltre\fP +Specifică până la nouă lanțuri de filtre suplimentare care pot fi utilizate +cu \fB\-\-block\-list\fP. +.IP "" +De exemplu, atunci când se comprimă o arhivă cu fișiere executabile urmate +de fișiere text, partea executabilă ar putea utiliza un lanț de filtre cu un +filtru BCJ, iar partea de text doar filtrul LZMA2. +.TP +\fB\-\-filters\-help\fP +Afișează un mesaj de ajutor care descrie modul de specificare a presetărilor +și a lanțurilor de filtre personalizate în opțiunile \fB\-\-filters\fP și +\fB\-\-filters1=\fP\fIfiltre\fP \&...\& \fB\-\-filters9=\fP\fIfiltre\fP și iese. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă filtrul LZMA1 sau LZMA2 la lanțul de filtre. Aceste filtre pot fi +folosite doar ca ultimul filtru din lanț. +.IP "" +LZMA1 este un filtru vechi, care este acceptat aproape exclusiv datorită +formatului de fișier vechi \fB.lzma\fP, care acceptă numai LZMA1. LZMA2 este o +versiune actualizată a LZMA1 pentru a rezolva unele probleme practice ale +LZMA1. Formatul \fB.xz\fP folosește LZMA2 și nu acceptă deloc LZMA1. Viteza de +comprimare și rapoartele LZMA1 și LZMA2 sunt practic aceleași. +.IP "" +LZMA1 și LZMA2 au același set de \fIopțiuni\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIprestabilit\fP +Reconfigurează toate \fIopțiunile\fP LZMA1 sau LZMA2 la +\fIprestabilit\fP. \fIprestabilit\fP constă dintr\-un număr întreg, care poate fi +urmat de modificatori prestabiliți cu o singură literă. Numărul întreg +poate fi de la \fB0\fP la \fB9\fP, potrivindu\-se cu opțiunile liniei de comandă +\fB\-0\fP \&...\& \fB\-9\fP. Singurul modificator acceptat în prezent este \fBe\fP, +care se potrivește cu \fB\-\-extreme\fP. Dacă nu este specificat \fBprestabilit\fP, +valorile implicite ale \fIopțiunilor\fP LZMA1 sau LZMA2 sunt preluate din +prestabilirea \fB6\fP. +.TP +\fBdict=\fP\fIdimensiunea\fP +\fIDimensiunea\fP dicționarului (istoricul memoriei tampon) indică câți octeți +din datele necomprimate recent procesate sunt păstrați în +memorie. Algoritmul încearcă să găsească secvențe de octeți care se repetă +(potriviri) în datele necomprimate și să le înlocuiască cu referințe la +datele aflate în prezent în dicționar. Cu cât dicționarul este mai mare, cu +atât este mai mare șansa de a găsi o potrivire. Astfel, creșterea +\fIdimensiunii\fP dicționarului îmbunătățește de obicei raportul de comprimare, +dar un dicționar mai mare decât fișierul necomprimat este risipă de memorie. +.IP "" +\fIDimensiunea\fPtipică a dicționarului este de la 64Kio până la 64Mio. Minimul +este de 4Kio. Maximul pentru compresie este în prezent de 1,5Gio +(1536Mio). Decomprimarea acceptă deja dicționare cu până la un octet mai +puțin de 4Gio, care este maximul pentru formatele de flux LZMA1 și LZMA2. +.IP "" +\fIDimensiunea\fP dicționarului și găsitorul de potriviri (match finder) → +(\fImf\fP) determină împreună utilizarea memoriei de către codificatorul LZMA1 +sau LZMA2. Aceeași \fIdimensiune\fP a dicționarului (sau mai mare) care a fost +utilizată la comprimare, este necesară pentru decomprimare, astfel încât +utilizarea memoriei de către decodificator este determinată de dimensiunea +dicționarului utilizată la comprimare. Antetele \fB.xz\fP stochează +\fIdimensiunea\fP dicționarului fie ca 2^\fIn\fP, fie ca 2^\fIn\fP + 2^(\fIn\fP\-1), deci +aceste \fIdimensiuni\fP sunt oarecum preferate pentru comprimare. Alte +\fIdimensiuni\fP vor fi rotunjite atunci când sunt stocate în anteturile +\&\fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Specifică numărul de biți de context literal. Minimul este 0 și maximul este +4; implicit este 3. În plus, suma \fIlc\fP și \fIlp\fP nu trebuie să depășească +4. +.IP "" +Toți octeții care nu pot fi codificați ca potriviri sunt codificați ca +literali. Adică, literalii sunt pur și simplu octeți de 8 biți care sunt +codificați unul câte unul. +.IP "" +Codificarea literală presupune că cei mai mari biți \fIlc\fP ai octetului +anterior necomprimat se corelează cu octetul următor. De exemplu, în textul +tipic englezesc, o literă mare este adesea urmată de o literă mică, iar o +literă mică este urmată de obicei de o altă literă mică. În setul de +caractere US\-ASCII, cei mai mari trei biți sunt 010 pentru literele mari și +011 pentru literele mici. Când \fIlc\fP este cel puțin 3, codificarea literală +poate profita de această proprietate în datele necomprimate. +.IP "" +Valoarea implicită (3) este de obicei bună. Dacă doriți o comprimare maximă, +testați \fBlc=4\fP. Uneori ajută puțin, iar uneori înrăutățește comprimarea +\&. Dacă o agravează, încercați de\-asemeni cu \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Specifică numărul de biți de poziție literală. Minimul este 0 și maximul +este 4; implicit este 0. +.IP "" +\fILp\fP afectează ce fel de aliniere în datele necomprimate este presupusă la +codificarea literalelor. Consultați argumentul \fIpb\fP de mai jos pentru mai +multe informații despre aliniere. +.TP +\fBpb=\fP\fIpb\fP +Specifică numărul de biți de poziție. Minimul este 0 și maximul este 4; +implicit este 2. +.IP "" +\fIPb\fP afectează ce fel de aliniere în datele necomprimate este presupusă în +general. Valoarea implicită înseamnă alinierea pe patru octeți +(2^\fIpb\fP=2^2=4), care este adesea o alegere bună atunci când nu există o +ipoteză mai bună. +.IP "" +Când alinierea este cunoscută, definirea lui \fIpb\fP în mod corespunzător +poate reduce puțin dimensiunea fișierului. De exemplu, cu fișierele text cu +aliniere pe un octet (US\-ASCII, ISO\-8859\-*, UTF\-8), definirea \fBpb=0\fP poate +îmbunătăți ușor comprimarea. Pentru textul UTF\-16, \fBpb=1\fP este o alegere +bună. Dacă alinierea este un număr impar, cum ar fi 3 octeți, \fBpb=0\fP ar +putea fi cea mai bună alegere. +.IP "" +Chiar dacă alinierea presupusă poate fi ajustată cu \fIpb\fP și \fIlp\fP, LZMA1 și +LZMA2 încă favorizează ușor alinierea pe 16 octeți. Ar putea fi demn de luat +în considerare atunci când proiectați formate de fișiere care pot fi adesea +comprimate cu LZMA1 sau LZMA2. +.TP +\fBmf=\fP\fImf\fP +Căutarea potrivirilor are un efect major asupra vitezei codificatorului, +utilizării memoriei și raportului de comprimare. De obicei, găsitorii de +potriviri din lanțul sumelor de control sunt mai rapizi decât găsitorii de +potriviri din arborele binar. Valoarea implicită depinde de \fIprestabilit\fP: +0 folosește \fBhc3\fP, 1\(en3 folosește \fBhc4\fP, iar restul folosește \fBbt4\fP. +.IP "" +Sunt acceptate următoarele opțiuni de căutare de potriviri. Formulele de +utilizare a memoriei de mai jos sunt aproximări estimative, care se apropie +cel mai mult de realitate atunci când \fIdict\fP este o putere a lui doi. +.RS +.TP +\fBhc3\fP +Lanț de sumă de control, cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 5.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBhc4\fP +Lanț de sumă de control, cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 7.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 6.5 (dacă \fIdict\fP > 32 Mio) +.TP +\fBbt2\fP +Arbore binar cu suma de control de 2 octeți +.br +Valoarea minimă pentru \fInice\fP: 2 +.br +Utilizarea memoriei: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Arbore binar cu suma de control de 2 și 3 octeți +.br +Valoarea minimă pentru \fInice\fP: 3 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 16 Mio); +.br +\fIdict\fP * 9.5 + 64 MiB (dacă \fIdict\fP > 16 Mio) +.TP +\fBbt4\fP +Arbore binar cu suma de control de 2, 3 și 4 octeți +.br +Valoarea minimă pentru \fInice\fP: 4 +.br +Utilizarea memoriei: +.br +\fIdict\fP * 11.5 (dacă \fIdict\fP <= 32 Mio); +.br +\fIdict\fP * 10.5 (dacă \fIdict\fP > 32 Mio) +.RE +.TP +\fBmode=\fP\fImod\fP +Comprimarea \fImod\fP specifică metoda de analiză a datelor produse de +găsitorul de potriviri. \fIModurile\fP acceptate sunt \fBfast\fP(rapid) și +\fBnormal\fP. Valoarea implicită este \fBfast\fP pentru \fIprestabiliri\fP 0\(en3 și +\fBnormal\fP pentru \fIprestabiliri\fP 4\(en9. +.IP "" +De obicei, \fBfast\fP este folosit cu instrumentele de căutare de potriviri ale +lanțului de sume de control, și \fBnormal\fP cu instrumentele de căutare de +potriviri din arborele binar. Aceasta este și ceea ce fac \fIprestabiririle\fP. +.TP +\fBnice=\fP\fInice\fP +Specifică ceea ce este considerat a fi o lungime bună(nice) pentru o +potrivire. Odată ce este găsită o potrivire de cel puțin \fInice\fP octeți, +algoritmul nu mai caută după potriviri posibile mai bune. +.IP "" +\fINice\fP poate fi de 2\(en273 octeți. Valorile mai mari tind să ofere un +raport de comprimare mai bun în detrimentul vitezei. Valoarea implicită +depinde de \fIprestabilit\fP. +.TP +\fBdepth=\fP\fIadâncimea\fP +Specifică adâncimea maximă de căutare în găsitorul de potriviri. Valoarea +implicită este valoarea specială de 0, ceea ce face ca instrumentul de +comprimare să determine o \fIadâncime\fP rezonabilă pornind de la valorile +\fImf\fP și \fInice\fP. +.IP "" +\fIAdâncimea\fP rezonabilă pentru lanțuri de sumă de control este 4\(en100 și +16\(en1000 pentru arbori binari. Folosirea unor valori foarte mari pentru +\fIadâncime\fP poate face codificatorul extrem de lent cu unele +fișiere. Evitați să stabiliți \fIadâncimea\fP la valori peste 1000, cu excepția +cazului în care sunteți pregătit să întrerupeți comprimarea în cazul în care +durează prea mult. +.RE +.IP "" +La decodificarea fluxurilor brute (\fB\-\-format=raw\fP), LZMA2 are nevoie doar +de \fIdimensiunea\fP dicționarului. LZMA1 are nevoie de asemenea de \fIlc\fP, +\fIlp\fP și \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIopțiuni\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIopțiuni\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIopțiuni\fP] +.PD +Adaugă un filtru de ramură/apel/salt (branch/call/jump ⟶ „BCJ”) la lanțul de +filtre. Aceste filtre pot fi utilizate numai ca un filtru care nu este +ultimul din lanțul de filtrare. +.IP "" +Un filtru BCJ convertește adresele relative din codul mașinii în omoloagele +lor absolute. Acest lucru nu modifică dimensiunea datelor, dar crește +redundanța, ceea ce poate ajuta LZMA2 să producă fișier \fB.xz\fP cu 0\(en15\ % +mai mic. Filtrele BCJ sunt întotdeauna reversibile, deci folosind un filtru +BCJ pentru tipul greșit de date nu provoacă nicio pierdere de date, deși +poate înrăutăți puțin raportul de comprimare. Filtrele BCJ sunt foarte +rapide și folosesc o cantitate nesemnificativă de memorie. +.IP "" +Aceste filtre BCJ au probleme cunoscute legate de raportul de comprimare: +.RS +.IP \(bu 3 +Unele tipuri de fișiere care conțin cod executabil (de exemplu, fișiere +obiect, biblioteci statice și module de kernel Linux) au adresele din +instrucțiuni completate cu valori de umplere. Aceste filtre BCJ vor face în +continuare conversia adresei, ceea ce va înrăutăți comprimarea cu aceste +fișiere. +.IP \(bu 3 +Dacă pe o arhivă este aplicat un filtru BCJ, este posibil ca raportul de +comprimare să fie mai rău decât la neutilizarea unui filtru BCJ. De exemplu, +dacă există executabile similare sau chiar identice, filtrarea va face +probabil fișierele mai puțin asemănătoare și astfel comprimarea este mai +proastă. Conținutul fișierelor neexecutabile din aceeași arhivă poate conta +și el. În practică, trebuie să încercați cu și fără filtru BCJ pentru a +vedea care rezultat este mai bun în fiecare situație. +.RE +.IP "" +Seturi de instrucțiuni diferite au o aliniere diferită: fișierul executabil +trebuie aliniat la un multiplu al acestei valori în datele de intrare pentru +ca filtrul să funcționeze. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filtru;Aliniere;Note +x86;1;x86 pe 32 de biți +;;sau 64 de biți +ARM;4; +ARM\-Thumb;2; +ARM64;4;alinierea pe 4096\-octeți +;;este cea mai bună +PowerPC;4;Doar big endian +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Deoarece datele filtrate prin BCJ sunt de obicei comprimate cu LZMA2, +raportul de comprimare poate fi ușor îmbunătățit dacă opțiunile LZMA2 sunt +definite pentru a se potrivi cu alinierea filtrului BCJ selectat. Exemple: +.RS +.IP \(bu 3 +Filtrul IA\-64 are o aliniere de 16 octeți, astfel încât \fBpb=4,lp=4,lc=0\fP +este alegere adecvată cu LZMA2 (2^4=16). +.IP \(bu 3 +Codul RISC\-V are o aliniere pe 2 sau 4 octeți, depinzând de faptul că +fișierul conține instrucțiuni comprimate pe 16 biți (extensia C) sau +nu. Atunci când se utilizează instrucțiuni pe 16 biți, \fBpb=2,lp=1,lc=3\fP sau +\fBpb=1,lp=1,lc=3\fP este o alegere bună. Atunci când nu sunt prezente +instrucțiuni pe 16 biți, \fBpb=2,lp=2,lc=2\fP este cea mai bună +alegere. \fBreadelf \-h\fP poate fi utilizată pentru a verifica dacă „RVC” apare +în linia „Indicatori". +.IP \(bu 3 +ARM64 este întotdeauna aliniat pe 4 octeți, astfel încât \fBpb=2,lp=2,lc=2\fP +este cea mai bună alegere. +.IP \(bu 3 +Filtrul x86 este o excepție. De obicei, este bine să rămâneți la valorile +implicite ale LZMA2 (\fBpb=2,lp=0,lc=3\fP) atunci când comprimați executabile +x86. +.RE +.IP "" +Toate filtrele BCJ acceptă același \fIopțiuni\fP: +.RS +.TP +\fBstart=\fP\fIpoziție\fP +Specifică \fIpoziția\fP de pornire care este utilizată la conversia între +adresele relative și absolute. \fIPoziția\fP trebuie să fie un multiplu al +alinierii filtrului (consultați tabelul de mai sus). Valoarea implicită +este zero. În practică, valoarea implicită este bună; specificarea unei +\fIpoziții\fP personalizate nu este aproape niciodată utilă. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIopțiuni\fP] +Adaugă filtrul Delta în lanțul de filtrare. Filtrul Delta poate fi folosit +doar ca un filtru care nu este ultimul în lanțul de filtrare. +.IP "" +În prezent, este acceptat doar calculul delta simplu de octeți. Poate fi +util la comprimarea, de exemplu, a imaginilor bitmap necomprimate sau a +sunetului PCM necomprimat. Cu toate acestea, algoritmii cu scop special pot +da rezultate semnificativ mai bune decât Delta + LZMA2. Acest lucru este +valabil mai ales în cazul audio, care se comprimă mai repede și mai bine, de +exemplu, cu \fBflac\fP(1). +.IP "" +\fIOpțiuni\fP acceptate: +.RS +.TP +\fBdist=\fP\fIdistanța\fP +Specifică \fIdistanța\fP calculului delta în octeți. \fIDistanța\fP trebuie să fie +1\(en256. Valoarea implicită este 1. +.IP "" +De exemplu, cu \fBdist=2\fP și intrare de opt octeți: A1 B1 A2 B3 A3 B5 A4 B7, +ieșirea va fi: A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Alte opțiuni" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Suprimă avertismentele și notificările. Specificați acest lucru de două ori +pentru a suprima și erorile. Această opțiune nu are niciun efect asupra +stării de ieșire. Adică, chiar dacă o avertizare a fost suprimată, starea de +ieșire pentru a indica o avertizare este încă utilizată. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Oferă informații detaliate. Dacă ieșirea de eroare standard este conectată +la un terminal, \fBxz\fP va afișa un indicator de progres. Specificarea +opțiunii \fB\-\-verbose\fP de două ori, va avea ca rezultat oferirea de +informații și mai detaliate. +.IP "" +Indicatorul de progres afișează următoarele informații: +.RS +.IP \(bu 3 +Procentul de completare este afișat dacă se cunoaște dimensiunea fișierului +de intrare. Adică, procentul nu poate fi afișat la procesarea fișierului +prin conducte(pipe). +.IP \(bu 3 +Cantitatea de date comprimate produse (comprimare) sau consumate +(decomprimare). +.IP \(bu 3 +Cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare). +.IP \(bu 3 +Raportul de comprimare, care se calculează împărțind cantitatea de date +comprimate procesate până acum la cantitatea de date necomprimate procesate +până acum. +.IP \(bu 3 +Viteza de comprimare sau decomprimare. Aceasta este măsurată drept +cantitatea de date necomprimate consumate (comprimare) sau produse +(decomprimare) pe secundă. Este afișată după ce au trecut câteva secunde de +când \fBxz\fP a început procesarea fișierului. +.IP \(bu 3 +Timpul scurs în format M:SS sau H:MM:SS. +.IP \(bu 3 +Timpul rămas estimat este afișat numai atunci când dimensiunea fișierului de +intrare este cunoscută și au trecut deja câteva secunde de când \fBxz\fP a +început procesarea fișierului. Ora este afișată într\-un format mai puțin +precis, care nu are niciodată două puncte, de exemplu, 2 min 30 s. +.RE +.IP "" +Când ieșirea de eroare standard nu este un terminal, \fB\-\-verbose\fP va face +\fBxz\fP să imprime numele fișierului, dimensiunea comprimată, dimensiunea +necomprimată, raportul de comprimare și, eventual, de asemenea, viteza și +timpul scurs pe o singură linie la ieșirea de eroare standard după +comprimarea sau decomprimarea fișierului. Viteza și timpul scurs sunt +incluse numai atunci când operațiunea a durat cel puțin câteva secunde. Dacă +operațiunea nu s\-a încheiat, de exemplu, din cauza întreruperii din partea +utilizatorului, se imprimă și procentul de completare dacă se cunoaște +dimensiunea fișierului de intrare. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Nu comută starea de ieșire la 2 chiar dacă a fost detectată o condiție care +merită avertizată. Această opțiune nu afectează nivelul de detaliere al +informațiilor, astfel încât atât \fB\-\-quiet\fP cât și \fB\-\-no\-warn\fP trebuie +folosite pentru a nu afișa avertismente și pentru a nu modifica starea de +ieșire. +.TP +\fB\-\-robot\fP +Afișează mesajele într\-un format care poate fi analizat de mașină. Acest +lucru are scopul de a ușura scrierea interfețelor în care se dorește să se +folosească \fBxz\fP în loc de liblzma, ceea ce poate fi cazul cu diferite +scripturi. Ieșirea cu această opțiune activată este menită să fie stabilă în +toate versiunile \fBxz\fP. Consultați secțiunea \fBMOD ROBOT\fP pentru detalii. +.TP +\fB\-\-info\-memory\fP +Afișează, într\-un format care poate fi citit de om, câtă memorie fizică +(RAM) și câte fire de execuție de procesor \fBxz\fP crede că are sistemul și +limitele de utilizare a memoriei pentru comprimare și decomprimare și iese +cu succes. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor care descrie opțiunile cele mai frecvent +utilizate și iese cu succes. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Afișează un mesaj de ajutor care descrie toate caracteristicile \fBxz\fP și +iese cu succes +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxz\fP și liblzma într\-un format care poate fi +citit de om. Pentru a obține rezultate analizabile de mașină, specificați +\fB\-\-robot\fP înainte de \fB\-\-version\fP. +. +.SH "MOD ROBOT" +Modul robot este activat cu opțiunea \fB\-\-robot\fP. Face ieșirea lui \fBxz\fP mai +ușor de analizat de către alte programe. În prezent, opțiunea \fB\-\-robot\fP +este acceptată numai împreună cu opțiunile \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP, și \fB\-\-version\fP. Va fi acceptată pentru comprimare și +decomprimare în viitor. +. +.SS "Modul listă" +\fBxz \-\-robot \-\-list\fP utilizează o ieșire separată de tabulatori. Prima +coloană a fiecărei linii are un șir care indică tipul de informații găsite +pe acea linie: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Aceasta este întotdeauna prima linie când începe să se listeze un fișier. A +doua coloană de pe linie este numele fișierului. +.TP +\fBfile\fP +Această linie conține informații generale despre fișierul \fB.xz\fP. Această +linie este întotdeauna tipărită după linia \fBname\fP. +.TP +\fBstream\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBstream\fP câte fluxuri există +în fișierul \fB.xz\fP. +.TP +\fBblock\fP +Acest tip de linie este utilizat numai atunci când a fost specificată +opțiunea \fB\-\-verbose\fP. Există tot atâtea linii \fBblock\fP câte blocuri există +în fișierul \fB.xz\fP. Liniile \fBblock\fP sunt afișate după toate liniile +\fBstream\fP; tipurile diferite de linii nu sunt intercalate. +.TP +\fBsummary\fP +Acest tip de linie este folosit numai atunci când opțiunea \fB\-\-verbose\fP a +fost specificată de două ori. Această linie este afișată după toate liniile +\fBblock\fP. Ca și linia \fBfile\fP, linia \fBsummary\fP conține informații generale +despre fișierul \fB.xz\fP. +.TP +\fBtotals\fP +Această linie este întotdeauna ultima linie din lista afișată la +ieșire. Aceasta arată numărul total și dimensiunile. +.PP +Coloanele din liniile \fBfile\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri din fișier +.IP 3. 4 +Numărul total de blocuri din fluxuri +.IP 4. 4 +Dimensiunea comprimată a fișierului +.IP 5. 4 +Dimensiunea necomprimată a fișierului +.IP 6. 4 +Raportul de comprimare, de exemplu, \fB0,123\fP. Dacă raportul este peste +9,999, în locul raportului sunt afișate trei liniuțe (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Lista de nume de verificare a integrității, separate prin +virgule. Următoarele șiruri sunt utilizate pentru tipurile de verificare +cunoscute: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP și \fBSHA\-256\fP. Pentru tipurile de +verificări necunoscute, se utilizează \fBUnknown\-\fP\fIN\fP, unde \fIN\fP este ID\-ul +de verificare ca număr zecimal (una sau două cifre). +.IP 8. 4 +Dimensiunea totală a umpluturii fluxului din fișier +.RE +.PD +.PP +Coloanele din liniile \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului (primul flux este 1) +.IP 3. 4 +Numărul de blocuri din flux +.IP 4. 4 +Poziția de pornire a comprimării +.IP 5. 4 +Poziția de pornire a decomprimării +.IP 6. 4 +Dimensiune comprimată (nu include umplutura fluxului) +.IP 7. 4 +Dimensiune necomprimată +.IP 8. 4 +Raport de comprimare +.IP 9. 4 +Numele verificării de integritate +.IP 10. 4 +Dimensiunea umpluturii fluxului +.RE +.PD +.PP +Coloanele din liniile \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul fluxului care conține acest bloc +.IP 3. 4 +Numărul blocului în raport cu începutul fluxului (primul bloc este 1) +.IP 4. 4 +Numărul blocului în raport cu începutul fișierului +.IP 5. 4 +Poziția de pornire a comprimării în raport cu începutul fișierului +.IP 6. 4 +Poziția de pornire necomprimată în raport cu începutul fișierului +.IP 7. 4 +Dimensiunea totală comprimată a blocului (include antetele) +.IP 8. 4 +Dimensiune necomprimată +.IP 9. 4 +Raport de comprimare +.IP 10. 4 +Numele verificării de integritate +.RE +.PD +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, coloane +suplimentare sunt incluse pe liniile \fBblock\fP. Acestea nu sunt afișate cu o +singură specificare a opțiunii \fB\-\-verbose\fP, deoarece obținerea acestor +informații necesită multe căutări și, prin urmare, poate fi lentă: +.PD 0 +.RS +.IP 11. 4 +Valoarea verificării integrității în hexazecimal +.IP 12. 4 +Dimensiunea antetului blocului +.IP 13. 4 +Indicatori de bloc: \fBc\fP indică faptul că este prezentă dimensiunea +comprimată, iar \fBu\fP indică faptul că este prezentă dimensiunea +necomprimată. Dacă indicatorul nu este determinat, este afișată o liniuță +(\fB\-\fP) pentru a menține lungimea șirului fixă. Pot fi adăugate noi +indicatoare la sfârșitul șirului, în viitor. +.IP 14. 4 +Dimensiunea datelor comprimate reale din bloc (acest lucru exclude antetul +blocului, umplutura blocului și câmpurile de verificare) +.IP 15. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest bloc cu +această versiune \fBxz\fP +.IP 16. 4 +Lanț de filtrare. Rețineți că majoritatea opțiunilor utilizate în timpul +comprimării nu pot fi cunoscute, deoarece doar opțiunile necesare pentru +decomprimare sunt stocate în anteturile \fB.xz\fP. +.RE +.PD +.PP +Coloanele din liniile \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Cantitatea de memorie (în octeți) necesară pentru a decomprima acest fișier +cu această versiune \fBxz\fP +.IP 3. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Coloanele din linia \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Numărul de fluxuri +.IP 3. 4 +Numărul de blocuri +.IP 4. 4 +Dimensiunea comprimată +.IP 5. 4 +Dimensiune necomprimată +.IP 6. 4 +Raportul mediu de comprimare +.IP 7. 4 +Lista de nume de verificare a integrității, separate prin virgule, care au +fost prezente în fișiere +.IP 8. 4 +Dimensiunea umpluturii fluxului +.IP 9. 4 +Numărul de fișiere. Aceasta este aici pentru a păstra ordinea coloanelor +anterioare la fel ca pe liniile \fBfile\fP. +.PD +.RE +.PP +Dacă opțiunea \fB\-\-verbose\fP a fost specificată de două ori, pe linia +\fBtotals\fP sunt incluse coloane suplimentare: +.PD 0 +.RS +.IP 10. 4 +Cantitatea maximă de memorie (în octeți) necesară pentru a decomprima +fișierele cu această versiune \fBxz\fP +.IP 11. 4 +\fByes\fP sau \fBno\fP indicând dacă toate antetele blocurilor au atât dimensiunea +comprimată, cât și dimensiunea necomprimată stocate în ele +.PP +\fIÎncepând cu\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Versiunea \fBxz\fP minimă necesară pentru a decomprima fișierul +.RE +.PD +.PP +Versiunile viitoare pot adăuga noi tipuri de linii și pot fi adăugate +coloane noi la tipurile de linii existente, dar coloanele existente nu vor +fi modificate. +. +.SS "Ajutor pentru filtrare" +\fBxz \-\-robot \-\-filters\-help\fP afișează filtrele acceptate în următorul +format: +.PP +\fIfiltru\fP\fB:\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>,\fP\fIopțiune\fP\fB=<\fP\fIvaloare\fP\fB>\fP... +.TP +\fBfiltru\fP +Numele filtrului +.TP +\fIopțiune\fP +Numele unei opțiuni specifice unui filtru +.TP +\fIvaloare\fP +Intervalele numerice \fIvaloare\fP apar ca +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Alegerile \fIvaloare\fP de tip șir de +caractere sunt afișate în cadrul \fB< >\fP și separate de un caracter +\fB|\fP. +.PP +Fiecare filtru este afișat pe propria linie. +. +.SS "Informații privind limita memoriei" +\fBxz \-\-robot \-\-info\-memory\fP afișează o singură linie cu multiple coloane +separate prin tabulatoare: +.IP 1. 4 +Cantitatea totală de memorie fizică (RAM) în octeți. +.IP 2. 4 +Limita de utilizare a memoriei pentru comprimare în octeți +(\fB\-\-memlimit\-compress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 3. 4 +Limita de utilizare a memoriei pentru decomprimare în octeți +(\fB\-\-memlimit\-decompress\fP). O valoare specială de \fB0\fP indică configurarea +implicită, care pentru modul cu un singur fir este la fel ca fără limită. +.IP 4. 4 +Începând cu \fBxz\fP 5.3.4alpha: Utilizarea memoriei pentru decomprimarea cu +mai multe fire în octeți (\fB\-\-memlimit\-mt\-decompress\fP). Acesta nu este +niciodată zero, deoarece o valoare implicită specifică sistemului afișată în +coloana 5 este utilizată dacă nu a fost specificată în mod explicit nicio +limită. De asemenea, aceasta nu este niciodată mai mare decât valoarea din +coloana 3, chiar dacă a fost specificată o valoare mai mare cu +\fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Începând cu \fBxz\fP 5.3.4alpha: o limită implicită de utilizare a memoriei +specifică sistemului, care este utilizată pentru a limita numărul de fire de +execuție atunci când se comprimă cu un număr automat de fire de execuție +(\fB\-\-threads=0\fP) și nicio limită de utilizare a memoriei nu fost specificată +cu (\fB\-\-memlimit\-compress\fP). Aceasta este, de asemenea, utilizată ca valoare +implicită pentru \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Începând cu \fBxz\fP 5.3.4alpha: numărul de fire de execuție de procesor +disponibile. +.PP +În viitor, rezultatul \fBxz \-\-robot \-\-info\-memory\fP poate avea mai multe +coloane, dar niciodată mai mult de o singură linie. +. +.SS Versiunea +\fBxz \-\-robot \-\-version\fP va afișa numărul versiunii \fBxz\fP și liblzma în +următorul format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Versiunea majoră. +.TP +\fIYYY\fP +Versiunea minoră. Numerele pare sunt prezente în versiunile +stabile. Numerele impare sunt prezente în versiunile alfa sau beta. +.TP +\fIZZZ\fP +Nivelul de plasture(patch) pentru versiunile stabile sau doar un contor +pentru versiunile de dezvoltare. +.TP +\fIS\fP +Stabilitate. 0 este alfa, 1 este beta și 2 este stabil. \fIS\fP trebuie să fie +întotdeauna 2 atunci când \fIAAA\fP este par. +.PP +\fIXYYYZZZS\fP sunt aceleași pe ambele linii dacă \fBxz\fP și liblzma sunt din +aceeași versiune XZ Utils. +.PP +Exemple: 4.999.9beta este \fB49990091\fP și 5.0.0 este \fB50000002\fP. +. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Totul este bine. +.TP +\fB1\fP +A apărut o eroare. +.TP +\fB2\fP +A apărut ceva care merită să fie avertizat, dar nu au apărut erori reale. +.PP +Notificările (nu avertismentele sau erorile) afișate la ieșirea de eroare +standard nu afectează starea de ieșire. +. +.SH "VARIABILE DE MEDIU" +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP analizează liste de opțiuni separate prin spații din variabilele de +mediu \fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP, în această ordine, înainte de a analiza +opțiunile din linia de comandă. Rețineți că numai opțiunile sunt analizate +din variabilele de mediu; toate non\-opțiunile sunt ignorate în +tăcere. Analiza se face cu funcția \fBgetopt_long\fP(3) care este folosită și +pentru argumentele liniei de comandă. +.PP +\fBAvertisment:\fP Prin definirea acestor variabile de mediu, se modifică +efectiv programele și scripturile care rulează \fBxz\fP. De cele mai multe ori +este sigur să se definească limitele de utilizare a memoriei, numărul de +fire și opțiunile de comprimare prin intermediul variabilelor de mediu. Cu +toate acestea, unele opțiuni pot întrerupe scripturile. Un exemplu evident +este \fB\-\-help\fP care face ca \fBxz\fP să afișeze textul de ajutor în loc să +comprime sau să decomprime un fișier. Exemple mai subtile sunt \fB\-\-quiet\fP și +\fB\-\-verbose\fP. În multe cazuri funcționează bine activarea indicatorului de +progres folosind \fB\-\-verbose\fP, dar în unele situații mesajele suplimentare +creează probleme. Nivelul de detaliere al mesajelor afectează, de asemenea, +comportamentul lui \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Opțiuni implicite specifice utilizatorului sau la nivelul întregului +sistem. De obicei, acest lucru este specificat într\-un script de +inițializare shell pentru a activa limitatorul de utilizare a memoriei lui +\fBxz\fP implicit sau pentru a stabili numărul implicit de fire. Excluzând +scripturile de inițializare shell și cazurile speciale similare, scripturile +nu trebuie niciodată să modifice sau să dezactiveze \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Acest lucru este pentru transmiterea opțiunilor către \fBxz\fP atunci când nu +este posibil să definiți opțiunile direct în linia de comandă a +\fBxz\fP. Acesta este cazul când \fBxz\fP este rulat de un script sau de un +instrument, de exemplu, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Scripturile pot folosi \fBXZ_OPT\fP, de exemplu, pentru a configura opțiunile +implicite de comprimare specifice scriptului. Se recomandă totuși să se +permită utilizatorilor să înlocuiască \fBXZ_OPT\fP dacă acest lucru este +rezonabil. De exemplu, în scripturile \fBsh\fP(1) se poate folosi ceva de genul +acesta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "COMPATIBILITATE CU LZMA\-UTILS" +Sintaxa liniei de comandă a lui \fBxz\fP este practic o super\-colecție de +\fBlzma\fP, \fBunlzma\fP și \fBlzcat\fP așa cum se găsește în LZMA Utils 4.32.x. În +cele mai multe cazuri, este posibil să înlocuiți LZMA Utils cu XZ Utils fără +a întrerupe scripturile existente. Există totuși unele incompatibilități, +care uneori pot cauza probleme. +. +.SS "Niveluri de comprimare prestabilite" +Numerotarea nivelurilor de comprimare prestabilite nu este identică în \fBxz\fP +și LZMA Utils. Cea mai importantă diferență este modul în care dimensiunile +dicționarului sunt atribuite diferitelor niveluri prestabilite. Dimensiunea +dicționarului este aproximativ egală cu memoria utilizată la decomprimare. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Diferențele de dimensiune a dicționarului afectează deasemenea cantitatea de +memorie utilizată la comprimare dar există și alte diferențe între LZMA +Utils și XZ Utils, care fac diferența și mai mare: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivel;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Nivelul prestabilit implicit în LZMA Utils este \fB\-7\fP, în timp ce în XZ +Utils este \fB\-6\fP, deci ambele folosesc un dicționar de 8Mio în mod implicit. +. +.SS "Fișiere .lzma transmise în flux vs. netransmise în flux" +Dimensiunea necomprimată a fișierului poate fi stocată în antetul +\&\fB.lzma\fP. LZMA Utils face asta atunci când comprimă fișiere +obișnuite. Alternativa este să marcați că dimensiunea necomprimată este +necunoscută și să folosiți marcajul de sfârșit de încărcare pentru a indica +unde ar trebui să se oprească decomprimarea. LZMA Utils folosește această +metodă atunci când dimensiunea necomprimată nu este cunoscută, ceea ce este +cazul, de exemplu, când se folosesc conducte. +.PP +\fBxz\fP acceptă decomprimarea fișierelor \fB.lzma\fP cu sau fără marcaj de +sfârșit de încărcare, dar toate fișierele \fB.lzma\fP create de \fBxz\fP vor +folosi marcajul de sfârșit de încărcare și vor avea dimensiunea necomprimată +marcată ca necunoscută în antetul \fB.lzma\fP. Aceasta poate fi o problemă în +unele situații mai puțin frecvente. De exemplu, un instrument de +decomprimare \fB.lzma\fP încorporat într\-un dispozitiv poate funcționa numai cu +fișiere care au dimensiunea necomprimată cunoscută. Dacă întâmpinați această +problemă, trebuie să utilizați LZMA Utils sau LZMA SDK pentru a crea fișiere +\&\fB.lzma\fP cu dimensiunea necomprimată cunoscută. +. +.SS "Fișiere .lzma neacceptate" +Formatul \fB.lzma\fP permite valori \fIlc\fP de până la 8 și valori \fIlp\fP de până +la 4. LZMA Utils poate decomprima fișiere cu orice \fIlc\fP și \fIlp\fP, dar +creează întotdeauna fișiere cu \fBlc=3\fP și \fBlp=0\fP. Crearea de fișiere cu +alte \fIlc\fP și \fIlp\fP este posibilă cu \fBxz\fP și cu LZMA SDK. +.PP +Implementarea filtrului LZMA1 în liblzma necesită ca suma \fIlc\fP și \fIlp\fP să +nu depășească 4. Altfel, fișierele \fB.lzma\fP, care depășesc această limitare, +nu pot fi decomprimate cu \fBxz\fP. +.PP +LZMA Utils creează numai fișiere \fB.lzma\fP care au o dimensiune de dicționar +de 2^\fIn\fP (o putere de 2), dar acceptă fișiere cu orice dimensiune de +dicționar. liblzma acceptă numai fișierele \fB.lzma\fP care au dimensiunea de +dicționar de 2^\fIn\fP sau 2^\fIn\fP + 2^(\fIn\fP\-1). Acest lucru este pentru a +reduce numărul de „fals pozitiv” atunci când se detectează fișiere \fB.lzma\fP. +.PP +Aceste limitări nu ar trebui să fie o problemă în practică, deoarece practic +toate fișierele \fB.lzma\fP au fost comprimate cu opțiuni pe care liblzma le va +accepta. +. +.SS "Resturi rămase" +Când decomprimă, LZMA Utils ignoră în tăcere totul după primul flux +\&\fB.lzma\fP. În majoritatea situațiilor, aceasta este o eroare. Aceasta +înseamnă, de asemenea, că LZMA Utils nu acceptă decomprimarea fișierelor +\&\fB.lzma\fP concatenate. +.PP +Dacă au rămas date după primul flux \fB.lzma\fP, \fBxz\fP consideră că fișierul +este corupt, cu excepția cazului în care a fost utilizată opțiunea +\fB\-\-single\-stream\fP. Acest lucru poate rupe scripturile obscure(scrise +deficitar) care presupun că resturile rămase sunt ignorate. +. +.SH NOTE +. +.SS "Rezultatul comprimării poate varia" +Ieșirea exactă comprimată produsă din același fișier de intrare necomprimat +poate varia între versiunile XZ Utils, chiar dacă opțiunile de comprimare +sunt identice. Acest lucru se datorează faptului că instrumentul codificator +poate fi îmbunătățit (comprimare mai rapidă sau mai bună) fără a afecta +formatul fișierului. Ieșirea poate varia chiar și între compilările diferite +ale aceleiași versiuni XZ Utils, dacă sunt utilizate opțiuni diferite de +compilare. +.PP +Cele de mai sus înseamnă că odată ce opțiunea \fB\-\-rsyncable\fP a fost +utilizată, fișierele rezultate nu vor fi neapărat sincronizate cu rsync +decât dacă atât fișierele vechi, cât și cele noi au fost comprimate cu +aceeași versiune xz. Această problemă poate fi remediată dacă o parte a +implementării codificatorului este înghețată pentru a menține stabilă +ieșirea „rsyncabilă” între versiunile xz. +. +.SS "Instrumente de decomprimare .xz încorporate" +Implementările instrumentului de decomprimare \fB.xz\fP încorporat, cum ar fi +XZ Embedded, nu acceptă neapărat fișiere create cu tipuri de \fIverificare\fP a +integrității, altele decât \fBnone\fP și \fBcrc32\fP. Deoarece valoarea implicită +este \fB\-\-check=crc64\fP, trebuie să utilizați \fB\-\-check=none\fP sau +\fB\-\-check=crc32\fP atunci când creați fișiere pentru sistemele încorporate. +.PP +În afara sistemelor încorporate, toate instrumentele de decomprimare în +format \fB.xz\fP acceptă toate tipurile de \fIverificare\fP sau cel puțin pot +decomprima fișierul fără a efectua verificarea integrității dacă acel tip de +\fIverificare\fP nu este acceptat. +.PP +XZ Embedded acceptă filtre BCJ, dar numai cu poziție de pornire implicită. +. +.SH EXEMPLE +. +.SS Bazice +Comprimă fișierul \fIfoo\fP în \fIfoo.xz\fP folosind nivelul de comprimare +implicit (\fB\-6\fP) și elimină fișierul \fIfoo\fP dacă comprimarea are succes: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Decomprimă \fIbar.xz\fP în \fIbar\fP și nu elimină \fIbar.xz\fP chiar dacă +decomprimarea este efectuată cu succes: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Creează \fIbaz.tar.xz\fP cu nivelul prestabilit \fB\-4e\fP (\fB\-4 \-\-extreme\fP), care +este mai lent decât nivelul prestabilit implicit \fB\-6\fP, dar necesită mai +puțină memorie pentru comprimare și decomprimare (48Mio și, respectiv, +5Mio): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Un amestec de fișiere comprimate și necomprimate poate fi decomprimat la +ieșirea standard cu o singură comandă: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Comprimarea în paralel a mai multor fișiere" +În sisteme GNU și *BSD, \fBfind\fP(1) și \fBxargs\fP(1) pot fi utilizate pentru a +paraleliza comprimarea mai multor fișiere: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Opțiunea \fB\-P\fP pentru comanda \fBxargs\fP(1) stabilește numărul de procese +paralele \fBxz\fP. Cea mai bună valoare pentru opțiunea \fB\-n\fP depinde de câte +fișiere trebuie să fie comprimate. Dacă există doar câteva fișiere, valoarea +ar trebui probabil să fie 1; cu zeci de mii de fișiere, 100 sau chiar mai +mult poate să fie valoarea potrivită pentru a reduce numărul de procese +\fBxz\fP pe care \fBxargs\fP(1) le va crea în final. +.PP +Opțiunea \fB\-T1\fP pentru \fBxz\fP este acolo pentru a\-l forța să ruleze în modul +cu un singur fir de execuție, deoarece \fBxargs\fP(1) este folosit pentru a +controla cantitatea de paralelizare. +. +.SS "Modul robot" +Calculează câți octeți au fost salvați în total după comprimarea mai multor +fișiere: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Un script poate dori să afle dacă folosește o versiune \fBxz\fP suficient de +nouă. Următorul script \fBsh\fP(1) verifică dacă numărul versiunii +instrumentului \fBxz\fP este cel puțin 5.0.0. Această metodă este compatibilă +cu versiunile beta vechi, care nu acceptau opțiunea \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Versiunea dumneavoastră de „xz” este prea veche!" +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Stabilește o limită de utilizare a memoriei pentru decomprimare folosind +variabila de mediu \fBXZ_OPT\fP, dar dacă o limită a fost deja stabilită, nu o +mărește: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Lanțuri de filtrare personalizate pentru instrumentul de comprimare" +Cea mai simplă utilizare a lanțurilor de filtrare personalizate este +personalizarea unei opțiuni prestabilite LZMA2. Acest lucru poate fi util, +deoarece opțiunile prestabilite acoperă doar un subset al combinațiilor +potențial utile de opțiuni de comprimare. +.PP +Coloanele CPUComp din tabelele de descriere a opțiunilor \fB\-0\fP ... \fB\-9\fP și +\fB\-\-extreme\fP sunt utile atunci când personalizați opțiunilor prestabilite +LZMA2. Iată părțile relevante colectate din aceste două tabele: +.RS +.PP +.TS +tab(;); +c c +n n. +ValPrestab;CPUComp +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Dacă știți că un fișier necesită un dicționar oarecum mare (de exemplu, +32Mio) pentru a se comprima bine, dar doriți să\-l comprimați mai repede +decât ar face \fBxz \-8\fP, o opțiune prestabilită cu o valoare CPUComp scăzută +(de exemplu, 1) poate fi modificată pentru a utiliza un dicționar mai mare: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Cu anumite fișiere, comanda de mai sus poate fi mai rapidă decât \fBxz \-6\fP în +timp ce comprimă semnificativ mai bine. Cu toate acestea, trebuie subliniat +că doar unele fișiere se beneficiază de un dicționar mare, păstrând în +același timp valoarea CPUComp scăzută. Cea mai evidentă situație, în care un +dicționar mare poate ajuta foarte mult, este o arhivă care conține fișiere +foarte asemănătoare de cel puțin câțiva megaocteți fiecare. Dimensiunea +dicționarului trebuie să fie semnificativ mai mare decât orice fișier +individual pentru a permite LZMA2 să profite din plin de asemănările dintre +fișierele consecutive. +.PP +Dacă utilizarea unei mari cantități de memorie pentru comprimare și +decomprimare este în regulă, iar fișierul comprimat are cel puțin câteva +sute de megaocteți, poate fi util să folosiți un dicționar și mai mare decât +cei 64Mio pe care i\-ar folosi \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Utilizarea opțiunii \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) ca în exemplul de mai +sus, poate fi utilă pentru a vedea cerințele de memorie la comprimare și +decomprimare. Amintiți\-vă că utilizarea unui dicționar mai mare decât +dimensiunea fișierului necomprimat este risipă de memorie, de aceea, comanda +de mai sus nu este utilă pentru fișiere mici. +.PP +Uneori, timpul de comprimare nu contează, dar utilizarea memoriei la +decomprimare trebuie menținută la un nivel scăzut, de exemplu, pentru a face +posibilă decomprimarea fișierului pe un sistem încorporat. Următoarea +comandă folosește \fB\-6e\fP (\fB\-6 \-\-extreme\fP) ca bază și fixează dimensiunea +dicționarului la doar 64Kio. Fișierul rezultat poate fi decomprimat cu XZ +Embedded (de aceea există \fB\-\-check=crc32\fP) folosind aproximativ 100Kio de +memorie. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Dacă doriți să stoarceți cât mai mulți octeți posibil, ajustarea numărului +de biți de context literal (\fIlc\fP) și a numărului de biți de poziție (\fIpb\fP) +poate ajuta uneori. Ajustarea numărului de biți de poziție literală (\fIlp\fP) +ar putea ajuta, de asemenea, dar de obicei \fIlc\fP și \fIpb\fP sunt mai +importante. De exemplu, o arhivă de cod sursă conține în mare parte text +US\-ASCII, așa că ceva precum comanda următoare, ar putea oferi un fișier +„mai slăbuț” (aproximativ cu 0,1%) mai mic decât cu \fBxz \-6e\fP (încercați și +fără \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 fișierul_sursă.tar\fR +.fi +.RE +.PP +Utilizarea unui alt filtru împreună cu LZMA2 poate îmbunătăți comprimarea cu +anumite tipuri de fișiere. De exemplu, pentru a comprima o bibliotecă +partajată x86 pe 32 de biți sau x86 pe 64 de biți folosind filtrul BCJ x86: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Rețineți că ordinea opțiunilor de filtrare este semnificativă. Dacă \fB\-\-x86\fP +este specificată după \fB\-\-lzma2\fP, \fBxz\fP va da o eroare, deoarece nu poate +exista niciun filtru după LZMA2 și, de asemenea, pentru că filtrul x86 BCJ +nu poate fi utilizat ca ultimul filtru din lanțul de filtrare. +.PP +Filtrul Delta împreună cu LZMA2 pot da rezultate bune cu imagini bitmap. De +obicei, ar trebui să întreacă comprimarea PNG, care are câteva filtre mai +avansate decât delta simplă, dar utilizează Deflate pentru comprimarea +reală. +.PP +Imaginea trebuie să fie salvată în format necomprimat, de exemplu, ca TIFF +necomprimat. Parametrul de distanță al filtrului Delta este fixat să se +potrivească cu numărul de octeți per pixel din imagine. De exemplu, +bitmap\-ul RGB pe 24 de biți necesită \fBdist=3\fP și este, de asemenea, bine să +pasați \fBpb=0\fP la LZMA2 pentru a se adapta alinierii pe trei octeți: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Dacă mai multe imagini au fost introduse într\-o singură arhivă (de exemplu, +\&\fB.tar\fP), filtrul Delta va funcționa și pe aceasta atâta timp cât toate +imaginile au același număr de octeți per pixel. +. +.SH "CONSULTAȚI ȘI" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/ro/man1/xzcmp.1 b/miniconda3/share/man/ro/man1/xzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..cebad3bb3ad049a59a6f1d29360d76fa73a915e4 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzcmp.1 @@ -0,0 +1,70 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzcmp, xzdiff, lzcmp, lzdiff \- compară fișierele comprimate +. +.SH REZUMAT +\fBxzcmp\fP [\fIopțiune...\fP] \fIfișier1\fP [\fIfișier2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (DEPRECIATĂ) +.br +\fBlzdiff\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzcmp\fP și \fBxzdiff\fP compară conținutul necomprimat a două fișiere. Datele +necomprimate și opțiunile sunt transmise la \fBcmp\fP(1) sau \fBdiff\fP(1), cu +excepția cazului în care se specifică \fB\-\-help\fP sau \fB\-\-version\fP. +.PP +Dacă sunt specificate atât \fIfișier1\fP, cât și \fIfișier2\fP, acestea pot fi +fișiere necomprimate sau fișiere în formate pe care \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) le poate +decomprima. Comenzile de decomprimare necesare sunt determinate de sufixele +numelor de fișiere \fIfișier1\fP și \fIfișier2\fP. Se presupune că un fișier cu un +sufix necunoscut este fie necomprimat, fie într\-un format pe care \fBxz\fP(1) +îl poate decomprima. +.PP +În cazul în care se furnizează un singur nume de fișier, \fIfișier1\fP trebuie +să aibă un sufix al unui format de comprimare acceptat, iar numele pentru +\fIfișier2\fP se presupune că este \fIfișier1\fP fără sufixul formatului de +comprimare. +.PP +Comenzile \fBlzcmp\fP și \fBlzdiff\fP sunt furnizate pentru compatibilitate +retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi eliminate +într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +În cazul în care apare o eroare de decomprimare, starea de ieșire este +\fB2\fP. În caz contrar, se utilizează starea de ieșire \fBcmp\fP(1) sau +\fBdiff\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzdec.1 b/miniconda3/share/man/ro/man1/xzdec.1 new file mode 100644 index 0000000000000000000000000000000000000000..2ba0113bc2dc5fc4bcde0c55e3c252171781c716 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzdec.1 @@ -0,0 +1,101 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 "8 aprilie 2024" Tukaani "Utilități XZ" +.SH NUME +xzdec, lzmadec \- Programe de decomprimare mici de fișiere .xz și .lzma +.SH REZUMAT +\fBxzdec\fP [\fIopțiune...\fP] [\fIfișier...\fP] +.br +\fBlzmadec\fP [\fIopțiune...\fP] [\fIfișier...\fP] +.SH DESCRIERE +\fBxzdec\fP este un instrument de decomprimare bazat pe liblzma pentru +fișierele \fB.xz\fP (și numai \fB.xz\fP). \fBxzdec\fP este destinat să funcționeze ca +un înlocuitor pentru \fBxz\fP(1) în cele mai frecvente situații în care un +script a fost scris pentru a utiliza \fBxz \-\-decompress \-\-stdout\fP (și posibil +câteva alte opțiuni frecvent utilizate) pentru a decomprima fișierele +\&\fB.xz\fP. \fBlzmadec\fP este identic cu \fBxzdec\fP cu excepția faptului că +\fBlzmadec\fP acceptă fișierele \fB.lzma\fP în loc de fișierele \fB.xz\fP. +.PP +Pentru a reduce dimensiunea executabilului, \fBxzdec\fP nu acceptă modul cu mai +multe fire de execuție sau localizarea(afișarea mesajelor în limba stabilită +de configurările regionale) și nu citește opțiunile din variabilele de mediu +\fBXZ_DEFAULTS\fP și \fBXZ_OPT\fP. \fBxzdec\fP nu acceptă afișarea informațiilor +intermediare de progres: trimiterea semnalului \fBSIGINFO\fP la \fBxzdec\fP nu +face nimic, iar trimiterea semnalului \fBSIGUSR1\fP încheie procesul în loc să +afișeze informații despre progres. +.SH OPȚIUNI +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP acceptă numai +decomprimarea. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP nu creează sau elimină +niciodată niciun fișier. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP scrie întotdeauna +datele decomprimate la ieșirea standard. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Specificarea acestui lucru o dată nu face nimic, deoarece \fBxzdec\fP nu +afișează niciodată avertismente sau notificări. Specificați acest lucru de +două ori pentru a suprima erorile. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignorat pentru compatibilitate cu \fBxz\fP(1). \fBxzdec\fP nu folosește niciodată +starea de ieșire 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Afișează un mesaj de ajutor și iese cu succes. +.TP +\fB\-V\fP, \fB\-\-version\fP +Afișează numărul versiunii \fBxzdec\fP și liblzma. +.SH "STARE DE IEȘIRE" +.TP +\fB0\fP +Toate au fost bine. +.TP +\fB1\fP +A apărut o eroare. +.PP +\fBxzdec\fP nu are niciun mesaj de avertizare precum \fBxz\fP(1), astfel că starea +de ieșire 2 nu este folosită de \fBxzdec\fP. +.SH NOTE +Utilizați \fBxz\fP(1) în loc de \fBxzdec\fP sau \fBlzmadec\fP pentru utilizarea +normală de zi cu zi. \fBxzdec\fP sau \fBlzmadec\fP sunt destinate numai +situațiilor în care este important să aveți un instrument de decomprimare +mai mic decât \fBxz\fP(1), cu funcții complete. +.PP +\fBxzdec\fP și \fBlzmadec\fP nu sunt chiar atât de mici. Dimensiunea poate fi +redusă și mai mult prin eliminarea caracteristicilor din liblzma în timpul +compilării, dar acest lucru nu ar trebui să se facă de obicei pentru +executabilele distribuite în distribuții tipice de sisteme de operare +neîncorporate. Dacă aveți nevoie de un instrument de decomprimare \fB.xz\fP cu +adevărat mic, luați în considerare utilizarea XZ Embedded. +.SH "CONSULTAȚI ȘI" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/ro/man1/xzdiff.1 b/miniconda3/share/man/ro/man1/xzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..cebad3bb3ad049a59a6f1d29360d76fa73a915e4 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzdiff.1 @@ -0,0 +1,70 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzcmp, xzdiff, lzcmp, lzdiff \- compară fișierele comprimate +. +.SH REZUMAT +\fBxzcmp\fP [\fIopțiune...\fP] \fIfișier1\fP [\fIfișier2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (DEPRECIATĂ) +.br +\fBlzdiff\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzcmp\fP și \fBxzdiff\fP compară conținutul necomprimat a două fișiere. Datele +necomprimate și opțiunile sunt transmise la \fBcmp\fP(1) sau \fBdiff\fP(1), cu +excepția cazului în care se specifică \fB\-\-help\fP sau \fB\-\-version\fP. +.PP +Dacă sunt specificate atât \fIfișier1\fP, cât și \fIfișier2\fP, acestea pot fi +fișiere necomprimate sau fișiere în formate pe care \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) le poate +decomprima. Comenzile de decomprimare necesare sunt determinate de sufixele +numelor de fișiere \fIfișier1\fP și \fIfișier2\fP. Se presupune că un fișier cu un +sufix necunoscut este fie necomprimat, fie într\-un format pe care \fBxz\fP(1) +îl poate decomprima. +.PP +În cazul în care se furnizează un singur nume de fișier, \fIfișier1\fP trebuie +să aibă un sufix al unui format de comprimare acceptat, iar numele pentru +\fIfișier2\fP se presupune că este \fIfișier1\fP fără sufixul formatului de +comprimare. +.PP +Comenzile \fBlzcmp\fP și \fBlzdiff\fP sunt furnizate pentru compatibilitate +retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi eliminate +într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +În cazul în care apare o eroare de decomprimare, starea de ieșire este +\fB2\fP. În caz contrar, se utilizează starea de ieșire \fBcmp\fP(1) sau +\fBdiff\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzegrep.1 b/miniconda3/share/man/ro/man1/xzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzegrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzfgrep.1 b/miniconda3/share/man/ro/man1/xzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzfgrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzgrep.1 b/miniconda3/share/man/ro/man1/xzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..fc411dfa1f83b5dfc4fa390829a8be970e426b47 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzgrep.1 @@ -0,0 +1,107 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzgrep \- caută modele în fișiere posibil comprimate +. +.SH REZUMAT +\fBxzgrep\fP [\fIopțiune...\fP] \fIlistă\-modele\fP [\fIfișier...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (DEPRECIATĂ) +.br +\fBlzegrep\fP \&... (DEPRECIATĂ) +.br +\fBlzfgrep\fP \&... (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzgrep\fP invocă \fBgrep\fP(1) asupra conținutului necomprimat al +fișierelor. Formatele \fIfișierelor\fP sunt determinate de sufixele numelor de +fișiere. Orice \fIfișier\fP cu un sufix acceptat de \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) sau \fBlz4\fP(1) va fi decomprimat; toate +celelalte fișiere sunt presupuse a fi necomprimate. +.PP +Dacă nu se specifică niciun \fIfișier\fP sau dacă \fIfișier\fP este \fB\-\fP, se +citește intrarea standard. Atunci când se citește de la intrarea standard, +sunt decomprimate numai fișierele acceptate de \fBxz\fP(1). Se presupune că +celelalte fișiere sunt deja în format necomprimat. +.PP +Sunt acceptate majoritatea \fIopțiunilor\fP din \fBgrep\fP(1). Cu toate acestea, +următoarele opțiuni nu sunt acceptate: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIacțiune\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglobal\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfișier\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglobal\fP +.PP +\fBxzegrep\fP este un alias pentru \fBxzgrep \-E\fP. \fBxzfgrep\fP este un alias +pentru \fBxzgrep \-F\fP. +.PP +Comenzile \fBlzgrep\fP, \fBlzegrep\fP și \fBlzfgrep\fP sunt furnizate pentru +compatibilitate retroactivă cu LZMA Utils. Acestea sunt depreciate și vor fi +eliminate într\-o versiune viitoare. +. +.SH "STARE DE IEȘIRE" +.TP +0 +A fost găsită cel puțin o potrivire din cel puțin unul dintre fișierele de +la intrare. Nu au apărut erori. +.TP +1 +Nu au fost găsite potriviri din niciunul dintre fișierele de la intrare. Nu +au apărut erori. +.TP +>1 +A apărut una sau mai multe erori. Nu se cunoaște dacă au fost găsite +potriviri. +. +.SH "VARIABILE DE MEDIU" +.TP +\fBGREP\fP +Dacă variabila de mediu \fBGREP\fP este stabilită la o valoare nevidă, aceasta +este utilizată în locul lui \fBgrep\fP, \fBgrep \-E\fP sau \fBgrep \-F\fP. +. +.SH "CONSULTAȚI ȘI" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzless.1 b/miniconda3/share/man/ro/man1/xzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..9bd9b2c296d7b6921c54b05a3508a9b2dd281db7 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzless.1 @@ -0,0 +1,60 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzless, lzless \- vizualizează fișierele (text) comprimate xz sau lzma +.SH REZUMAT +\fBxzless\fP [\fIfișier\fP...] +.br +\fBlzless\fP [\fIfișier\fP...] (DEPRECIATĂ) +.SH DESCRIERE +\fBxzless\fP este un filtru care afișează textul din fișierele comprimate pe un +terminal. Fișierele acceptate de \fBxz\fP(1) sunt decomprimate; se presupune că +celelalte fișiere sunt deja în format necomprimat. Dacă nu se dă nici un +\fIfișier\fP, \fBxzless\fP citește de la intrarea standard. +.PP +\fBxzless\fP folosește \fBless\fP(1) pentru a\-și prezenta rezultatul. Spre +deosebire de \fBxzmore\fP, alegerea sa de pager nu poate fi modificată prin +definirea unei variabile de mediu. Comenzile se bazează atât pe \fBmore\fP(1) +cât și pe \fBvi\fP(1) și permit mișcarea înainte și înapoi și +căutarea. Consultați manualul \fBless\fP(1) pentru mai multe informații. +.PP +Comanda numită \fBlzless\fP este furnizată pentru compatibilitatea cu LZMA +Utils. Aceasta este depreciată și va fi eliminată într\-o versiune viitoare. +.SH "VARIABILE DE MEDIU" +.TP +\fBLESSMETACHARS\fP +O listă de caractere speciale pentru shell. Definită de \fBxzless\fP, cu +excepția cazului în care este deja definită în mediu. +.TP +\fBLESSOPEN\fP +Aceasta este definită în linia de comandă pentru a invoca instrumentul de +decomprimare \fBxz\fP(1) pentru preprocesarea fișierelor de intrare pentru +\fBless\fP(1). +.SH "CONSULTAȚI ȘI" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/ro/man1/xzmore.1 b/miniconda3/share/man/ro/man1/xzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..dbc1541830568b68b48e9d554a71a90eff23a612 --- /dev/null +++ b/miniconda3/share/man/ro/man1/xzmore.1 @@ -0,0 +1,62 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Romanian translation for xz-man. +.\" Mesajele în limba română pentru manualul pachetului XZ Utils. +.\" Remus-Gabriel Chelu , 2022 - 2025. +.\" Cronologia traducerii fișierului „xz-man”: +.\" Traducerea inițială, făcută de R-GC, pentru versiunea xz-man 5.4.0-pre1. +.\" Actualizare a traducerii pentru versiunea 5.4.0-pre2, făcută de R-GC, dec-2022. +.\" Actualizare a traducerii pentru versiunea 5.4.3, făcută de R-GC, mai-2023. +.\" Actualizare a traducerii pentru versiunea 5.4.4-pre1, făcută de R-GC, iul-2023. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre1, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.6.0-pre2, făcută de R-GC, feb-2024. +.\" Actualizare a traducerii pentru versiunea 5.7.1-dev1, făcută de R-GC, ian-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.0-pre1, făcută de R-GC, mar-2025. +.\" Actualizare a traducerii pentru versiunea 5.8.2-pre1, făcută de R-GC, oct-2025. +.\" Actualizare a traducerii pentru versiunea Y, făcută de X, Z(luna-anul). +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 "6 martie 2025" Tukaani "Utilități XZ" +.SH NUME +xzmore, lzmore \- vizualizează fișierele (text) comprimate xz sau lzma +. +.SH REZUMAT +\fBxzmore\fP [\fIfișier\fP...] +.br +\fBlzmore\fP [\fIfișier\fP...] (DEPRECIATĂ) +. +.SH DESCRIERE +\fBxzmore\fP afișează textul din fișierele comprimate pe un terminal folosind +\fBmore\fP(1). Fișierele acceptate de \fBxz\fP(1) sunt decomprimate; se presupune +că celelalte fișiere sunt deja în format necomprimat. Dacă nu se dă nici un +\fIfișiere\fP, \fBxzmore\fP citește de la intrarea standard. Consultați manualul +\fBmore\fP(1) pentru comenzile de la tastatură. +.PP +Rețineți că este posibil ca derularea înapoi să nu fie posibilă în funcție +de implementarea lui \fBmore\fP(1). Acest lucru se datorează faptului că +\fBxzmore\fP utilizează o conductă pentru a transmite datele decomprimate către +\fBmore\fP(1). \fBxzless\fP(1) utilizează \fBless\fP(1) care oferă caracteristici mai +avansate. +.PP +Comanda \fBlzmore\fP este furnizată pentru compatibilitate retroactivă cu LZMA +Utils. Aceasta este depreciată și va fi eliminată într\-o versiune viitoare. +. +.SH "VARIABILE DE MEDIU" +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Dacă variabila de mediu \fBPAGER\fP, este definită, valoarea sa este utilizată +ca paginator în loc de \fBmore\fP(1). +. +.SH "CONSULTAȚI ȘI" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzcat.1 b/miniconda3/share/man/sr/man1/lzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzcat.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/lzcmp.1 b/miniconda3/share/man/sr/man1/lzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..6c9ef9938e11d68a13510dffa145304439b97e6c --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzcmp.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzcmp, xzdiff, lzcmp, lzdiff – упоређује запаковане датотеке +. +.SH САЖЕТАК +\fBxzcmp\fP [\fIопција...\fP] \fIдатотека1\fP [\fIдатотека2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzcmp\fP и \fBxzdiff\fP пореди незапаковане садржаје две датотеке. +Незапаковани подаци и опције се прослеђују ка \fBcmp\fP(1) или \fBdiff\fP(1) осим +ако није наведено \fB\-\-help\fP or \fB\-\-version\fP. +.PP +Ако су наведене и \fIдатотека1\fP и \fIдатотека2\fP, оне могу бити незапаковане +датотеке или датотеке у форматима које \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) могу да распакују. Захтеване наредбе +распакивања се одређују из суфикса назива \fIдатотеке1\fP и \fIдатотеке2\fP. +Датотека са непознатим суфиксом се претпоставља да је незапакована или да је +у формату који \fBxz\fP(1) може да распакује. +.PP +Ако је достављен само један назив датотеке, \fIдатотека1\fP мора да има суфикс +подржаних формата запакивања а назив за \fIдатотеку2\fP се подразумева да је +\fIдатотека1\fP са уклоњеним суфиксом формата запакивања. +.PP +Наредбе \fBlzcmp\fP и \fBlzdiff\fP се достављају зарад назадне сагласности са LZMA +Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +Ако дође до грешке распакивања,излазно стање је \fB2\fP. У супротном излазно +стање од \fBcmp\fP(1) или \fBdiff\fP(1) се користи. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzdiff.1 b/miniconda3/share/man/sr/man1/lzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..6c9ef9938e11d68a13510dffa145304439b97e6c --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzdiff.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzcmp, xzdiff, lzcmp, lzdiff – упоређује запаковане датотеке +. +.SH САЖЕТАК +\fBxzcmp\fP [\fIопција...\fP] \fIдатотека1\fP [\fIдатотека2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzcmp\fP и \fBxzdiff\fP пореди незапаковане садржаје две датотеке. +Незапаковани подаци и опције се прослеђују ка \fBcmp\fP(1) или \fBdiff\fP(1) осим +ако није наведено \fB\-\-help\fP or \fB\-\-version\fP. +.PP +Ако су наведене и \fIдатотека1\fP и \fIдатотека2\fP, оне могу бити незапаковане +датотеке или датотеке у форматима које \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) могу да распакују. Захтеване наредбе +распакивања се одређују из суфикса назива \fIдатотеке1\fP и \fIдатотеке2\fP. +Датотека са непознатим суфиксом се претпоставља да је незапакована или да је +у формату који \fBxz\fP(1) може да распакује. +.PP +Ако је достављен само један назив датотеке, \fIдатотека1\fP мора да има суфикс +подржаних формата запакивања а назив за \fIдатотеку2\fP се подразумева да је +\fIдатотека1\fP са уклоњеним суфиксом формата запакивања. +.PP +Наредбе \fBlzcmp\fP и \fBlzdiff\fP се достављају зарад назадне сагласности са LZMA +Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +Ако дође до грешке распакивања,излазно стање је \fB2\fP. У супротном излазно +стање од \fBcmp\fP(1) или \fBdiff\fP(1) се користи. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzegrep.1 b/miniconda3/share/man/sr/man1/lzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzegrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzfgrep.1 b/miniconda3/share/man/sr/man1/lzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzfgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzgrep.1 b/miniconda3/share/man/sr/man1/lzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzless.1 b/miniconda3/share/man/sr/man1/lzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..af9fd3a0e92153e5cc2db427e2cbf48088bbb682 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzless.1 @@ -0,0 +1,47 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzless, lzless – приказује „xz“ или „lzma“ запаковане (текстуалне) датотеке +.SH САЖЕТАК +\fBxzless\fP [\fIдатотека\fP...] +.br +\fBlzless\fP [\fIдатотека\fP...] (ЗАСТАРЕЛО) +.SH ОПИС +\fBxzless\fP је филтер који приказује текст из запакованих датотека у +терминалу. Датотеке које подржава \fBxz\fP(1) се распакују; остале датотеке се +већ подразумева да су у незапакованом облику. Ако није дата ни једна +\fIдатотека\fP, \fBxzless\fP чита са стандардног улаза. +.PP +\fBxzless\fP користи \fBless\fP(1) да представи свој излаз. За разлику од +\fBxzmore\fP, његов избор страничара се не може изменити постављањем променљиве +окружења. Наредбе се заснивају и на \fBmore\fP(1) и на \fBvi\fP(1) и дозвољавају +померање и претрагу назад и напред. Видите упутство \fBless\fP(1) за више +информација. +.PP +Наредба \fBlzless\fP се доставља зарад назадне сагласности са LZMA +Utils. Застарела је и биће уклоњена у будућем издању. +.SH ОКРУЖЕЊЕ +.TP +\fBLESSMETACHARS\fP +Списак знакова нарочитих за шкољку. Поставите са \fBxzless\fP осим ако већ +није постављено у окружењу. +.TP +\fBLESSOPEN\fP +Поставља да линија наредби призове \fBxz\fP(1) распакивач за предобраду улазних +датотека на \fBless\fP(1). +.SH "ВИДИТЕ ТАКОЂЕ" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzma.1 b/miniconda3/share/man/sr/man1/lzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzma.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/lzmadec.1 b/miniconda3/share/man/sr/man1/lzmadec.1 new file mode 100644 index 0000000000000000000000000000000000000000..c9bbe26f45da0a1add18e35e5a13105c4155b677 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzmadec.1 @@ -0,0 +1,81 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 08.04.2024. Tukaani "XZ Utils" +.SH НАЗИВ +xzdec, lzmadec – Мали „.xz“ и „.lzma“ распакивачи +.SH САЖЕТАК +\fBxzdec\fP [\fIопција...\fP] [\fIдатотека...\fP] +.br +\fBlzmadec\fP [\fIопција...\fP] [\fIдатотека...\fP] +.SH ОПИС +\fBxzdec\fP је алат само за распакивање заснован на „liblzma“ за \fB.xz\fP (и само +\&\fB.xz\fP) датотеке. \fBxzdec\fP је намењен да ради као тренутна замена за +\fBxz\fP(1) у најопштијим ситуацијама где је скрипта написана да користи \fBxz \-\-decompress \-\-stdout\fP (и по могућству још неколико других обично коришћених +опција) за распакивање \fB.xz\fP датотека. \fBlzmadec\fP је истоветна са \fBxzdec\fP +осим што \fBlzmadec\fP подржава \fB.lzma\fP датотеке уместо of \fB.xz\fP датотека. +.PP +За смањење величине извршне, \fBxzdec\fP не подржава више нити или +локализацију, и не чита опције из променљивих окружења \fBXZ_DEFAULTS\fP и +\fBXZ_OPT\fP. \fBxzdec\fP не подржава приказивање посредничких информација +напредовања: слање \fBSIGINFO\fP ка \fBxzdec\fP не ради ништа, али слање +\fBSIGUSR1\fP окончава процес уместо да прикаже информације о напредовању. +.SH ОПЦИЈЕ +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP подржава само распакивање. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP никада не прави или уклања +датотеке. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP увек пише распаковане +податке на стандардни излаз. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Навођењем овога једном не ради ништа јер \fBxzdec\fP никада не приказује +упозорења или обавештења. Наведите ово два пута да потиснете грешке. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP никада не користи излазно +стање 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи и излази с успехом. +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxzdec\fP и „liblzma“. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све беше у реду. +.TP +\fB1\fP +Дошло је до грешке. +.PP +\fBxzdec\fP нема поруке упозорења као што има \fBxz\fP(1), стога \fBxzdec\fP не +користи излазно стање 2. +.SH НАПОМЕНЕ +Користите \fBxz\fP(1) уместо \fBxzdec\fP или \fBlzmadec\fP за обично свакодневно +коришћење. \fBxzdec\fP или \fBlzmadec\fP су замишљени само ситуације у којима је +важно имати мањи распакивач неко потпуно функционалан \fBxz\fP(1). +.PP +\fBxzdec\fP и \fBlzmadec\fP нису баш тако мали. Величина може бити још смањена +одбацивањем функција из „liblzma“ за време превођења, али то не треба обично +да се ради за извршне достављене у типичним не\-угнежденим дистрибуцијама +оперативног система. Ако вам треба стварно мали \fB.xz\fP распакивач, +размотрите коришћење XZ Embedded\-а. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/sr/man1/lzmainfo.1 b/miniconda3/share/man/sr/man1/lzmainfo.1 new file mode 100644 index 0000000000000000000000000000000000000000..600a0dc79c8899fb6ce0b505e6bb55278e804df8 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzmainfo.1 @@ -0,0 +1,42 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LZMAINFO 1 30.06.2013. Tukaani "XZ Utils" +.SH НАЗИВ +lzmainfo – приказује информације смештене у заглављу .lzma датотеке +.SH САЖЕТАК +\fBlzmainfo\fP [\fB\-\-help\fP] [\fB\-\-version\fP] [\fIдатотека...\fP] +.SH ОПИС +\fBlzmainfo\fP приказује информације које се налазе у заглављу \fB.lzma\fP +датотеке. Чита првих 13 бајтова из наведене \fIдатотеке\fP, дешифрује заглавље +и исписује га на стандардни излаз у облику читљивом људима. Ако ни једна +\fIдатотека\fP није дата или је \fIдатотека\fP \fB\-\fP, чита се стандардни улаз. +.PP +Обично најзанимљивије информације су незапакована величина и величина +речника. Незапакована величина може се приказати само ако је датотека у +варијанти формата \fB.lzma\fP која није ток. Количина меморије потребне за +распакивање датотеке је неколико десетина килобајта плус величина речника. +.PP +\fBlzmainfo\fP је садржано у XZ Utils\-у првенствено због повратне сагласности +са LZMA Utils\-ом. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.SH ГРЕШКЕ +\fBlzmainfo\fP користи \fBMB\fP док тачан суфикс треба да буде \fBMiB\fP (2^20 +бајтова). Ово је зато да би се задржала сагласност излаза са LZMA Utils\-ом. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxz\fP(1) diff --git a/miniconda3/share/man/sr/man1/lzmore.1 b/miniconda3/share/man/sr/man1/lzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..23df9c6cf0402b3ebdac9949ee6d40bcb9db6045 --- /dev/null +++ b/miniconda3/share/man/sr/man1/lzmore.1 @@ -0,0 +1,49 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzmore, lzmore – приказује „xz“ или „lzma“ запаковане (текстуалне) датотеке +. +.SH САЖЕТАК +\fBxzmore\fP [\fIдатотека\fP...] +.br +\fBlzmore\fP [\fIдатотека\fP...] (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzmore\fP приказује текст из запакованих датотека у терминалу користећи +\fBmore\fP(1). Датотеке које подржава \fBxz\fP(1) се распакују; остале датотеке +се подразумева да су већ у незапакованом облику. Ако није дата ни једна +\fIдатотека\fP, \fBxzmore\fP чита са стандардног улаза. Видите упутство +\fBmore\fP(1) за више информација. +.PP +Знајте да клизање уназад можда неће бити могуће у зависности од примене +\fBmore\fP(1). Ово је зато што \fBxzmore\fP користи спојку за прослеђивање +распакованих података ка \fBmore\fP(1). \fBxzless\fP(1) користи \fBless\fP(1) које +обезбеђује напреднијим функцијама. +.PP +Наредба \fBlzmore\fP се доставља зарад назадне сагласности са LZMA +Utils. Застарела је и биће уклоњена у будућем издању. +. +.SH ОКРУЖЕЊЕ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Ако је \fBPAGER\fP постављено, његова вредност се користи као страничар уместо +\fBmore\fP(1). +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/sr/man1/unlzma.1 b/miniconda3/share/man/sr/man1/unlzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/unlzma.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/unxz.1 b/miniconda3/share/man/sr/man1/unxz.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/unxz.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/xz.1 b/miniconda3/share/man/sr/man1/xz.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/xz.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/xzcat.1 b/miniconda3/share/man/sr/man1/xzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..82d831001e1f400683d876e945d108fa8686a45a --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzcat.1 @@ -0,0 +1,1928 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 08.03.2025. Tukaani "XZ Utils" +. +.SH НАЗИВ +xz, unxz, xzcat, lzma, unlzma, lzcat – Запакује или распакује „.xz“ и „.lzma +датотеке +. +.SH САЖЕТАК +\fBxz\fP [\fIопција...\fP] [\fIдатотека...\fP] +. +.SH "АЛИЈАСИ НАРЕДБЕ" +\fBunxz\fP је исто као и \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP је исто као и \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP је исто као и \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP је исто као и \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP је исто као и \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +Приликом писања скрипти које треба да распакују датотеке, препоручује се да +се увек користи назив \fBxz\fP са одговарајућим аргументима (\fBxz \-d\fP или \fBxz \-dc\fP) уместо назива \fBunxz\fP и \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP је алат опште употребе за запакивање података са синтаксом линије +наредби сличан као \fBgzip\fP(1) и \fBbzip2\fP(1). Изворни формат датотеке је +\&\fB.xz\fP формат, али стари \fB.lzma\fP формат који користи LZMA Utils и сирови +запаковани токови без заглавља формата су такође подржани. Уз то, +распакивање \fB.lz\fP формата који користи \fBlzip\fP је подржано. +.PP +\fBxz\fP запакује или распакује сваку \fIдатотеку\fP у складу са изабраним режимом +рада. Ако није дата ни једна \fIдатотека\fP или је датотека \fIfile\fP \fB\-\fP, +\fBxz\fP чита са стандардног улаза и записује обрађене податке на стандардни +излаз. \fBxz\fP ће одбити (приказаће грешку и прескочити \fIдатотеку\fP) да пише +запаковане податке на стандардни излаз ако је то терминал. Слично, \fBxz\fP ће +одбити да чита запаковане податке са стандардног улаза ако је то терминал. +.PP +Осим ако није наведено \fB\-\-stdout\fP, \fIдатотеке\fP које нису \fB\-\fP се пишу у +нову датотеку чији назив је проистекао из назива изворне \fIдатотеке\fP: +.IP \(bu 3 +Приликом запакивања, суфикс формата циљне датотеке (\fB.xz\fP или \fB.lzma\fP) се +додаје на назив изворне датотеке да би се добио назив циљне датотеке. +.IP \(bu 3 +Приликом распакивања, суфикс \fB.xz\fP, \fB.lzma\fP или \fB.lz\fP се уклања из назива +датотеке да би се добио назив циљне датотеке. \fBxz\fP такође препознаје +суфиксе \fB.txz\fP и \fB.tlz\fP и замењује их суфиксом \fB.tar\fP. +.PP +Ако циљна датотека већ пстоји, приказује се грешка а \fIдатотека\fP се +прескаче. +.PP +Осим ако не пише на стандардни излаз, \fBxz\fP ће приказати упозорење и +прескочити \fIдатотеку\fP ако се нешто од следећег примењује: +.IP \(bu 3 +\fIДатотека\fP није обична датотека. Симболичке везе се не прате, и стога се +не сматра да су обичне датотеке. +.IP \(bu 3 +\fIДатотека\fP има више од једне чврсте везе. +.IP \(bu 3 +\fIДатотека\fP има постављен „setuid, setgid“ или лепљиви бит. +.IP \(bu 3 +Режим рада је постављен на запакивање а \fIдатотека\fP већ има суфикс формата +циљне датотеке (\fB.xz\fP или \fB.txz\fP приликом запакивања у \fB.xz\fP формат, а +\&\fB.lzma\fP или \fB.tlz\fP приликом запакивања у \fB.lzma\fP формат). +.IP \(bu 3 +Режим радње је постављен за распакивање а \fIдатотека\fP нема суфикс ни једног +од подржаних формата датотеке (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP или +\&\fB.lz\fP). +.PP +Након успешног сажимања или распакивања \fIдатотеке\fP, \fBxz\fP умножава +власника, групу, дозволе, време приступа и време измене из изворне +\fIдатотеке\fP у циљну датотеку. Ако умножавање групе не успе, дозволе су +измењене тако да циљна датотека не постане доступна корисницима који нису +имали дозволу за приступ изворној \fIдатотеци\fP. \fBxz\fP не подржава умножавање +других метаподатака попут списка контрола приступа или проширених атрибута. +.PP +Једном када је циљна датотека успешно затворена, изворна \fIдатотека\fP се +уклања осим ако се \fB\-keep\fP не наведе. Изворна \fIдатотека\fP се никада не +уклања ако се излаз пише на стандардни излаз или ако дође до грешке. +.PP +Слање \fBSIGINFO\fP или \fBSIGUSR1\fP ка \fBxz\fP процесу чини да испише информације +напредовања на стандардну грешку. Ово има ограничено коришћење све док +стандардна грешка јесте терминал, коришћење \fB\-\-verbose\fP приказаће +аутоматски указивач напретка освежавања. +. +.SS "Коришћење меморије" +Коришћење меморије \fBxz\fP се мења од неколико стотина килобајта до неколико +гигабајта у зависности од поставки запакивања. Поставке коришћене приликом +запакивања датотеке одређују захтеве меморије распакивача. Обично +распакивачу треба 5\ % до 20\ % количине меморије која је потребна +запакивачу приликом прављења датотеке. На пример, распакивање датотеке +направљене са \fBxz \-9\fP тренутно захтева 65\ MiB меморије. Још увек, могуће +је имати \fB.xz\fP датотеке које захтевају неколико гигабајта меморије за +распакивање. +.PP +Нарочито корисници старијих система могу наћи досадном могућност коришћења +врло велике меморије. Да би се спречила нежељена изненађења, \fBxz\fP има +уграђен ограничавач коришћења меморије, који је искључен по основи. Док +неки оперативни системи пружају начин за ограничавање коришћење меморије за +процесе, ослањање на то сматра се да није довољно прилагодљиво (на пример, +коришћење \fBulimit\fP(1) за ограничавање виртуелне меморије тежи да обогаљи +\fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Ограничавач коришћења меморије се може укључити опцијом линије наредби +\fB\-\-memlimit=\fP\fIограничење\fP. Често је најпогодније укључити ограничавач по +основи постављањем променљиве окружења \fBXZ_DEFAULTS\fP, на пример, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Могуће је поставити ограничења засебно за +запакивање и распакивање коришћењем \fB\-\-memlimit\-compress=\fP\fIограничење\fP и +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP. Коришћење ове две опције ван +\fBXZ_DEFAULTS\fP је ретко корисно јер једно покретање \fBxz\fP не може да ради и +запакивање и распакивање а \fB\-\-memlimit=\fP\fIограничење\fP (или \fB\-M\fP +\fIограничење\fP) је краће за куцање на линији наредби. +.PP +Ако је прекорачено наведено ограничење коришћења меморије, \fBxz\fP ће +приказати грешку а распакивање датотеке неће успети. Ако је ограничење +прекорачено приликом запакивања, \fBxz\fP ће покушати да умањи поставке тако да +се ограничење више не прекорачује (оси када се користи \fB\-\-format=raw\fP или +\fB\-\-no\-adjust\fP). На тај начин радња неће бити неуспешна осим ако је +ограничење врло мало. Смањење поставке се ради у корацима који се не +подударају са предподешеностима нивоа запакивања, на пример, ако је +ограничење само незнатно мање од износа потребног за \fBxz \-9\fP, поставке ће +бити смањене само мало, а не све до \fBxz \-8\fP. +. +.SS "Надовезивање и попуњавање са „.xz“ датотекама" +Могуће је додати \fB.xz\fP датотеке као то. \fBxz\fP ће распаковати такве +датотеке као да су биле једна \fB.xz\fP датотека. +.PP +Могуће је уметнути попуњавање између придодатих делова или након последњег +дела. Попуњавање мора да се састоји од празних бајтова а величина +попуњавања мора бити умножак четири бајта. Ово може бити корисно, на +пример, ако је \fB.xz\fP датотека смештена на медијуму који мери величине +датотека у блоковима од 512 бајтова. +.PP +Надовезивање и попуњавање нису дозвољени са \fB.lzma\fP датотекама или сировим +токовима. +. +.SH ОПЦИЈЕ +. +.SS "Суфикси целог броја и специјалне вредности" +На већини места где се очекује аргумент целог броја, опционални суфикс је +подржан да би се лако назначили велики цели бројеви. Не сме бити размака +између целог броја и суфикса. +.TP +\fBKiB\fP +Множи цео број са 1.024 (2^10). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP, и \fBKB\fP се +прихватају као синоними за \fBKiB\fP. +.TP +\fBMiB\fP +Множи цео број са 1.048.576 (2^20). \fBMi\fP, \fBm\fP, \fBM\fP, и \fBMB\fP се +прихватају као синоними за \fBMiB\fP. +.TP +\fBGiB\fP +Множи цео број са 1.073.741.824 (2^30). \fBGi\fP, \fBg\fP, \fBG\fP, и \fBGB\fP се +прихватају као синоними за \fBGiB\fP. +.PP +Посебна вредност \fBmax\fP се може користити да укаже на највећу вредност целог +броја подржану опцијом. +. +.SS "Режим рада" +Ако је дато више опција режима рада, последња има дејства. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Запакује. Ово је основни режим радње када није наведена опција режима радње +и ниједан други режим радње се не подразумева са линије радње (на пример, +\fBunxz\fP подразумева \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Након успешног запакивања, изворна датотека се уклања осим ако се не пише на +стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Распакује. Након успешног распакивања, изворна датотека се уклања осим ако +се не пише на стандардни излаз или је наведено \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Тестира целовитост запакованих \fIдатотека\fP. Ова опција је исто што и +\fB\-\-decompress \-\-stdout\fP осим тога што се распаковани подаци одбацују уместо +да се пишу на стандардни излаз. Датотеке се не праве нити уклањају. +.TP +\fB\-l\fP, \fB\-\-list\fP +Исписује информације о запакованим \fIдатотекама\fP. Никакав незапакован излаз +се не добија, а ниједна датотека није направљена или уклоњена. У режиму +списка, програм не може читати запаковане податке са стандардног улаза или +из других нетраживих извора. +.IP "" +Основни списак приказује основне информације о \fIдатотекама\fP, једна датотека +у једном реду. Да добијете подробније информације, користите такође опцију +\fB\-\-verbose\fP. За чак и више информација, користите \fB\-\-verbose\fP два пуа, +али знајте да то може бити споро, јер да би се добиле све додатне +информације потребно је много тражења. Ширина опширног излаза премашује 80 +знакова, тако да преспајање излаза на, на пример, \fBless\ \-S\fP може бити +прикладно ако терминал није довољно широк. +.IP "" +Тачан излаз може варирати између \fBxz\fP издања и различитих језика. За излаз +читљив машинама треба да користите \fB\-\-robot \-\-list\fP. +. +.SS "Измењивачи рада" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не брише улазне датотеке. +.IP "" +Од \fBxz\fP 5.2.6, ова опција такође чини да \fBxz\fP запакује или распакује чак и +ако је улаз симболичка веза ка обичној датотеци, има више од једне чврсте +везе или има постављен „setuid“, „setgid“ или лепљиви бит. „setuid“, +„setgid“ и лепљиви битови се не умножавају у циљну датотеку. У ранијим +издањима ово се могло урадити само са \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Ова опција има неколико дејстава: +.RS +.IP \(bu 3 +Ако циљна датотека већ постоји, брише је пре запакивања или распакивања. +.IP \(bu 3 +Запакује или распакује чак и ако је улаз симболичка веза ка обичној +датотеци, има више од једне чврсте везе или има постављен „setgid“, „setgid“ +или лепљиви бит. „setgid“, „setgid“ или лепљиви бит се не умножавају у +циљну датотеку. +.IP \(bu 3 +Када се користи са \fB\-\-decompress\fP \fB\-\-stdout\fP и \fBxz\fP не може да препозна +врсту изворне датотеке, умножава изворну датотеку као такву на стандардни +излаз. Ово омогућава да се \fBxzcat\fP \fB\-\-force\fP користи као \fBcat\fP(1) за +датотекекоје нису запаковане са \fBxz\fP. Знајте да ће у будућности, \fBxz\fP +моћи да подржава нове формате запаковане датотеке, који могу учинити да +\fBxz\fP распакује још врста датотека уместо да их умножи какве јесу на +стандардни излаз. \fB\-\-format=\fP\fIформат\fP се може користити да ограничи \fBxz\fP +да распакује само формат једне датотеке. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Пише запаковане или распаковане податке на стандардни излаз уместо у +датотеку, Ово подразумева \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Распакује само први \fB.xz\fP ток, и тихо занемарује могуће преостале улазне +податке који следе ток. Нормално такво пратеће смеће чини да \fBxz\fP прикаже +грешку. +.IP "" +\fBxz\fP никада не распакује више од једног тока из \fB.lzma\fP датотека или +сирових токова, али ова опција чини да \fBxz\fP још увек занемари могуће +пратеће податке након \fB.lzma\fP датотеке или сировог тока. +.IP "" +Ова опција нема дејства ако режим рада није \fB\-\-decompress\fP или \fB\-\-test\fP. +.IP "" +Од \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP подразумева \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Искључује стварање развучених датотека. По основи, ако распакује у обичну +датотеку, \fBxz\fP покушава да учини датотеку развученом ако распаковани подаци +садрже дуге низове бинарних нула. Такође ради приликом писања на стандардни +излаз све док је стандардни излаз повезан са обичном датотеком а одређени +додатни услови су испуњени да је учине безбедном. Стварање развучених +датотека може уштедети простор на диску и убрзати распакивање смањењем +количине У/И диска. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Приликом запакивања, користите \fI.suf\fP као суфикс за циљну датотеку уместо +\&\fB.xz\fP или \fB.lzma\fP. Ако се не пише на стандардни излаз а изворна датотека +већ има суфикс \fI.suf\fP, приказује се упозорење и датотека се прескаче. +.IP "" +Приликом распакивања, препознаје датотеке са суфиксом \fI.suf\fP поред датотека +са суфиксом \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP, or \fB.lz\fP. Ако изворна +датотека има суфикс \fI.suf\fP, суфикс се уклања да би се добио назив циљне +датотеке. +.IP "" +Приликом запакивања или распакивања сирових токова (\fB\-\-format=raw\fP), суфикс +мора увек бити наведен осим ако се не пише на стандардни излаз, јер не +постоји основни суфикс за сирове токове. +.TP +\fB\-\-files\fP[\fB=\fP\fIдатотека\fP] +Чита називе датотека за обраду из \fIдатотеке\fP; ако се \fIдатотека\fP изостави, +називи датотека се читају са стандардног улаза. Називи датотека се морају +завршавати знаком новог реда. Цртица (\fB\-\fP) се узима као редован назив +датотеке; а не стандардни улаз. Ако су називи датотека дати такође као +аргументи линије наредби, обрађују се пре него што се називи датотека +прочитају из \fIдатотеке\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIдатотека\fP] +Ово је исто као и \fB\-\-files\fP[\fB=\fP\fIдатотека\fP] изузев тога што сваки назив +датотеке мора да се завршава „null“ знаком. +. +.SS "Основни формат датотеке и опције запакивања" +.TP +\fB\-F\fP \fIформат\fP, \fB\-\-format=\fP\fIформат\fP +Наводи \fIформат\fP датотеке за запакивање или распакивање: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Ово је основно. Приликом запакивања, \fBauto\fP је исто што и \fBxz\fP. Приликом +распакивања, формат улазне датотеке се аутоматски препознаје. Знајте да +сирови токови (направљени са \fB\-\-format=raw\fP) не могу бити аутоматски +препознати. +.TP +\fBxz\fP +Пакује у \fB.xz\fP формат датотеке, или прихвата само \fB.xz\fP датотеке приликом +распакивања. +.TP +\fBlzma\fP, \fBalone\fP +Пакује у стари \fB.lzma\fP формат датотеке, или прихвата само \fB.lzma\fP датотеке +приликом распакивања. Алтернативни назив \fBalone\fP се доставља зарад +повратне сагласности са LZMA помагалима. +.TP +\fBlzip\fP +Прихвата само \fB.lz\fP датотеке приликом распакивања. Запакивање није +подржано. +.IP "" +Формат \fB.lz\fP издања 0 и 1 је подржан. Датотеке издања 0 су настале са +\fBlzip\fP 1.3 и старијим. Такве датотеке нису уобичајене али се могу наћи у +архивама датотека јер је неколико пакета извора издато у овом формату. +Такође можда неко има старе личне датотеке у овом формату. Подршка +распакивања за формат издања 0 је уклоњена у \fBlzip\fP 1.18. \fBlzip\fP 1.4 и +новији ствара датотеке у формату издања 1. +.TP +\fBraw\fP +Запакује или распакује сирови ток (без заглавља). Ово је замишљено само за +напредне кориснике. Да дешифрујете сирове токове, треба да користите +\fB\-\-format=raw\fP и да изричито наведете ланац филтера, што би обично требало +да буде смештено у заглављима контејнера. +.RE +.TP +\fB\-C\fP \fIпровера\fP, \fB\-\-check=\fP\fIпровера\fP +Наводи врсту провере целовитости. Провера се израчунава из незапакованих +података и смештених у \fB.xz\fP датотеци. Ова опција има дејства само +приликом запакивања у \fB.xz\fP формат; \fB.lzma\fP формат не подржава провере +целовитости. Провера целовитости (ако је има) се проверава када је \fB.xz\fP +датотека распакована. +.IP "" +Подржане врсте \fIпровере\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Уопште не израчунава проверу целовитости. Ово је обично лоша идеја. Ово +може бити корисно када се целовитост података ипак проверава на друге +начине. +.TP +\fBcrc32\fP +Израчунава CRC32 користећи полином из IEEE\-802.3 (Етернет). +.TP +\fBcrc64\fP +Израчунава CRC64 користећи полином из ECMA\-182. Ово је основно, јер је +незнатно боље од CRC32 у откривању оштећених датотека а разлика брзине је +занемарљива. +.TP +\fBsha256\fP +Израчунава SHA\-256. Ово је нешто спорије од CRC32 и CRC64. +.RE +.IP "" +Целовитост \fB.xz\fP заглавља се увек проверава са CRC32. Не може се изменити +нити искључити. +.TP +\fB\-\-ignore\-check\fP +Не проверава проверу целовитости запакованих података приликом распакивања. +CRC32 вредности у \fB.xz\fP заглављима биће још увек нормално проверене. +.IP "" +\fBНемојте користити ову опцију осим ако стварно знате шта радите.\fP Могући +разлози за коришћење ове опције: +.RS +.IP \(bu 3 +Покушава да опорави податке из оштећене „.xz“ датотеке. +.IP \(bu 3 +Убрзава распакивање. Ово има значаја углавном са SHA\-256 или са датотекама +које су запаковане стварно добро. Препоручује се да не користите ову опцију +за ову сврху осим ако је целовитост датотеке проверена споља на неки други +начин. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Бира ниво преподешености запакивања. Подразумевано је \fB\-6\fP. Ако је +наведено више нивоа преподешености, последња има дејства. Ако је произвољни +ланац филтера већ наведен, постављање нивоа преподешености запакивања уклања +произвољни ланац филтера. +.IP "" +Разлике између предподешености су још значајније него са \fBgzip\fP(1) и +\fBbzip2\fP(1). Изабране поставке запакивања одређују захтеве меморије +распакивача, стога коришћење превисоког нивоа предподешености може отежати +распакивање датотеле на старом систему са мало RAM\-а. Нарочито, \fBније добра замисао слепо користити \-9 за било шта\fP као што је често са \fBgzip\fP(1) +и \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Ово су некако брзе предподешености. \fB\-0\fP је понекад брже од \fBgzip \-9\fP док +запакује много боље. Оне више често имају брзину упоредиву са \fBbzip2\fP(1) +са упоредивом или бољом стопом запакивања, иако резултати зависе много од +врсте података који се запакују. +.TP +\fB\-4\fP ... \fB\-6\fP +Добро до врло добро запакивање које одржава коришћење меморије распакивача +разумним чак и за старе системе. \fB\-6\fP је основно, што је обично добар +избор за расподелу датотека које треба да могу да се распакују чак и на +системима са само 16\ MiB RAM\-а. (\fB\-5e\fP или \fB\-6e\fP може бити вредно +узимања у обзир. Видите \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Као \fB\-6\fP али са већим захтевима меморије запакивача и распакивача. Корисне +су само приликом запакивања датотека већих од 8\ MiB, 16\ MiB и 32\ MiB. +.RE +.IP "" +На истом хардверу, брзина распакивања је приближно сталан број бајтова +запакованих података у секунди. Другим речима, биће боље запакивање, брже +распакивање. То такође значи да количина незапакованог излаза произведеног +у секунди може много да се разликује. +.IP "" +Следећа табела резимира функције предподешености: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Описи колона: +.RS +.IP \(bu 3 +ВлчРчнка је величина LZMA2 речника. Коришћење речника већег од величине +незапаковане датотеке је губитак меморије. Зато је добро избегавати +коришћење предподешености \fB\-7\fP ... \fB\-9\fP када за њима нема стварне +потребе. Са \fB\-6\fP и нижим, количина изгубљене меморије је обично довољно +ниска да нема значаја. +.IP \(bu 3 +ЗапакЦПЈ је поједностављено представљање LZMA2 поставки које утичу на брзину +запакивања. Величина речника такође утиче на брзину, тако док је ЗапакЦПЈ +исто за нивое \fB\-6\fP ... \fB\-9\fP, виши нивои још увек теже да буду спорији. Да +добијете још спорије и самим тим можда боље запакивање, видите \fB\-\-extreme\fP. +.IP \(bu 3 +ЗапакМем садржи захтеве меморије запакивача у режиму једне нити. Може +незнатно да се разликује између \fBxz\fP издања. +.IP \(bu 3 +РаспМем садржи захтеве меморије распакивача. Тако је, поставке запакивања +одређују захтеве меморије распакивача. Тачно коришћење меморије распакивача +је незнатно веће од величине LZMA2 речника, али су вредности у табели +заокружене на следећи цео MiB. +.RE +.IP "" +Захтеви меморије режима са више нити су значајно већи него ли режима једне +нити. Са основном вредношћу \fB\-\-block\-size\fP, свакој нити треба 3*3*ВлчРчнка +плус ЗапакМем или РаспМем. На пример, за четири нити са предподешавањем +\fB\-6\fP потребно је 660\(en670\ MiB меморије. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Користите спорију варијанту изабраног нивоа предподешености запакивања +(\fB\-0\fP ... \fB\-9\fP) у нади да ћете добити мало бољу стопу запакивања, али уз +лошу срећу ово је може учинити гором. Не утиче на коришћење меморије +распакивача, али се коришћење меморије запакивача мало повећава на нивоима +предподешености \fB\-0\fP ... \fB\-3\fP. +.IP "" +Како постоје две предподешености са величинама речника од 4\ MiB и 8\ MiB, +предподешености \fB\-3e\fP и \fB\-5e\fP користе незнатно брже поставке (ниже +CompCPU) него \fB\-4e\fP и \fB\-6e\fP. На тај начин нема две истоветне +предподешености. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Преподешеност;ВлчРчнка;ЗапакЦПЈ;ЗапакМем;РаспМем +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +На пример, има укупно четири предподешавања која користе 8\ MiB речник, чији +поредак од најбржег до најспоријег је \fB\-5\fP, \fB\-6\fP, \fB\-5e\fP и \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Ово су помало погрешни алијаси за \fB\-0\fP и \fB\-9\fP. Достављени су само зарад +повратне сагласности са LZMA Utils\-ом. Избегавајте коришћење ових опција. +.TP +\fB\-\-block\-size=\fP\fIвеличина\fP +Приликом запакивања у \fB.xz\fP формат, дели улазне податке на блокове +\fIвеличина\fP бајта. Блокови се запакују независно један од другог, што +помаже у раду са више нити и чини ограничено распакивање насумичног приступа +могућим. Ова опција се обично користи да се препише основна величина блока +у режиму са више нити, али се ова опција може такође користити и у режиму +једне нити. +.IP "" +У режиму више нити око три пута \fIвеличина\fP бајтова биће додељено у свакој +нити за међумеморисање улаза и излаза. Основна \fIвеличина\fP је три пута +величине LZMA2 речника или 1 MiB, шта год да је више. Обично добра вредност +је 2\(en4 пута величина LZMA2 речника или барем 1 MiB. Коришћење +\fIвеличине\fP мање од величине LZMA2 речника је трошење RAM\-а јер тада +међумеморија LZMA2 речника никада неће бити потпуно коришћена. У режиму +више нити, величине блокова се чувају у заглављима блока. Ова информација +величине је потребна за распакивање са више нити. +.IP "" +У режиму једне нити никаква подела блока се не ради по основи. Постављање +ове опције не утиче на коришћење меморије. Никакве информације о величини +се не чувају у заглављима блока, стога датотеке направљене у режиму једне +нити неће бити исте као датотеке направљене у режиму више нити. Недостатак +информација о величини такође значи да \fBxz\fP неће моћи да распакује датотеке +у режиму више нити. +.TP +\fB\-\-block\-list=\fP\fIставке\fP +Приликом запакивања у \fB.xz\fP формат, почиње нови блок са изборним +произвољним ланцем филтера након датих интервала незапакованих података. +.IP "" +\fIСтавке\fP су списак одвојен зарезом. Свака ставка се састоји од изборног +броја ланца филтера између 0 и 9 за којим следи двотачка (\fB:\fP) и захтевана +величина незапакованих података . Изостављање неке ставке (два или више +узастопна зареза) је пречица за коришћење величине и филтера претходне +ставке. +.IP "" +Ако је улазна датотека већа од збира величина у \fIставкама\fP, последња ставка +се понавља све до краја датотеке. Специјална вредност \fB0\fP може се +користити као последња величина да назначи да остатак датотеке треба да буде +шифрован као један блок. +.IP "" +Алтернативни ланац филтера за сваки блок се може навести у комбинацији са +опцијама \fB\-\-filters1=\fP\fIфилтера\fP \&...\& \fB\-\-filters9=\fP\fIфилтери\fP. Ове +опције дефинишу ланце филтера са одредником између 1\(en9. Ланац филтера 0 +се може користити да упућује на основно ланац филтера, који је исти јер се +ланац филтера не наводи. Одредник ланца филтера се може користити пре +незапаковане величине, за којим следи двотачка (\fB:\fP). На пример, ако +наведемо \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP тада ће се за +прављење блокова користити: +.RS +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters1\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters3\fP и 2 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Ланац филтера наведен са \fB\-\-filters2\fP и 4 MiB улазом +.IP \(bu 3 +Основни ланац филтера и 2 MiB улаз +.IP \(bu 3 +Основни ланац филтера и 4 MiB улаз за сваки блок до краја улаза. +.RE +.IP "" +Ако наведемо величину која премашује величину блока шифрера (било основну +вредност у режиму нити или вредност наведену са +\fB\-\-block\-size=\fP\fIвеличина\fP), шифрер ће направити додатне блокове док ће +задржати границе наведене у \fIставкама\fP. На пример, ако наведемо +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP а улазна +датотека је 80 MiB, добићемо 11 блокова: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10 +и 1 MiB. +.IP "" +У режиму са више нити величине блокова се чувају у заглављима блока. Ово се +не ради у режиму једне нити, тако да шифровани излаз неће бити истоветан +ономе у режиму са више нити. +.TP +\fB\-\-flush\-timeout=\fP\fIистек_времена\fP +Приликом запакивања, ако је више од \fIвреме_истека\fP милисекунди (позитиван +цео број) прошло од претходног испирања и читање више улаза ће блокирати, +сви заказани улазни подаци се испирају из шифрера и чине доступним у +излазном току. Ово може бити корисно ако је \fBxz\fP коришћен за запакивање +података који су слати преко мреже. Мала вредност \fIвременског_истека\fP чини +податке доступним на пријемни крај са малим закашњењем, али велика вредност +\fIвремена_истека\fP даје бољу стопу запакивања. +.IP "" +Ова функција је искључена по основи. Ако је ова опција наведена више пута, +последња има дејства. Нарочита вредност \fIвременског истека\fP \fB0\fP може се +користити за изричито искључивање ове функције. +.IP "" +Ова функција је доступна само на POSIX системима. +.IP "" +.\" FIXME +\fBОва функција је још увек експериментална.\fP Тренутно \fBxz\fP није погодан за +распакивање тока у реалном времену због начина на који \fBxz\fP ради +међумеморисање. +.TP +\fB\-\-no\-sync\fP +Не усклађује циљну датотеку и њену фасциклу на смештајном уређају пре +уклањања изворне датотеке. Ово може побољшати учинковитост ако се запакује +или распакује много малих датотека. Међутим, ако се систем уруши одмах +након брисања, може бити да циљна датотека не буде уписана на смештајном +уређају али радња брисања јесте. У том случају неће бити доступна ни +оригинална изворна ни циљна датотека. +.IP "" +Ова опција има дејство само када се \fBxz\fP спрема да уклони изворну +датотеку. У осталим случајевима усклађивање се не ради никада. +.IP "" +Синхронизација и \fB\-\-no\-sync\fP су додате у \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије запакивања. Ако је ова опција +наведена више пута, последња ступа у дејство. +.IP "" +Ако поставке запакивања премаше \fIограничење\fP, \fBxz\fP ће покушати да врати +назад поставке тако да ограничење више није прекорачено и приказаће +обавештење да је урађено аутоматско дотеривање. Дотеривања се раде следећим +редом: смањење броја нити, пребацивање на режим једне нити ако чак и једна +нит у режиму више нити премаши \fIограничење\fP и на крају смањење величине +LZMA2 речника. +.IP "" +Приликом запакивања са \fB\-\-format=raw\fP или ако је наведено \fB\-\-no\-adjust\fP, +само број нити може бити умањен јер може да се уради а да се не делује на +излаз запакованог. +.IP "" +Ако \fIограничење\fP не може бити задовољено чак и са поравнањима описаним +изнад, приказује се грешка и \fBxz\fP ће изаћи са излазним стањем 1. +.IP "" +\fIОграничење\fP се може навести на више начина: +.RS +.IP \(bu 3 +\fIОграничење\fP може бити апсолутна величина у бајтима. Коришћење суфикса +целог броја као \fBMiB\fP може бити корисно. Пример: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIОграничење\fP се може навести као проценат укупне физичке меморије (RAM). +Ово може бити корисно нарочито приликом постављања променљиве окружења +\fBXZ_DEFAULTS\fP у скрпти покретања конзоле која се дели између различитих +рачунара. На тај начин ограничење је аутоматски веће на системима са више +меморије. Пример: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIОграничење\fP се може вратити на своју основну вредност његовим постављањем +на \fB0\fP. Ово је тренутно исто што и постављање \fIограничења\fP на \fBmax\fP (без +ограничења коришћења меморије). +.RE +.IP "" +За \fBxz\fP 32\-бита имамо посебан случај: ако \fIограничење\fP треба да буде преко +\fB4020\ MiB\fP, \fIограничење\fP се поставља на \fB4020\ MiB\fP. Али на MIPS32 +користи се \fB2000\ MiB\fP. (На вредности \fB0\fP и \fBmax\fP ово не утиче. Слична +функција не постоји за распакивање.) Ово може бити од помоћи када извршна +од 32\-бита има приступ адресном простору од 4\ GiB (2 GiB на MIPS32) док +срећом не чини ништа лоше у осталим приликама. +.IP "" +Видите такође одељак \fBКоришћење меморије\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање. Ово такође утиче на +\fB\-\-list\fP режим. Ако радња није могућа а да се не премаши \fIограничење\fP, +\fBxz\fP ће приказати грешку а распакивање датотеке неће успети. Видите +\fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине о навођењу +\fIограничења\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP +Поставља ограничење коришћења меморије за распакивање са више нити. Ово +може утицати само на број нити; ово никада неће учинити да \fBxz\fP одбије да +распакује датотеке. Ако је \fIограничење\fP превише ниско да омогући било који +рад са више нити, \fIограничење\fP се занемарује а \fBxz\fP ће наставити у режиму +једне нити. Знајте да ако се такође користи \fB\-\-memlimit\-decompress\fP, увек +ће се применити и на режим једне и на режим више нити, и тако да стварно +\fIограничење\fP за више нити никада неће бити више од ограничења постављеног +са \fB\-\-memlimit\-decompress\fP. +.IP "" +У супротности са другим опцијама ограничења коришћења меморије, +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP има систему специфично основно +\fIограничење\fP. \fBxz \-\-info\-memory\fP се може користити да видите тренутну +вредност. +.IP "" +Ова опција и њена основна вредност постоје јер без икаквог ограничења нитни +распакивач ће завршити са додељивањем неразумног износа меморије са неким +улазним датотекама. Ако је основно \fIограничење\fP превише ниско на вашем +систему, слободно повећајте \fIограничење\fP али га никада не постављајте на +вредност већу од износа употребљивог RAM\-а јер са одговарајућим улазним +датотекама \fBxz\fP ће покушати да користи тај износ меморије чак и са малим +бројем нити. Остајући без меморије или разменом неће се побољшати +учинковитост распакивања. +.IP "" +Видите \fB\-\-memlimit\-compress=\fP\fIограничење\fP за могуће начине за навођење +\fIограничења\fP. Постављање \fIограничења\fP на \fB0\fP враћа \fIограничење\fP на +систему специфичну основну вредност. +.TP +\fB\-M\fP \fIограничење\fP, \fB\-\-memlimit=\fP\fIограничење\fP, \fB\-\-memory=\fP\fIограничење\fP +Ово је исто као и навођење \fB\-\-memlimit\-compress=\fP\fIограничење\fP +\fB\-\-memlimit\-decompress=\fP\fIограничење\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIограничење\fP. +.TP +\fB\-\-no\-adjust\fP +Приказује грешку и излази ако ограничење коришћења меморије не може бити +задовољено без дотеривања поставки које утичу на запаковани излаз. Тако је, +ово спречава \fBxz\fP да промени шифрера из режима више нити у режим једне нити +и да смањи величину LZMA2 речника. Чак и када се ова опција користи број +нити се може смањити да задовољи ограничење коришћења меморије јер то неће +утицати на запаковани излаз. +.IP "" +Аутоматско дотеривање је увек искључено приликом стварања сирових токова +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIнити\fP, \fB\-\-threads=\fP\fIнити\fP +Наводи број нити радника за коришћење. Постављање \fIнити\fP на посебну +вредност \fB0\fP чини да \fBxz\fP користи онолико нити колико процесор на систему +подржава. Стварни број нити може бити мањи од \fIнити\fP ако улазна датотека +није довољно велика за нитисање са датим поставкама или ако ће коришћење +више нити премашити ограничење коришћења меморије. +.IP "" +Запакивачи једне нити и више нити дају различите излазе. запакивач једне +нити даће мању величину датотеке али само излаз из запакивача више нити може +бити распакован коришћењем више нити. Постављање \fIнити\fP на \fB1\fP користиће +режим једне нити. Постављање \fIнити\fP на неку другу вредност, укључујући +\fB0\fP, користиће запакивач више нити чак и ако систем подржава само једну нит +хардвера. (\fBxz\fP 5.2.x је користио режим једне нити у овој прилици.) +.IP "" +Да користите вишенитни режим са само једном нити, поставите \fIнити\fP на +\fB+1\fP. Префикс \fB+\fP нема дејства са вредностима које нису \fB1\fP. Ограничење +коришћења меморије може још увек учинити да се \fBxz\fP пребаци на режим једне +нити осим ако се не користи \fB\-\-no\-adjust\fP. Подршка за префикс \fB+\fP је +додата у \fBxz\fP 5.4.0. +.IP "" +Ако је затражен аутоматски број нити и није наведено ограничење коришћења +меморије, тада ће се користити основно меко ограничење специфично за систем +за могуће ограничење броја нити. То је меко ограничење у смислу да се +занемарује ако број нити постане један, дакле меко ограничење никада неће +зауставити \fBxz\fP од запакивања или распакивања. Ово основно меко ограничење +неће учинити да се \fBxz\fP пребаци из режима више нити у режим једне нити. +Активно ограничење се може видети са + \fBxz \-\-info\-memory\fP. +.IP "" +Тренутно једина метода нитисања је да се подели улаз на блокове и да се +запакују независно један од другог. Основна величина блока зависи од нивоа +запакивања и може се преписати опцијом \fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Нитно распакивање ради само на датотекама које садрже више блокова са +информацијом величине у заглављима блока. Све довољно велике датотеке +запаковане у вишенитном режиму задовољавају овај услов, али датотеке +запаковане у једнонитном режиму не чак и ако је коришћено +\fB\-\-block\-size=\fP\fIвеличина\fP. +.IP "" +Основна вредност за \fIнити\fP је \fB0\fP. У \fBxz\fP 5.4.x и старијим основно је +\fB1\fP. +. +.SS "Произвољни ланци филтера запакивача" +Произвољни ланац филтера омогућава детаљно одређивање подешавања сажимања +уместо да се ослања на подешавања повезана са предподешавањима. Када је +произвољни ланац филтера наведен, опције предподешавања (\fB\-0\fP \&...\& \fB\-9\fP +и \fB\-extreme\fP) раније на линији наредби се заборављају. Ако је опција +предподешавања наведена након једне или више опција произвољног ланца +филтера, ново предподешавање ступа на снагу а раније наведене опције +произвољног ланца филтера се заборављају. +.PP +Ланац филтера је упоредив са спојкама на линији наредби. Приликом сажимања, +несажети улаз иде на први филтер, чији излаз иде на следећи филтер (ако фа +има). Излаз последњег филтера бива записан у сажету датотеку. Највећи број +филтера у ланцу је четири, али обично ланац филтера има само један или два +филтера. +.PP +Многи филтери имају ограничења о томе где могу бити у ланцу филтера: неки +филтери могу радити само као последњи филтер у ланцу, неки само као +не\-последњи филтер, а неки раде на било ком месту у ланцу. Овисно о +филтеру, ово ограничење је или својствено дизајну филтера или постоји како +би се спречили проблеми безбедности. +.PP +Произвољни ланац филтера се може навести на два различита начина. Опције +\fB\-\-filters=\fP\fIфилтери\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP омогућавају навођење читавог ланца опција у једној +опцији коришћењем синтаксу ниске „liblzma“ филтера. Другачије, ланац +филтера се може навести коришћењем једне или више појединачних опција +филтера редом како се траже у ланцу филтера. То је то, редослед +појединачних опција филтера је важан! Приликом дешифровања сирових токова +(\fB\-\-format=raw\fP), ланац филтера мора бити наведен истим редом као када је +био наведен приликом сажимања. Било који појединачни филтер или опције +предподешавања наведене пре опције читавог ланца (\fB\-\-filters=\fP\fIфилтери\fP) +биће заборављене. Појединачни филтери наведени после опције читавог ланца +ће поништити поставку ланца филтера. +.PP +Обе опције и пуног и појединачног филтера узимају филтеру специфичне +\fIопције\fP као зарезом раздвојен списак. Додатни зарези у \fIопцијама\fP се +занемарују. Свака опција има основну вредност, тако да треба да наведете +оне које желите да измените. +.PP +Да видите читав ланац филтера и \fIопције\fP, користите \fBxz \-vv\fP (тако је, +користите \fB\-\-verbose\fP два пута). Ово ради такође за преглед опција ланца +филтера коришћених од стране предподешености. +.TP +\fB\-\-filters=\fP\fIфилтери\fP +Наводи цео ланац филтера или предподешеност у једној опцији. Сваки филтер +се може одвојити размацима или са две цртице (\fB\-\-\fP). \fIФилтери\fP можда +треба да буду под наводницима на линији наредби конзоле тако да се +прослеђују као једна опција. Да означите \fIопције\fP, користите \fB:\fP или +\fB=\fP. Предподешености се може додати префикс \fB\-\fP и може га пратити нула +или још заставица. Једина подржана заставица је \fBe\fP за примену истих +опција као \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфилтери\fP ... \fB\-\-filters9\fP=\fIфилтери\fP +Наводи до девет додатних ланаца филтера који се могу користити са +\fB\-\-block\-list\fP. +.IP "" +На пример, приликом запакивања архиве са извршним датотекама за којима следе +текстуалне датотеке, извршни део треба да користи ланац филтера са BCJ +филтером а текстуални део само LZMA2 филтер. +.TP +\fB\-\-filters\-help\fP +Приказује поруку помоћи описујући како се наводе предподешавања и произвољни +ланци филтера у опцијама \fB\-\-filters\fP и \fB\-\-filters1=\fP\fIфилтери\fP \&...\& +\fB\-\-filters9=\fP\fIфилтери\fP, и успешно излази. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIопције\fP] +.PD +Додаје LZMA1 или LZMA2 филтер у ланац филтера. Ови филтери се могу +користити само као последњи филтер у ланцу. +.IP "" +LZMA1 је стари филтер, који је подржан углавном само због старог формата +\&\fB.lzma\fP датотеке, који подржава само LZMA1. LZMA2 је освежено издање LZMA1 +које поправља неке практичне проблеме LZMA1. \fB.xz\fP формат користи LZMA2 и +не подржава LZMA1 уопште. Брзина запакивања и односи LZMA1 и LZMA2 су +практично исти. +.IP "" +LZMA1 и LZMA2 деле исти скуп \fIопција\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIпредподешавање\fP +Враћа све LZMA1 или LZMA2 \fIопције\fP на \fIпредподешеност\fP. \fIПредпдешеност\fP +се састоји од целог броја, за којим може да следи једнословни измењивач +предподешености. Цео број може бити од \fB0\fP до \fB9\fP, поклапајући опције +линије наредби \fB\-0\fP \&...\& \fB\-9\fP. Једини тренутно подржани измењивач је +\fBe\fP, који се поклапа са \fB\-\-extreme\fP. Ако \fBpreset\fP није наведено, основне +вредности LZMA1 или LZMA2 \fIопција\fP се узимају из предподешености \fB6\fP. +.TP +\fBdict=\fP\fIвеличина\fP +\fIВеличина\fP речника (међумеморија историјата) указује на то колико је +бајтова недавно обрађених нераспакованих података задржано у меморији. +Алгоритам покушава да нађе понављајуће низове бајтова (поклапања) у +нераспакованим подацима, и да их замени са упутама ка подацима који су +тренутно у речнику. Што је већи речник, већа је вероватноћа за налажење +поклапања. Стога, повећање \fIвеличине \fP речника обично побољшава стопу +запакивања, али речник већи од незапаковане датотеке јесте утрошак меморије. +.IP "" +Уобичајена \fIвеличина\fP речника је од 64\ KiB до 64\ MiB. Најмање је 4\ KiB. Највише за запакивање тренутно је 1.5\ GiB (1536\ MiB). Распакивач +већ подржава речнике до једног бајта мање од 4\ GiB, што је максимум за +формате LZMA1 и LZMA2 тока. +.IP "" +\fIВеличина\fP речника и налазач поклапања (\fImf\fP) заједно одређују коришћење +меморије за LZMA1 или LZMA2 шифрере. Иста (или већа) \fIвеличина\fP речника је +потребна за распакивање као она која је коришћена за запаквање, стога се +коришћење меморије дешифрера одређује према величини речника коришћеног за +запакивање. \fB.xz\fP заглавља чувају \fIвеличину\fP речника или као 2^\fIn\fP или +2^\fIn\fP + 2^(\fIn\fP\-1), тако да су те \fIвеличине\fP некако пожељније за +запакивање. Друге \fIвеличине\fP биће заокружене приликом чувања у \fB.xz\fP +заглављима. +.TP +\fBlc=\fP\fIlc\fP +Наводи број битова контекста литерала. Најмање је 0 а највише је 4; основно +је 3. Као додатак, збир \fIlc\fP и \fIlp\fP не сме да премаши 4. +.IP "" +Сви бајтови који се не могу шифровати јер су поклапања шифрована као +литерали. То је то, литерали су једноставно 8\-битни бајтови који су +шифровани један по један. +.IP "" +Кодирање литерала врши претпоставку да највећи \fIlc\fP битови претходног +незапакованог бајта су у узајамној вези са следећим бајтом. На пример, у +уобичајеном енглеском тексту, за великим словом често следи мало слово, а за +малим словом обично следи још једно мало слово. У скупу US\-ASCII знакова, +највиша три бита су 010 за велика слова и 011 за мала слова. Када је \fIlc\fP +барем 3, кодирање литерала може имати предност овог својства у незапакованим +подацима. +.IP "" +Основна вредност (3) је обично добра. Ако желите највеће запакивање, +испробајте \fBlc=4\fP. Некад то мало помогне а некад чини запакивање горим. +Ако га учини горим, испробајте такође \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Наводи број битова положаја литерала. Најмање је 0 а највише је 4; основно +је 0. +.IP "" +\fILp\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева приликом шифровања литерала. Видите \fIpb\fP испод за више +информација о поравнању. +.TP +\fBpb=\fP\fIpb\fP +Наводи број битова положаја. Најмање је 0 а највише је 4; основно је 2. +.IP "" +\fIPb\fP утиче на то која врста поравнања у незапакованим подацима се +подразумева у опште. Основно значи четворобајтно поравнање (2^\fIpb\fP=2^2=4), +што је често добар избор када нема бољег решења. +.IP "" +Када је поравнање познато, постављање одговарајућег \fIpb\fP може мало да смањи +величину датотеке. На пример, са датотекама текста које имају поравнање +једног бајта (US\-ASCII, ISO\-8859\-*, UTF\-8), постављање \fBpb=0\fP може незнатно +да побољша запакивање. За UTF\-16 текст, \fBpb=1\fP је добар избор. Ако је +поравнање непаран број као 3 бајта, \fBpb=0\fP може бити најбољи избор. +.IP "" +Иако се претпостављено поравнање може подесити са \fIpb\fP и \fIlp\fP, LZMA1 и +LZMA2 и даље незнатно фаворизују 16\-бајтно поравнање. То би могло бити +вредно узети у обзир приликом дизајнирања формата датотека које ће вероватно +бити често запаковане са LZMA1 или LZMA2. +.TP +\fBmf=\fP\fImf\fP +Налазач поклапања има главни утицај на брзину шифрера, коришћење меморије и +стопу запакивања. Обично Hash Chain налазачи поклапања су бржи од Binary +Tree налазача поклапања. Основност зависи од \fIпредподешености\fP: 0 користи +\fBhc3\fP, 1\(en3 користи \fBhc4\fP, а остало користи \fBbt4\fP. +.IP "" +Следећи налазачи поклапања су подржани. Формуле коришћења меморије испод су +грубе апроксимације које су ближе стварности када је \fIречник\fP степен +двојке. +.RS +.TP +\fBhc3\fP +Ланац хеша са хеширањем 2\- и 3\-бајта +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 5.5 + 64 MiB (if \fIречник\fP > 16 MiB) +.TP +\fBhc4\fP +Ланац хеша са хеширањем 2\-, 3\- и 4\-бајта +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 7.5 (ако је \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 6.5 (ако је \fIречник\fP > 32 MiB) +.TP +\fBbt2\fP +Бинарно стабло са 2\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 2 +.br +Коришћење меморије: \fIречник\fP * 9.5 +.TP +\fBbt3\fP +Бинарно стабло са 2\- и 3\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 3 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 16 MiB); +.br +\fIречник\fP * 9.5 + 64 MiB (ако је \fIречник\fP > 16 MiB) +.TP +\fBbt4\fP +Бинарно стабло са 2\-, 3\-, и 4\-бајта хеширања +.br +Најмања вредност за \fIфино\fP: 4 +.br +Коришћење меморије: +.br +\fIречник\fP * 11.5 (if \fIречник\fP <= 32 MiB); +.br +\fIречник\fP * 10.5 (if \fIречник\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIрежим\fP +\fIРежим\fP запакивања наводи методу за анализу података које произведе налазач +поклапања. Подржани \fIрежими\fP су \fBfast\fP и \fBnormal\fP. Подразумева се +\fBfast\fP за \fIпредподешавања\fP 0\(en3 и \fBnormal\fP за \fIпредподешавања\fP 4\(en9. +.IP "" +Обично се \fBfast\fP користи са налазачима Hash Chain поклапања а \fBnormal\fP са +налазачима Binary Tree поклапања. Ово је исто што раде и +\fIпредподешености\fP. +.TP +\fBnice=\fP\fIфино\fP +Наводи оно што се сматра да је фина дужина за поклапање. Када се поклапање +од барем \fInice\fP бајтова нађе, алгоритам зауставља тражење могућих бољих +поклапања. +.IP "" +\fIФино\fP може бити 2\(en273 бајта. Веће вредности теже да дају бољу стопу +запакивања на уштрб брзине. Основно зависи од \fIпредподешавања\fP. +.TP +\fBdepth=\fP\fIдубина\fP +Наводи највећу дубину претраге у налазачу поклапања. Основно је посебна +вредност 0, која чини да запакивач одреди разумљиву \fIдубину\fP из \fImf\fP и +\fInice\fP. +.IP "" +Разумљива \fIдубина\fP за ланце хеша је 4\(en100 и 16\(en1000 за стабло +извршних. Коришћење врло великих вредности за \fIдубину\fP може учинити шифрер +врло спорим са неким датотекама. Избегавајте постављање \fIдубине\fP преко +1000 осим ако нисте спремни да прекинете запакивање у случају да потраје +превише дуго. +.RE +.IP "" +Приликом дешифровања сирових токова (\fB\-\-format=raw\fP), LZMA2 треба само +\fIвеличина\fP речника. LZMA1 треба такође \fIlc\fP, \fIlp\fP и \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIопције\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIопције\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIопције\fP] +.PD +Додаје „branch/call/jump“ (BCJ) филтер ланцу филтера. Ови филтери могу се +користити само ако нису последњи филтер у ланцу филтера. +.IP "" +BCJ филтер претвара релативне адресе у машинском коду на њихове апсолутне +двојнике. Ово не мења величину података, али повећава сувишност, што може +помоћи LZMA2 да произведе 0\(en15\% мању \fB.xz\fP датотеку. BCJ филтери су +увек реверзибилни, стога коришћење BCJ филтера за погрешну врсту података не +доводи ни до каквог губитка података, мада може да учини степен сажимања +нешто лошијим. BCJ филтери су врло брзи и користе безначајну количину +меморије. +.IP "" +Ови BCJ филтери имају познате проблеме везане за стопу запакивања: +.RS +.IP \(bu 3 +Неке врсте датотека које садрже извршни код (на пример, објектне датотеке, +статичке библиотеке и модули Линукс кернела) имају адресе у упутствима +испуњеним вредностима попуњавача. Ови BCJ филтери и даље ће радити +претварање адресе, што ће запакивање учинити горим са овим датотекама. +.IP \(bu 3 +Ако се BCJ филтер примени на архиву, могуће је да ће учинити стопу +запакивања лошијим него кад се не би користио. На пример, ако постоје +сличне или чак истоветне извршне тада ће филтрирање вероватно учинити +датотеке мање сличним и стога је запакивање лошије. Садржај не\-извршних +датотека у истој архиви је такође важан. У пракси се мора покушати са и без +BCJ филтера да би се видело шта је боље у којој прилици. +.RE +.IP "" +Различити скупови упутстава имају различита поравнања: извршна датотека мора +бити поравната на множилац ове вредности у улазним подацима како би филтер +радио. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Филтер;Поравнање;Напомене +x86;1;32\-бита или 64\-бита x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-бита поравнање је најбоље +PowerPC;4;Само велика крајност +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Како су BCJ\-филтрирани подаци обично запаковани са LZMA2, стопа запакивања +може бити незнатно побољшана ако су LZMA2 опције постављене да поклопе +поравнање изабраног BCJ филтера. Примери: +.RS +.IP \(bu 3 +IA\-64 филтер има поравнање 16\-бајта тако да је \fBpb=4,lp=4,lc=0\fP добро са +LZMA2 (2^4=16). +.IP \(bu 3 +RISC\-V код има поравнање од 2 или 4 бајта у зависности од тога да ли +датотека садржи запаковане инструкције од 16 бита (проширење C). Када се +користе инструкције од 16 бита, \fBpb=2,lp=1,lc=3\fP или \fBpb=1,lp=1,lc=3\fP је +добро. Када нема инструкција од 16 бита, \fBpb=2,lp=2,lc=2\fP је најбоље. +\fBreadelf \-h\fP се може користити да се провери да ли се „RVC“ јавља у реду +„Заставице“. +.IP \(bu 3 +ARM64 је увек 4\-бајта поравнат тако да је \fBpb=2,lp=2,lc=2\fP најбоље. +.IP \(bu 3 +Филтер x86 је изузетак. Обично је добро придржавати се LZMA2 основности +(\fBpb=2,lp=0,lc=3\fP) приликом запакивања x86 извршних. +.RE +.IP "" +Сви BCJ филтери подржавају исте \fIопције\fP: +.RS +.TP +\fBstart=\fP\fIпомерај\fP +Наводи \fIпомерај\fP почетка који се користи приликом претварања између +релативних и апсолутних адреса. \fIПомерај\fP мора бити производ поравнања +филтера (видите табелу изнад). Основно је нула. У пракси, основност је +добра; навођење произвољног \fIпомераја\fP скоро никада није од користи. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIопције\fP] +Додаје Delta филтер у ланац филтера. Делта филтер може се користити само +ако није последњи филтер у ланцу филтера. +.IP "" +Тренутно је подржан само једноставан делта прорачун једног по једног бита. +Може бити користан приликом запакивања, на пример, незапакованих битмап +слика или незапакованог PCM звука. Међутим, алгоритми посебне намене могу +дати знатно боље резултате него Delta + LZMA2. Ово је тачно, посебно са +звуком, који се запакује брже и боље, на пример, са \fBflac\fP(1). +.IP "" +Подржане \fIопције\fP: +.RS +.TP +\fBdist=\fP\fIрастојање\fP +Наводи \fIрастојање\fP делта прорачуна у бајтима. \fIРастојање\fP мора бити +1\(en256. Основно је 1. +.IP "" +На пример, са \fBdist=2\fP и осмобајтним улазом A1 B1 A2 B3 A3 B5 A4 B7, излаз +ће бити A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Остале опције" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Потискује упозорења и обавештења. Наведите ово два пута да потиснете и +грешке. Ова опција нема утицаја на стање излаза. Тако је, чак и ако је +упозорење потиснуто, стање излаза које указује на упозорење се и даље +користи. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Бива опширан. Ако је стандардна грешка повезана са терминалом, \fBxz\fP ће +приказати указивач напретка. Навођењем \fB\-\-verbose\fP два пута добија се још +опширнији излаз. +.IP "" +Указивач напредовања показује следеће информације: +.RS +.IP \(bu 3 +Проценат довршености се показује ако је величина улазне датотеке позната. +Тако је, проценат се не може приказати у спојкама. +.IP \(bu 3 +Количина запакованих података проистеклих (запакивање) или утрошених +(распакивање). +.IP \(bu 3 +Количина распакованих података утрошених (запакивање) или проистеклих +(распакивање). +.IP \(bu 3 +Размера паковања, која се израчунава дељењем количине запакованих података +обрађених до сада количином незапакованих података до сада обрађених. +.IP \(bu 3 +Брзина запакивања или распакивања. Ово се мери као количина незапакованих +података утрошених (запакивање) или добијених (распакивање) у секунди. +Приказује се након неколико секунде након што \fBxz\fP започне обраду датотеке. +.IP \(bu 3 +Протекло време у формату М:СС или Ч:ММ:СС. +.IP \(bu 3 +Процењено преостало време се приказује само када је величина улазне датотеке +позната и неколико секунди је већ протекло од кад је \fBxz\fP започео обраду +датотеке. Време се приказује у мање тачном формату које никада нема +двотачке, на пример, 2 мин 30 сек. +.RE +.IP "" +Када стандардна грешка није терминал, \fB\-\-verbose\fP ће учинити да \fBxz\fP +испише назив датотеке, запаковану величину, незапаковану величину, стопу +запакивања и по могућству такође брзину и протекло време на једном реду на +стандардну грешку након запакивања или распакивања датотеке. Брзина и +протекло време су укључени само када радња потраје барем неколико секунде. +Ако се радња не заврши, на пример, услед што корисник прекине, такође се +исписује проценат завршености ако је величина улазне датотеке позната. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не поставља стање излаза на 2 чак и ако је услов вредан упозорења откривен. +Ова опција не утиче на ниво опширности, стога и \fB\-\-quiet\fP и \fB\-\-no\-warn\fP +треба да се користе да се не приказују упозорења и да се не измени стање +излаза. +.TP +\fB\-\-robot\fP +Исписује поруке у формату обрадивом машинама. Ово је замишљено да олакша +писање челника који желе да користе \fBxz\fP уместо „liblzma“, што може бити +случај са разним скриптама. Излаз са овом опцијом укљученом је замишљен да +буде стабилан кроз \fBxz\fP издања. Видите одељак \fBРЕЖИМ РОБОТА\fP за више о +томе. +.TP +\fB\-\-info\-memory\fP +Приказује, у формату читљивом људима, колико физичке меморије (RAM) и колико +нити процесора \fBxz\fP мисли да систем има и ограничења коришћења меморије за +запакивање и распакивање и излази успешно. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи описујући најчешће коришћених опција, и успешно +излази. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Приказује поруку помоћи описујући све функције \fBxz\fP, и успешно излази +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxz\fP и „liblzma“ у формату читљивом људима. Да +добијете излаз машинама обрадив, наведите \fB\-\-robot\fP пре \fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота се покреће опцијом \fB\-\-robot\fP. Чини да излаз \fBxz\fP буде лакши +за обраду другим програмима. Тренутно \fB\-\-robot\fP је подржано само заједно +са \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP, и \fB\-\-version\fP. Биће +подржан за запакивање и распакивање у будућности. +. +.SS "Режим списка" +\fBxz \-\-robot \-\-list\fP користи излаз раздвојен табулатором. Прва колона +сваког реда садржи ниску која указује на врсту информације која се налази у +том реду: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP (назив) +Ово је увек први ред приликом почетка листања датотеке. Друга колона у реду +је назив датотеке. +.TP +\fBfile\fP (датотека) +Овај ред садржи свеукупне информације о \fB.xz\fP датотеци. Овај ред се увек +исписује после реда \fBназив\fP. +.TP +\fBstream\fP (ток) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има толико +редова \fBтока\fP колико има токова у \fB.xz\fP даатотеци. +.TP +\fBblock\fP (блок) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено. Има онолико +редова \fBблока\fP колико има блокова у \fB.xz\fP датотеци. Редови \fBблока\fP се +приказују након свих редова \fBтока\fP; различите врсте реда се не преплићу. +.TP +\fBsummary\fP (сажетак) +Ова врста реда се користи само када је \fB\-\-verbose\fP наведено два пута. Овај +ред се исписује након свих редова \fBблока\fP. Као ред \fBдатотека\fP, ред +\fBсажетка\fP садржи преглед информација о \fB.xz\fP датотеци. +.TP +\fBtotals\fP (укупност) +Овај ред је увек последњи ред на списку излаза. Показује укупне збирове и +величине. +.PP +Колоне редова \fBдатотеке\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова у датотеци +.IP 3. 4 +Укупан број блокова у току(овима) +.IP 4. 4 +Величина запаковане датотеке +.IP 5. 4 +Величина незапаковане датотеке +.IP 6. 4 +Размера паковања, на пример, \fB0.123\fP. Ако је размера преко 9.999, три +цртице (\fB\-\-\-\fP) се приказују уместо размере. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Зарезом раздвојен списак назива провера целовитости. Следеће ниске се +користе за познате врсте провера: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP и \fBSHA\-256\fP. +За непознате врсте провера, користи се \fBUnknown\-\fP\fIN\fP, где је \fIN\fP ИД +провере као децимални број (једна или две цифре). +.IP 8. 4 +Укупна величина попуњавања тока у датотеци +.RE +.PD +.PP +Колоне редова \fBтока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока (први ток је 1) +.IP 3. 4 +Број блокова у току +.IP 4. 4 +Померај почетка запакованог +.IP 5. 4 +Померај почетка незапаковане +.IP 6. 4 +Величина запакованог (не укључује попуну тока) +.IP 7. 4 +Величина незапаковане +.IP 8. 4 +Размера паковања +.IP 9. 4 +Назив провере целовитости +.IP 10. 4 +Величина попуне тока +.RE +.PD +.PP +Колоне редова \fBблока\fP: +.PD 0 +.RS +.IP 2. 4 +Број тока који садржи овај блок +.IP 3. 4 +Број блока релативан на почетак тока (први блок је 1) +.IP 4. 4 +Број блока релативан на почетак датотеке +.IP 5. 4 +Померај почетка запакованог односан на почетак датотеке +.IP 6. 4 +Померај почетка незапаковане односан на почетак датотеке +.IP 7. 4 +Укупна запакована величина блока (заједно са заглављима) +.IP 8. 4 +Величина незапаковане +.IP 9. 4 +Размера паковања +.IP 10. 4 +Назив провере целовитости +.RE +.PD +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у редовима +\fBблока\fP. Они се не приказују са једним \fB\-\-verbose\fP, јер добијање ове +информације захтева много тражења и стога може бити споро: +.PD 0 +.RS +.IP 11. 4 +Вредност провере целовитости у хексадецималном облику +.IP 12. 4 +Величина заглавља блока +.IP 13. 4 +Заставице блока: \fBc\fP указује да је величина запакованог присутна, а \fBu\fP +указује да је величина нераспакованог присутна. Ако заставица није +постављена, цртица (\fB\-\fP) се приказује уместо да се настави са поправком +дужине ниске. У будућности нове заставице могу бити додате на крај ниске. +.IP 14. 4 +Величина стварних запакованих података у блоку (ово искључује заглавље +блока, попуњавање блока и поља провере) +.IP 15. 4 +Количина меморије (у бајтовима) потребна за распакивање овог блока са овим +\fBxz\fP издањем +.IP 16. 4 +Ланац филтера. Знајте да већина опција коришћених за време запакивања не +може бити познато, јер се само опције које су потребне за распакивање чувају +у \fB.xz\fP заглављима. +.RE +.PD +.PP +Колоне редова \fBсажетка\fP: +.PD 0 +.RS +.IP 2. 4 +Количина меморије (у бајтовима) потребна за распакивање ове датотеке са овим +\fBxz\fP издањем +.IP 3. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Колоне редова \fBукупности\fP: +.PD 0 +.RS +.IP 2. 4 +Број токова +.IP 3. 4 +Број блокова +.IP 4. 4 +Величина запакованог +.IP 5. 4 +Величина незапаковане +.IP 6. 4 +Просечан степен запакивања +.IP 7. 4 +Списак зарезом раздвојених назива провере целовитости која су била присутна +у датотекама +.IP 8. 4 +Величина попуњавања тока +.IP 9. 4 +Број датотека. Ту се држи поредак ранијих колона исто као у редовима +\fBдатотеке\fP. +.PD +.RE +.PP +Ако је \fB\-\-verbose\fP наведено два пута, додатне колоне су укључене у реду +\fBtotals\fP: +.PD 0 +.RS +.IP 10. 4 +Највећа количина меморије (у бајтима) потребна за распакивање датотеке са +овим \fBxz\fP издањем +.IP 11. 4 +\fByes\fP или \fBno\fP указује да ли сва заглавља блока имају и величину +запакованог и величину незапакованог сачуване у њима +.PP +\fIОд\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Потребно је најмање \fBxz\fP издање за распакивање датотеке +.RE +.PD +.PP +Будућа издања могу додати нове врсте реда и нове колоне се могу додати +постојећим врстама реда, али постојеће колоне се неће променити. +. +.SS "Помоћ филтера" +\fBxz \-\-robot \-\-filters\-help\fP исписује подржане филтере у следећем формату: +.PP +\fIфилтер\fP\fB:\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>,\fP\fIопција\fP\fB=<\fP\fIвредност\fP\fB>\fP... +.TP +\fIфилтер\fP +Назив филтера +.TP +\fIопција\fP +Назив филтера специфичне опције +.TP +\fIвредност\fP +Опсези бројевних \fIвредности\fP се јављају као +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. \fIВредност\fP ниске избора се приказују +унутар \fB< >\fP и раздвојене су знаком \fB|\fP. +.PP +Сваки филтер се исписује на свом сопственом реду. +. +.SS "Информације о ограничењу меморије" +\fBxz \-\-robot \-\-info\-memory\fP исписује један ред са више колона раздвојених +табулатором: +.IP 1. 4 +Укупна количина физичке меморије (RAM) у бајтима. +.IP 2. 4 +Ограничење коришћења меморије за запакивање у бајтима +(\fB\-\-memlimit\-compress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 3. 4 +Ограничење коришћења меморије за распакивање у бајтима +(\fB\-\-memlimit\-decompress\fP). Специјална вредност \fB0\fP означава основно +подешавање које је за режим једне нити исто као без ограничења. +.IP 4. 4 +Од \fBxz\fP 5.3.4alpha: Коришћење меморије за распакивање са више нити у +бајтима (\fB\-\-memlimit\-mt\-decompress\fP). Ово никада није нула јер систему +специфична основна вредност приказана у колони 5 се користи ако ограничење +није изричито наведено. Такође никада није веће од вредности у колони 3 чак +и ако је наведена већа вредност са \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Од \fBxz\fP 5.3.4alpha: Систему специфично основно ограничење коришћења +меморије које се користи за ограничавање броја нити приликом запакивања са +аутоматским бројем нити (\fB\-\-threads=0\fP) и без наведеног ограничења +коришћења меморије (\fB\-\-memlimit\-compress\fP). Ово се такође користи као +основна вредност за \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Од \fBxz\fP 5.3.4alpha: Број доступних нити обрађивача. +.PP +У будуће, излаз \fBxz \-\-robot \-\-info\-memory\fP може имати више колона, али +никада више од једног реда. +. +.SS Издање +\fBxz \-\-robot \-\-version\fP исписује број издања за \fBxz\fP и „liblzma“ у следећем +формату: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Главно издање. +.TP +\fIYYY\fP +Споредно издање. Парни бројеви су стабилна а непарни су алфа или бета +издања. +.TP +\fIZZZ\fP +Ниво закрпе за стабилна издања или само бројач за развојна издања. +.TP +\fIS\fP +Стабилност. 0 је алфа, 1 је бета, а 2 је стабилно. \fIS\fP треба увек да буде +2 када је \fIYYY\fP парно. +.PP +\fIXYYYZZZS\fP су исти у оба реда ако су \fBxz\fP и „liblzma“ из истог издања XZ +Utils\-а. +.PP +Примери: 4.999.9beta је \fB49990091\fP и 5.0.0 је \fB50000002\fP. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све је у реду. +.TP +\fB1\fP +Дошло је до грешке. +.TP +\fB2\fP +Десило се нешто вредно упозорења, али није дошло до стварних грешака. +.PP +Обавештења (без упозорења или грешака) исписано на стандардној грешци не +утичу на стање излаза. +. +.SH ОКРУЖЕЊЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обрађује размаком одвојени списак опција из променљивих окружења +\fBXZ_DEFAULTS\fP и \fBXZ_OPT\fP, тим редом, пре обраде опција са линије наредби. +Знајте да се обрађују само опције из променљивих окружења; све што нису +опције се тихо занемарује. Обрада се ради са \fBgetopt_long\fP(3) која се +користи такође за аргументе линије наредби. +.PP +\fBУпозорење:\fP Постављањем ових променљивих окружења, ефективно мењате +програме и скрипте које покреће \fBxz\fP. У већини случајева је безбедно +поставити ограничење коришћења, број нити и опција паковања путем +променљивих окружења. Међутим, неке опције могу да уруше скрипте. +Очигледан пример је \fB\-\-help\fP која чини да \fBxz\fP прикаже текст помоћи уместо +да запакује или распакује датотеку. Суптилнији примери су \fB\-\-quiet\fP и +\fB\-\-verbose\fP. У многим случајевима добро функционише омогућавање указивача +напредовања коришћењем \fB\-\-verbose\fP, али у неким ситуацијама додатне поруке +стварају проблеме. Ниво опширности такође утиче на понашање \fB\-\-list\fP +.TP +\fBXZ_DEFAULTS\fP +Кориснику специфичне или свеопште системске основне опције. Обично је ово +постављено у скрипти покретања конзоле за укључивање \fBxz\fP ограничавача +коришћења меморије по основи или за постављање основног броја нити. +Искључивање скрипти покретања конзоле и сличних специјалних случајева, +скрипте не смеју никада да поставе или пониште \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Ово је за прослеђивање опција ка \fBxz\fP када није могуће поставити опције +директно на \fBxz\fP линији наредби. Ово је случај када је \fBxz\fP покренут +скриптом или алатом, на пример, са Гну \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипте могу да користе \fBXZ_OPT\fP, на пример, за постављање основних опција +запакивања специфичних скрипти. Још увек се препоручује омогућавање +корисницима да пишу преко \fBXZ_OPT\fP ако је то разумљиво. На пример, у +\fBsh\fP(1) скриптама неко може користити нешто као ово: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "LZMA UTILS САДЕЈСТВЕНОСТ" +Синтакса линије наредби \fBxz\fP је практично супер скуп \fBlzma\fP, \fBunlzma\fP и +\fBlzcat\fP као што се налази у LZMA Utils 4.32.x. У већини случајева, могуће +је заменити LZMA Utils са XZ Utils без оштећења постојећих скрипти. Има +неких несагласности такође, које понекад могу довести до проблема. +. +.SS "Нивои предподешавања запакивања" +Набрајање предподешености нивоа запакивања није исто у \fBxz\fP и LZMA Utils. +Најважнија разлика је у томе како се величине речника мапирају у различитим +предподешеностима. Величина речника је отприлике иста као и коришћење +меморије распакивача. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils +\-0;256 KiB;Н/Д +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Разлике величине речника делују такође на коришћење меморије запакивање, али +постоје још неке разлике између LZMA Utils и XZ Utils, што чини разлике још +већим: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Ниво;xz;LZMA Utils 4.32.x +\-0;3 MiB;Н/Д +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Основни ниво предподешености у LZMA Utils је \fB\-7\fP док у XZ Utils је \fB\-6\fP, +тако да оба користе 8 MiB речник по основи. +. +.SS "Токовне наспрам не\-токовних „.lzma“ датотеке" +Незапакована величина датотеке се може чувати у \fB.lzma\fP заглављу. LZMA +Utils то ради приликом запакивања обичних датотека. Алтернатива је да се +означи та незапакована величина као непозната и да се користи означавач +краја утовара да назначи где распакивач треба да стане. LZMA Utils користи +ову методу када незапакована величина није позната, што је случај, на +пример, у спојкама. +.PP +\fBxz\fP подржава распакивање \fB.lzma\fP датотека са или без означавача краја +утовара, али ће све \fB.lzma\fP датотеке направљене са \fBxz\fP користити +означавач краја утовара и означити незапаковану величину непознатом у +\&\fB.lzma\fP заглављу. Ово може бити проблем у неким неуобичајеним +ситуацијама. На пример, \fB.lzma\fP распакивач у угнежденом уређају може +радити само са датотекама које имају незапаковану величину. Ако наиђете на +тај проблем, треба да користите LZMA Utils или LZMA SDK да направите +\&\fB.lzma\fP датотеке са познатом незапакованом величином. +. +.SS "Неподржане „.lzma“ датотеке" +Формат \fB.lzma\fP омогућава \fIlc\fP вредности све до 8, а \fIlp\fP вредности све до +4. LZMA Utils може да распакује датотеке са било којим \fIlc\fP и \fIlp\fP, али +увек прави датотеке са \fBlc=3\fP и \fBlp=0\fP. Прављење датотека са другим \fIlc\fP +и \fIlp\fP је мгуће са \fBxz\fP и са LZMA SDK. +.PP +Примена филтера LZMA1 у „liblzma“ захтева да збир \fIlc\fP и \fIlp\fP не сме да +премаши 4. Стога, \fB.lzma\fP датотеке, које премаше ово ограничење, не могу +да се распакују са \fBxz\fP. +.PP +LZMA Utils прави само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP (степен 2) али прихвата датотеке са било којом величином речника. +„liblzma“ прихвата само \fB.lzma\fP датотеке које имају величину речника од +2^\fIn\fP или 2^\fIn\fP + 2^(\fIn\fP\-1). Ово је да се смање лажни позитивни +резултати приликом откривања \fB.lzma\fP датотека. +.PP +Ова ограничења не би требало да буду проблем у пракси, јер су практично све +\&\fB.lzma\fP датотеке запаковане са поставкама које ће „liblzma“ прихватити. +. +.SS "Пратеће смеће" +Приликом распакивања, LZMA Utils тихо занемарује све после првог \fB.lzma\fP +тока. У већини прилика, ово је грешка. Ово такође значи да LZMA Utils не +подржава распакивање надовезаних \fB.lzma\fP датотека. +.PP +Ако су остали подаци након првог \fB.lzma\fP тока, \fBxz\fP сматра да је датотека +оштећена осим ако је коришћено \fB\-\-single\-stream\fP. Ово може прекинути +нејасне скрипте које су претпоставиле да је пратеће смеће занемарено. +. +.SH НАПОМЕНЕ +. +.SS "Излаз запакованог може бити променљив" +Тачан запаковани излаз добијен из исте незапаковане улазне датотеке може се +разликовати између XZ Utils издања чак и ако су опције запакивања +истоветне. Ово је због тога што шифрер може бити побољшан (брже и боље +запакивање) а да не утиче на формат датотеке. Излаз се може разликовати +између различитих изградњи истог XZ Utils издања, ако су коришћене другачије +опције изградње. +.PP +Ово изнад значи да када се \fB\-\-rsyncable\fP једном примени, резултирајућа +датотека неће неопходно бити r\-ускладива осим ако и стара и нова датотека +нису запаковане истим xz издањем. Овај проблем може бити поправљен ако је +део примене шифрера замрзнут да држи r\-ускладив излаз стабилним кроз xz +издања. +. +.SS "Угнеждени „.xz“ распакивачи" +Примена угнежденог \fB.xz\fP распакивача као што је XZ Embedded неопходно не +подржава датотеке направљене врстама \fIпровере\fP целовитости осим \fBnone\fP и +\fBcrc32\fP. Како је основно \fB\-\-check=crc64\fP, морате да користите +\fB\-\-check=none\fP или \fB\-\-check=crc32\fP када правите датотеке за угнеждене +системе. +.PP +Споља уграђени системи, сви распакивачи \fB.xz\fP формата подржавају све врсте +\fIпровере\fP, или барем могу да распакују датотеку без испитивања провере +целовитости ако одређена \fIпровера\fP није подржана. +.PP +XZ Embedded подржава BCJ филтере, али само са основним померајем почетка. +. +.SH ПРИМЕРИ +. +.SS Основно +Запакује датотеку \fIfoo\fP у \fIfoo.xz\fP користећи основни ниво запакивања +(\fB\-6\fP), и уклања \fIfoo\fP ако је запакивање успешно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Распакује \fIbar.xz\fP у \fIbar\fP и не уклања \fIbar.xz\fP чак и када је распакивање +успешно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Ствара \fIbaz.tar.xz\fP са предподешавањем \fB\-4e\fP (\fB\-4 \-\-extreme\fP), које је +спорије него основно \fB\-6\fP, али захтева мање меморије за запакивање и +распакивање (48\ MiB и 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Мешавина сажетих и несажетих датотека се може распаковати на стандардни +излаз једном наредбом: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралелно запакивање више датотека" +На GNU и *BSD, \fBfind\fP(1) и \fBxargs\fP(1) се могу користити за паралелно +запакивање више датотека: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Опција \fB\-P\fP за \fBxargs\fP(1) поставља број паралелних \fBxz\fP процеса. Најбоља +вредност за опцију \fB\-n\fP зависи од тога колико датотека има за запакивање. +Ако има само неколико датотека, вредност би вероватно требала да буде 1; са +више хиљада датотека, 100 или чак и више може бити одговарајуће за смањење +броја \fBxz\fP процеса које би \fBxargs\fP(1) евентуално направио. +.PP +Опција \fB\-T1\fP за \fBxz\fP је ту да га примора на једнонитни режим, јер се +\fBxargs\fP(1) користи за контролу количине паралелизације. +. +.SS "Режим робота" +Израчунава колико је бајтова укупно сачувано након запакивања више датотека: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипта може желети да зна да користи најновији \fBxz\fP. Следећа скрипта +\fBsh\fP(1) проверава да ли је број издања \fBxz\fP алата барем 5.0.0. Ова +метода је сагласна са старим бета издањима која не подржавају \fB\-\-robot\fP +опцију: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Ваш „xz“ је превише стар." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Поставља ограничење коришћења меморије за распакивање коришћењем \fBXZ_OPT\fP, +али ако је ограничење већ постављено, не повећава је: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Произвољни ланци филтера запакивача" +Најједноставнија употреба за произвољне ланце филтера прилагођава LZMA2 +предподешеност. Ово може бити корисно, јер предподешености покривају само +подскуп потенцијално корисних комбинација поставки запакивања. +.PP +Колоне ЗапакЦПЈ у табелама из описа опција \fB\-0\fP ... \fB\-9\fP и \fB\-\-extreme\fP су +корисне приликом прилагођавања LZMA2 предподешености. Овде су значајни +делови прикупљени из те две табеле: +.RS +.PP +.TS +tab(;); +c c +n n. +Преподешеност;ЗапакЦПЈ +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Ако знате да датотека захтева нешто велики речник (на пример, 32 \ MiB) за +добро запакивање, али желите да је запакујете брже него што би то \fBxz \-8\fP +урадио, предподешеност са ниском вредношћу ЗапакМем (на пример, 1) може се +изменити да користи већи речник: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Са одређеним датотекама, горња наредба може бити бржа од \fBxz \-6\fP а +запакивање значајно боље. Међутим, мора бити наглашено да само неке +датотеке имају корист од великог речника док одржавају вредност ЗапакЦПЈ +ниском. Најочигледнија ситуација, у којој велики речник може доста помоћи, +јесте архива која садржи врло сличне датотеке где свака има најмање неколико +мегабајта. Величина речника треба да буде значајно већа од сваке засебне +датотеке да би се омогућило да LZMA2 има потпуну предност од сличности +између узастопних датотека. +.PP +Ако је веома велико коришћење меморије запакивача и распакивача у реду, а +датотека која се запакује је барем неколико стотина мегабајта, може бити +корисно користити још већи речник од 64 MiB који ће \fBxz \-9\fP користити: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Коришћење \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) као у горњем примеру може бити +корисно да се виде захтеви за меморијом запакивача и распакивача. Знајте да +је коришћење речника већег од величине незапаковане датотеке губитак +меморије, тако да горња наредба није корисна за мале датотеке. +.PP +Понекад време запакивања није важно, али коришћење меморије распакивача +треба да се одржава ниским, на пример, да би се учинило могућим распакивање +датотеке на угнежденом систему, Следеће наредбе користе \fB\-6e\fP (\fB\-6 \-\-extreme\fP) као основу и постављају речник на само 64\ KiB. Резултујућа +датотека се може распаковати са XZ Embedded (због тога је ту +\fB\-\-check=crc32\fP) користећи око 100\ KiB меморије. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Ако желите да исцедите што је више могуће бајтова, дотеривање броја битова +контекста литерала (\fIlc\fP) и броја битова положаја (\fIpb\fP) може понекад да +помогне. Дотеривање броја битова положаја литерала (\fIlp\fP) може такође да +помогне, али обично \fIlc\fP и \fIpb\fP су важнији. На пример, архива извора кода +садржи углавном US\-ASCII текст, тако да нешто као следеће може да да +незнатно (око 0.1\ %) мању датотеку него \fBxz \-6e\fP (пробајте такође без +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Коришћење још једног филтера заједно са LZMA2 може побољшати запакивање са +одређеним врстама датотека. На пример, за запакивање x86\-32 или x86\-64 +дељене библиотеке коришћењем x86 BCJ филтера: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Знајте да поредак опција филтера има значај. Ако је \fB\-\-x86\fP наведено након +\fB\-\-lzma2\fP, \fBxz\fP ће дати грешку, јер не сме бити никаквог филтера после +LZMA2, и такође зато што се x86 BCJ филтер не може користити као последњи +филтер у ланцу. +.PP +Delta филтер заједно са LZMA2 може дати добре резултате са битмап сликама. +Требало би обично да надјача PNG, који има нешто више напредних филтера него +једноставни делта али користи Deflate за стварно запакивање. +.PP +Слика треба да се сачува у незапакованом формату, на пример, као +незапакована TIFF. Параметар растојања Delta филтера је постављен да се +подудари са бројем бајтова по пикселу у слици. На пример, RGB битмапа од 24 +бита захтева \fBdist=3\fP, а такође је добро проследити \fBpb=0\fP за LZMA2 да се +прилагоди поравнање од три бајта: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Ако је више слика стављено у једну архиву (на пример, \fB.tar\fP), Delta филтер +ће радити на томе такође све док све слике не буду имале исти број бајтова +по пикселу. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sr/man1/xzcmp.1 b/miniconda3/share/man/sr/man1/xzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..6c9ef9938e11d68a13510dffa145304439b97e6c --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzcmp.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzcmp, xzdiff, lzcmp, lzdiff – упоређује запаковане датотеке +. +.SH САЖЕТАК +\fBxzcmp\fP [\fIопција...\fP] \fIдатотека1\fP [\fIдатотека2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzcmp\fP и \fBxzdiff\fP пореди незапаковане садржаје две датотеке. +Незапаковани подаци и опције се прослеђују ка \fBcmp\fP(1) или \fBdiff\fP(1) осим +ако није наведено \fB\-\-help\fP or \fB\-\-version\fP. +.PP +Ако су наведене и \fIдатотека1\fP и \fIдатотека2\fP, оне могу бити незапаковане +датотеке или датотеке у форматима које \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) могу да распакују. Захтеване наредбе +распакивања се одређују из суфикса назива \fIдатотеке1\fP и \fIдатотеке2\fP. +Датотека са непознатим суфиксом се претпоставља да је незапакована или да је +у формату који \fBxz\fP(1) може да распакује. +.PP +Ако је достављен само један назив датотеке, \fIдатотека1\fP мора да има суфикс +подржаних формата запакивања а назив за \fIдатотеку2\fP се подразумева да је +\fIдатотека1\fP са уклоњеним суфиксом формата запакивања. +.PP +Наредбе \fBlzcmp\fP и \fBlzdiff\fP се достављају зарад назадне сагласности са LZMA +Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +Ако дође до грешке распакивања,излазно стање је \fB2\fP. У супротном излазно +стање од \fBcmp\fP(1) или \fBdiff\fP(1) се користи. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzdec.1 b/miniconda3/share/man/sr/man1/xzdec.1 new file mode 100644 index 0000000000000000000000000000000000000000..c9bbe26f45da0a1add18e35e5a13105c4155b677 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzdec.1 @@ -0,0 +1,81 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 08.04.2024. Tukaani "XZ Utils" +.SH НАЗИВ +xzdec, lzmadec – Мали „.xz“ и „.lzma“ распакивачи +.SH САЖЕТАК +\fBxzdec\fP [\fIопција...\fP] [\fIдатотека...\fP] +.br +\fBlzmadec\fP [\fIопција...\fP] [\fIдатотека...\fP] +.SH ОПИС +\fBxzdec\fP је алат само за распакивање заснован на „liblzma“ за \fB.xz\fP (и само +\&\fB.xz\fP) датотеке. \fBxzdec\fP је намењен да ради као тренутна замена за +\fBxz\fP(1) у најопштијим ситуацијама где је скрипта написана да користи \fBxz \-\-decompress \-\-stdout\fP (и по могућству још неколико других обично коришћених +опција) за распакивање \fB.xz\fP датотека. \fBlzmadec\fP је истоветна са \fBxzdec\fP +осим што \fBlzmadec\fP подржава \fB.lzma\fP датотеке уместо of \fB.xz\fP датотека. +.PP +За смањење величине извршне, \fBxzdec\fP не подржава више нити или +локализацију, и не чита опције из променљивих окружења \fBXZ_DEFAULTS\fP и +\fBXZ_OPT\fP. \fBxzdec\fP не подржава приказивање посредничких информација +напредовања: слање \fBSIGINFO\fP ка \fBxzdec\fP не ради ништа, али слање +\fBSIGUSR1\fP окончава процес уместо да прикаже информације о напредовању. +.SH ОПЦИЈЕ +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP подржава само распакивање. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP никада не прави или уклања +датотеке. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP увек пише распаковане +податке на стандардни излаз. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Навођењем овога једном не ради ништа јер \fBxzdec\fP никада не приказује +упозорења или обавештења. Наведите ово два пута да потиснете грешке. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Занемарено зарад \fBxz\fP(1) сагласности. \fBxzdec\fP никада не користи излазно +стање 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Приказује поруку помоћи и излази с успехом. +.TP +\fB\-V\fP, \fB\-\-version\fP +Приказује број издања за \fBxzdec\fP и „liblzma“. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +\fB0\fP +Све беше у реду. +.TP +\fB1\fP +Дошло је до грешке. +.PP +\fBxzdec\fP нема поруке упозорења као што има \fBxz\fP(1), стога \fBxzdec\fP не +користи излазно стање 2. +.SH НАПОМЕНЕ +Користите \fBxz\fP(1) уместо \fBxzdec\fP или \fBlzmadec\fP за обично свакодневно +коришћење. \fBxzdec\fP или \fBlzmadec\fP су замишљени само ситуације у којима је +важно имати мањи распакивач неко потпуно функционалан \fBxz\fP(1). +.PP +\fBxzdec\fP и \fBlzmadec\fP нису баш тако мали. Величина може бити још смањена +одбацивањем функција из „liblzma“ за време превођења, али то не треба обично +да се ради за извршне достављене у типичним не\-угнежденим дистрибуцијама +оперативног система. Ако вам треба стварно мали \fB.xz\fP распакивач, +размотрите коришћење XZ Embedded\-а. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/sr/man1/xzdiff.1 b/miniconda3/share/man/sr/man1/xzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..6c9ef9938e11d68a13510dffa145304439b97e6c --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzdiff.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzcmp, xzdiff, lzcmp, lzdiff – упоређује запаковане датотеке +. +.SH САЖЕТАК +\fBxzcmp\fP [\fIопција...\fP] \fIдатотека1\fP [\fIдатотека2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzcmp\fP и \fBxzdiff\fP пореди незапаковане садржаје две датотеке. +Незапаковани подаци и опције се прослеђују ка \fBcmp\fP(1) или \fBdiff\fP(1) осим +ако није наведено \fB\-\-help\fP or \fB\-\-version\fP. +.PP +Ако су наведене и \fIдатотека1\fP и \fIдатотека2\fP, оне могу бити незапаковане +датотеке или датотеке у форматима које \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) могу да распакују. Захтеване наредбе +распакивања се одређују из суфикса назива \fIдатотеке1\fP и \fIдатотеке2\fP. +Датотека са непознатим суфиксом се претпоставља да је незапакована или да је +у формату који \fBxz\fP(1) може да распакује. +.PP +Ако је достављен само један назив датотеке, \fIдатотека1\fP мора да има суфикс +подржаних формата запакивања а назив за \fIдатотеку2\fP се подразумева да је +\fIдатотека1\fP са уклоњеним суфиксом формата запакивања. +.PP +Наредбе \fBlzcmp\fP и \fBlzdiff\fP се достављају зарад назадне сагласности са LZMA +Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +Ако дође до грешке распакивања,излазно стање је \fB2\fP. У супротном излазно +стање од \fBcmp\fP(1) или \fBdiff\fP(1) се користи. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzegrep.1 b/miniconda3/share/man/sr/man1/xzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzegrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzfgrep.1 b/miniconda3/share/man/sr/man1/xzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzfgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzgrep.1 b/miniconda3/share/man/sr/man1/xzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..263fed9983f5d102ed2d439771a6732ae1b767b1 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzgrep – претражује могуће запаковане датотеке за шаблонима +. +.SH САЖЕТАК +\fBxzgrep\fP [\fIопција...\fP] [\fIсписак_шаблона\fP] [\fIдатотека...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРЕЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzgrep\fP призива \fBgrep\fP(1) на незапакованим садржајима датотека. Формати +\fIдатотека\fP се одређују из суфикса назива датотека. Било која \fIдатотека\fP +са суфиксом подржаним од стране \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) или \fBlz4\fP(1) биће распакована; све остале датотеке +се подразумевају да нису запаковане. +.PP +Ако \fIдатотеке\fP нису наведене или \fIдатотека\fP је \fB\-\fP тада се чита +стандардни улаз. Приликом читања са стандардног улаза, само датотеке +подржане са \fBxz\fP(1) се распакују. Друге датотеке се подразумева да су већ +у незапакованом облику. +.PP +Већина \fIопција\fP \fBgrep\fP(1) је подржана. Међутим, следеће опције нису +подржане: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIрадња\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIдатотека\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP је алијас за \fBxzgrep \-E\fP. \fBxzfgrep\fP је алијас за \fBxzgrep \-F\fP. +.PP +Наредбе \fBlzgrep\fP, \fBlzegrep\fP и \fBlzfgrep\fP се достављају зарад назадне +сагласности са LZMA Utils. Застареле су и биће уклоњене у будућем издању. +. +.SH "СТАЊЕ ИЗЛАЗА" +.TP +0 +Најмање једно поклапање је пронађено из барем једне од улазних датотека. +Није било грешака. +.TP +1 +Никаква поклапања нису пронађена ни из једне од улазних датотека. Није дошло +до грешака. +.TP +>1 +Дошло је до једне или више грешака. Није познато да ли су поклапања нађена. +. +.SH ОКРУЖЕЊЕ +.TP +\fBGREP\fP +Ако је \fBGREP\fP постављено на не\-празну вредност, користи се уместо \fBgrep\fP, +\fBgrep \-E\fP или \fBgrep \-F\fP. +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzless.1 b/miniconda3/share/man/sr/man1/xzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..af9fd3a0e92153e5cc2db427e2cbf48088bbb682 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzless.1 @@ -0,0 +1,47 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzless, lzless – приказује „xz“ или „lzma“ запаковане (текстуалне) датотеке +.SH САЖЕТАК +\fBxzless\fP [\fIдатотека\fP...] +.br +\fBlzless\fP [\fIдатотека\fP...] (ЗАСТАРЕЛО) +.SH ОПИС +\fBxzless\fP је филтер који приказује текст из запакованих датотека у +терминалу. Датотеке које подржава \fBxz\fP(1) се распакују; остале датотеке се +већ подразумева да су у незапакованом облику. Ако није дата ни једна +\fIдатотека\fP, \fBxzless\fP чита са стандардног улаза. +.PP +\fBxzless\fP користи \fBless\fP(1) да представи свој излаз. За разлику од +\fBxzmore\fP, његов избор страничара се не може изменити постављањем променљиве +окружења. Наредбе се заснивају и на \fBmore\fP(1) и на \fBvi\fP(1) и дозвољавају +померање и претрагу назад и напред. Видите упутство \fBless\fP(1) за више +информација. +.PP +Наредба \fBlzless\fP се доставља зарад назадне сагласности са LZMA +Utils. Застарела је и биће уклоњена у будућем издању. +.SH ОКРУЖЕЊЕ +.TP +\fBLESSMETACHARS\fP +Списак знакова нарочитих за шкољку. Поставите са \fBxzless\fP осим ако већ +није постављено у окружењу. +.TP +\fBLESSOPEN\fP +Поставља да линија наредби призове \fBxz\fP(1) распакивач за предобраду улазних +датотека на \fBless\fP(1). +.SH "ВИДИТЕ ТАКОЂЕ" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/sr/man1/xzmore.1 b/miniconda3/share/man/sr/man1/xzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..23df9c6cf0402b3ebdac9949ee6d40bcb9db6045 --- /dev/null +++ b/miniconda3/share/man/sr/man1/xzmore.1 @@ -0,0 +1,49 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Serbian translation of xz-man. +.\" Мирослав Николић , 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 06.03.2025. Tukaani "XZ Utils" +.SH НАЗИВ +xzmore, lzmore – приказује „xz“ или „lzma“ запаковане (текстуалне) датотеке +. +.SH САЖЕТАК +\fBxzmore\fP [\fIдатотека\fP...] +.br +\fBlzmore\fP [\fIдатотека\fP...] (ЗАСТАРЕЛО) +. +.SH ОПИС +\fBxzmore\fP приказује текст из запакованих датотека у терминалу користећи +\fBmore\fP(1). Датотеке које подржава \fBxz\fP(1) се распакују; остале датотеке +се подразумева да су већ у незапакованом облику. Ако није дата ни једна +\fIдатотека\fP, \fBxzmore\fP чита са стандардног улаза. Видите упутство +\fBmore\fP(1) за више информација. +.PP +Знајте да клизање уназад можда неће бити могуће у зависности од примене +\fBmore\fP(1). Ово је зато што \fBxzmore\fP користи спојку за прослеђивање +распакованих података ка \fBmore\fP(1). \fBxzless\fP(1) користи \fBless\fP(1) које +обезбеђује напреднијим функцијама. +.PP +Наредба \fBlzmore\fP се доставља зарад назадне сагласности са LZMA +Utils. Застарела је и биће уклоњена у будућем издању. +. +.SH ОКРУЖЕЊЕ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Ако је \fBPAGER\fP постављено, његова вредност се користи као страничар уместо +\fBmore\fP(1). +. +.SH "ВИДИТЕ ТАКОЂЕ" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzcat.1 b/miniconda3/share/man/sv/man1/lzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzcat.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/lzcmp.1 b/miniconda3/share/man/sv/man1/lzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..2d1516dcb59720f083abf68f8101c5de6fb19a89 --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzcmp.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzcmp, xzdiff, lzcmp, lzdiff — jämför komprimerade filer +. +.SH SYNOPSIS +\fBxzcmp\fP [\fIflagga…\fP] \fIfil1\fP [\fIfil2\fP] +.br +\fBxzdiff\fP \&… +.br +\fBlzcmp\fP \&… (FÖRÅLDRAT) +.br +\fBlzdiff\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzcmp\fP och \fBxzdiff\fP jämför det okomprimerade innehållet i två +filer. Okomprimerad data skickas till \fBcmp\fP(1) eller \fBdiff\fP(1) såvida inte +\fB\-\-help\fP eller \fB\-\-version\fP anges. +.PP +Om både \fIfil1\fP och \fIfil2\fP anges kan de vara okomprimerade filer eller +filer i format som \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) +eller \fBlz4\fP(1) kan dekomprimera. De nödvändiga dekomprimeringskommandona +avgörs från filnamnsändelsen på \fIfil1\fP och \fIfil2\fP. En fil med en okänd +ändelse antas antingen vara okomprimerad eller i ett format som \fBxz\fP(1) kan +dekomprimera. +.PP +Om endast ett filnamn anges måste \fIfil1\fP ha en ändelse med ett av de stödda +komprimeringsformaten och namnet på \fIfil2\fP antas vara \fIfil1\fP med +komprimeringsformatsändelsen borttagen. +.PP +Kommandona \fBlzcmp\fP och \fBlzdiff\fP finns för bakåtkompatibilitet med LZMA +Utils. De rekommenderas inte och kommer tas bort i en framtida version. +. +.SH SLUTSTATUS +Om ett dekomprimeringsfel uppstår är slutstatus \fB2\fP. Annars används +slutstatusen från \fBcmp\fP(1) respektive \fBdiff\fP(1). +. +.SH "SE ÄVEN" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzdiff.1 b/miniconda3/share/man/sv/man1/lzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..2d1516dcb59720f083abf68f8101c5de6fb19a89 --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzdiff.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzcmp, xzdiff, lzcmp, lzdiff — jämför komprimerade filer +. +.SH SYNOPSIS +\fBxzcmp\fP [\fIflagga…\fP] \fIfil1\fP [\fIfil2\fP] +.br +\fBxzdiff\fP \&… +.br +\fBlzcmp\fP \&… (FÖRÅLDRAT) +.br +\fBlzdiff\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzcmp\fP och \fBxzdiff\fP jämför det okomprimerade innehållet i två +filer. Okomprimerad data skickas till \fBcmp\fP(1) eller \fBdiff\fP(1) såvida inte +\fB\-\-help\fP eller \fB\-\-version\fP anges. +.PP +Om både \fIfil1\fP och \fIfil2\fP anges kan de vara okomprimerade filer eller +filer i format som \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) +eller \fBlz4\fP(1) kan dekomprimera. De nödvändiga dekomprimeringskommandona +avgörs från filnamnsändelsen på \fIfil1\fP och \fIfil2\fP. En fil med en okänd +ändelse antas antingen vara okomprimerad eller i ett format som \fBxz\fP(1) kan +dekomprimera. +.PP +Om endast ett filnamn anges måste \fIfil1\fP ha en ändelse med ett av de stödda +komprimeringsformaten och namnet på \fIfil2\fP antas vara \fIfil1\fP med +komprimeringsformatsändelsen borttagen. +.PP +Kommandona \fBlzcmp\fP och \fBlzdiff\fP finns för bakåtkompatibilitet med LZMA +Utils. De rekommenderas inte och kommer tas bort i en framtida version. +. +.SH SLUTSTATUS +Om ett dekomprimeringsfel uppstår är slutstatus \fB2\fP. Annars används +slutstatusen från \fBcmp\fP(1) respektive \fBdiff\fP(1). +. +.SH "SE ÄVEN" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzegrep.1 b/miniconda3/share/man/sv/man1/lzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzegrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzfgrep.1 b/miniconda3/share/man/sv/man1/lzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzfgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzgrep.1 b/miniconda3/share/man/sv/man1/lzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzless.1 b/miniconda3/share/man/sv/man1/lzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..52b702820a9af7788772d2a30896263902aa1042 --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzless.1 @@ -0,0 +1,47 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzless, lzless — visa xz\- eller lzma\-komprimerade (text)filer +.SH SYNOPSIS +\fBxzless\fP [\fIfil\fP…] +.br +\fBlzless\fP [\fIfil\fP…] (FÖRÅLDRAT) +.SH BESKRIVNING +\fBxzless\fP är ett filter som visar text från komprimerade filer i en +terminal. Filer som stödjs av \fBxz\fP(1) dekomprimeras; andra filer antas +redan vara i okomprimerad form. Om inga \fIfiler\fP ges läser \fBxzless\fP från +standard in. +.PP +\fBxzless\fP använder \fBless\fP(1) för att visa sin utdata. Till skillnad mot +\fBxzmore\fP kan inte dess val av bläddrare ändras genom att sätta en +miljövariabel. Kommandon är baserade på både \fBmore\fP(1) och \fBvi\fP(1) och +tillåter förflytting fram och tillbaka samt sökning. Se manualen \fBless\fP(1) +för mer information. +.PP +Kommandot som heter \fBlzless\fP finns för bakåtkompatibilitet med LZMA +Utils. Det rekommenderas inte och kommer tas bort i en framtida version. +.SH MILJÖ +.TP +\fBLESSMETACHARS\fP +En lista på tecken som är speciella för skalet. Sätts av \fBxzless\fP om den +inte redan är satt i miljön. +.TP +\fBLESSOPEN\fP +Satt till en kommandorad för att köra dekomprimeraren \fBxz\fP(1) för +förbehandling av infiler till \fBless\fP(1). +.SH "SE ÄVEN" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzma.1 b/miniconda3/share/man/sv/man1/lzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzma.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/lzmadec.1 b/miniconda3/share/man/sv/man1/lzmadec.1 new file mode 100644 index 0000000000000000000000000000000000000000..63612b0c437ef25509d89f649853119c5e476786 --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzmadec.1 @@ -0,0 +1,87 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 2024\-04\-08 Tukaani "XZ Utils" +.SH NAMN +xzdec, lzmadec \- Små .xz\- och .lzma\-dekomprimerare +.SH SYNOPSIS +\fBxzdec\fP [\fIflagga…\fP] [\fIfil…\fP] +.br +\fBlzmadec\fP [\fIflagga…\fP] [\fIfil…\fP] +.SH BESKRIVNING +\fBxzdec\fP är ett liblzma\-baserat verktyg endast för dekomprimering för \fB.xz\fP +(och endast \fB.xz\fP) filer. \fBxzdec\fP är avsett att fungera som en drop +in\-ersättning för \fBxz\fP(1) i de vanligaste situationerna där ett skript har +skrivits för att använda \fBxz \-\-decompress \-\-stdout\fP (och möjligen några +andra vanliga flaggor) för att dekomprimera \fB.xz\fP\-filer. \fBlzmadec\fP är +identisk med \fBxzdec\fP förutom att \fBlzmadec\fP stödjer \fB.lzma\fP\-filer istället +för \fB.xz\fP\-filer. +.PP +För att reducera storleken på det körbara programmet stödjer inte \fBxzdec\fP +multitrådning eller lokalisering, och läser inte flaggor från +miljövariablerna \fBXZ_DEFAULTS\fP eller \fBXZ_OPT\fP. \fBxzdec\fP stödjer inte att +visa mellanliggande förloppsinformation: att skicka \fBSIGINFO\fP till \fBxzdec\fP +gör ingenting, med att skicka \fBSIGUSR1\fP avslutar processen istället för att +visa förloppsinformation. +.SH FLAGGOR +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP stödjer endast +dekomprimering. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP skapar aldrig eller tar +aldrig bort några filer. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP skriver alltid +dekomprimerad data till standard ut. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Att ange detta en gång gör inget eftersom \fBxzdec\fP aldrig visar några +varningar eller noteringar. Att ange detta två gånger utelämnar +felmeddelanden. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP använder aldrig +slutstatus 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande och avsluta. +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret på \fBxzdec\fP och liblzma. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt gick bra. +.TP +\fB1\fP +Ett fel uppstod. +.PP +\fBxzdec\fP har inte några varningsmeddelanden så som \fBxz\fP(1) har, och därför +används aldrig slutstatusen 2 av \fBxzdec\fP. +.SH NOTERINGAR +Använd \fBxz\fP(1) istället för \fBxzdec\fP eller \fBlzmadec\fP för dagligt +bruk. \fBxzdec\fP och \fBlzmadec\fP är bara avsedda för situationer där det är +viktigt att ha en mindre dekomprimerare än den fullständiga \fBxz\fP(1). +.PP +\fBxzdec\fP och \fBlzmadec\fP är egentligen inte riktigt så små. Storleken kan +reduceras ytterligare genom att ta bort funktioner från liblzma vid +kompileringstidpunkten, men det skall normalt inte göras för körbara program +som distribueras i en typisk, inte inbäddad, distribution av +operativsystem. Om man behöver en verkligt liten \fB.xz\fP\-dekomprimerare skall +man överväga XZ Embedded. +.SH "SE ÄVEN" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/sv/man1/lzmainfo.1 b/miniconda3/share/man/sv/man1/lzmainfo.1 new file mode 100644 index 0000000000000000000000000000000000000000..bb72d25c53e09a5429dbbb7ea89ccdb7e2b58e95 --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzmainfo.1 @@ -0,0 +1,42 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LZMAINFO 1 2013\-06\-30 Tukaani "XZ Utils" +.SH NAMN +lzmainfo — visa information lagrad i filhuvudet i .lzma +.SH SYNOPSIS +\fBlzmainfo\fP [\fB\-\-help\fP] [\fB\-\-version\fP] [\fIfil…\fP] +.SH BESKRIVNING +\fBlzmainfo\fP visar information som finns lagrad i filhuvudet i \fB.lzma\fP. Den +läser de första 13 byten från den angivna \fIfilen\fP, avkodar huvudet, och +skriver ut det till standard ut i mänskligt läsbart format. Om inga \fIfiler\fP +anges eller \fIfil\fP är \fB\-\fP, läses standard in. +.PP +Vanligen är den intressantaste informationen den okomprimerade storleken och +lexikonstorleken. Okomprimerad storlek kan endast visas om filen är i den +icke\-strömmande \fB.lzma\fP\-formatvarianten. Mängden minne som krävs för att +dekomprimera filen är några dussin kilobyte plus lexikonstorleken. +.PP +\fBlzmainfo\fP inkluderas i XZ Utils primärt för bakåtkompatibilitet med LZMA +Utils. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.SH FEL +\fBlzmainfo\fP använder \fBMB\fP medan det korrekta suffixet vore \fBMiB\fP (2²⁰ +byte). Detta är för att behålla utdata kompatibel med LZMA Utils. +.SH "SE ÄVEN" +\fBxz\fP(1) diff --git a/miniconda3/share/man/sv/man1/lzmore.1 b/miniconda3/share/man/sv/man1/lzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..b5bb68d4df784fe5c3fcbdf884e0667ee9fc791e --- /dev/null +++ b/miniconda3/share/man/sv/man1/lzmore.1 @@ -0,0 +1,48 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzmore, lzmore — visa xz\- eller lzma\-komprimerade (text)filer +. +.SH SYNOPSIS +\fBxzmore\fP [\fIfil\fP…] +.br +\fBlzmore\fP [\fIfil\fP…] (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzmore\fP visar text från komprimerade filer i en terminal med användning av +\fBmore\fP(1). Filer som stödjs av \fBxz\fP(1) dekomprimeras; andra filer antas +redan vara i okomprimerad form. Om inga \fIfiler\fP ges läser \fBxzmore\fP från +standard in. Se manualen för \fBmore\fP(1) för tangentbordskommandona. +.PP +Observera att det kanske inte är möjligt att rulla baklänges, beroende på +implementationen av \fBmore\fP(1). Detta är för att \fBxzmore\fP använder ett rör +för att skicka dekomprimerad data till \fBmore\fP(1). \fBxzless\fP(1) använder +\fBless\fP(1) vilken ger mer avancerade funktioner. +.PP +Kommandot \fBlzmore\fP finns för bakåtkompatibilitet med LZMA Utils. Det +rekommenderas inte och kommer tas bort i en framtida version. +. +.SH MILJÖ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Om \fBPAGER\fP är satt används dess värde som bläddrare istället för +\fBmore\fP(1). +. +.SH "SE ÄVEN" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/sv/man1/unlzma.1 b/miniconda3/share/man/sv/man1/unlzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/unlzma.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/unxz.1 b/miniconda3/share/man/sv/man1/unxz.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/unxz.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/xz.1 b/miniconda3/share/man/sv/man1/xz.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/xz.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/xzcat.1 b/miniconda3/share/man/sv/man1/xzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..1fb596e1ab328783990b87c362f7f7761d73548e --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzcat.1 @@ -0,0 +1,1954 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 2025\-03\-08 Tukaani "XZ Utils" +. +.SH NAMN +xz, unxz, xzcat, lzma, unlzma, lzcat — Komprimera eller dekomprimera .xz\- +och .lzma\-filer +. +.SH SYNOPSIS +\fBxz\fP [\fIflagga…\fP] [\fIfil…\fP] +. +.SH KOMMANDOALIAS +\fBunxz\fP är ekvivalent med \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP är ekvivalent med \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP är ekvivalent med \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP är ekvivalent med \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +När man skriver skript som behöver dekomprimera filer rekommenderas det att +altid använda namnet \fBxz\fP mäd lämpliga argument (\fBxz \-d\fP eller \fBxz \-dc\fP) +istället för namnen \fBunxz\fP och \fBxzcat\fP. +. +.SH BESKRIVNING +\fBxz\fP är ett datakomprimeringsverktyg för allmänt bruk med en +kommandoradssyntax som liknar \fBgzip\fP(1) och \fBbzip2\fP(1). Det egna +filformatet är formatet \fB.xz\fP, men det föråldrade formatet \fB.lzma\fP som +anändes av LZMA\-verktyg och råa komprimerade strömmar utan huvuden för +behållarformatet stödjs också. Dessutom stödjs dekomprimering av formatet +\&\fB.lz\fP som används av \fBlzip\fP. +.PP +\fBxz\fP komprimerar och dekomprimerar varje \fIfil\fP i enlighet med det valda +arbetsläget. Om inga \fIfiler\fP anges eller \fIfil\fP är \fB\-\fP läser \fBxz\fP från +standard in och skriver den behandade datan på standard ut. \fBxz\fP kommer +vägra (visa ett felmeddelande och hoppa över \fIfilen\fP) att skriva +komprimerad data direkt till standard ut om det är en terminal. På samma +sätt kommer \fBxz\fP vägra att läsa komprimerade data från standard in om det +är en terminal. +.PP +Om inte \fB\-\-stdout\fP anges skrivs andra \fIfiler\fP än \fB\-\fP till en ny fil vars +namn härleds från käll\fIfilens\fP namn: +.IP \(bu 3 +Vid kompringering läggs suffixet till på målfilsformatet (\fB.xz\fP eller +\&\fB.lzma\fP) på slutet av källfilnamnet för att få målfilnamnet. +.IP \(bu 3 +Vid dekomprimering tas suffixet \fB.xz\fP, \fB.lzma\fP eller \fB.lz\fP bort från +filnamnet för att få målfilnamnet. \fBxz\fP känner även igen suffixen \fB.txz\fP +och \fB.tlz\fP, och ersätter dem med suffixet \fB.tar\fP. +.PP +Om målfilen redan finns visas ett felmeddelande och \fIfilen\fP hoppas över. +.PP +Utom när den skriver till standard ut kommer \fBxz\fP visa en varning och hoppa +över \fIfilen\fP om något av följande inträffar: +.IP \(bu 3 +\fIFil\fP är inte en vanlig fil. Symboliska länkar följs inte, och därför anses +de inte vara vanliga filer. +.IP \(bu 3 +\fIFil\fP har mer än en hård länk. +.IP \(bu 3 +\fIFil\fP har biten setuid, setgid eller sticky satt. +.IP \(bu 3 +Arbetsläget är satt till att komprimera och \fIfilen\fP har redan ett suffix +enligt målfilformatet (\fB.xz\fP eller \fB.txz\fP vid komprimering till formatet +\&\fB.xz\fP, och \fB.lzma\fP eller \fB.tlz\fP vid komprimering till formatet \fB.lzma\fP). +.IP \(bu 3 +Arbetsläget är satt till att dekomprimera och \fIfilen\fP har inte ett suffix +enligt något av de stödda filformaten (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +eller \fB.lz\fP). +.PP +Efter att ha kunnat komprimera eller dekomprimera \fIfilen\fP kopierar \fBxz\fP +ägaren, gruppen, rättigheterna, åtkomsttiden och ändringstiden från +käll\fIfilen\fP till målfilen. Om kopieringen av grupp misslyckas ändras +rättigheterna så att målfilen inte blir åtkomlig för användare som inte har +rättigheter att komma åt käll\fIfilen\fP. \fBxz\fP stödjer inte kopiering av annan +metadata såsom åtkomststyrhingslistor eller utökade attribut ännu. +.PP +När målfilen har stängts framgångsrikt tas käll\fIfilen\fP bort såvida inte +\fB\-\-keep\fP angavs. Käll\fIfilen\fP tas aldrig bort om utdata skrevs till +standard ut eller om något fel inträffade. +.PP +Att skicka \fBSIGINFO\fP eller \fBSIGUSR1\fP till \fBxz\fP\-processen får den att +skriva ut förloppsinformation till standard fel. Detta är bara av begränsat +värde eftersom när standard fel går till en terminal så kommer användning av +\fB\-\-verbose\fP att skriva ut en automatiskt uppdaterande förloppsindikator. +. +.SS Minnesanvändning +\fBxz\fP:s minnesanvändning varierar från några få hundra kilobyte till flera +gigabyte beroende på komprimeringsinställningarna. Inställningen som +användes när en fil komprimerades avgör minnesbehovet hos +dekomprimeraren. Typiskt behöver dekomprimeraren 5\ % till 20\ % av +minnesbehovet som komprimeraren behöver när en fil skapas. Till exempel, att +dekomprimera en fil skapad med \fBxz \-9\fP kräver för närvarande 65\ MiB +minne. Ändå är det möjligt att ha \fB.xz\fP\-filer som behöver flera gigabyte +minne för att dekomprimeras. +.PP +Särskilt användare av äldre system kan finna möjligheten av väldigt stor +minnesanvändning störande. För att förhindra obehagliga överraskningar har +\fBxz\fP en inbyggd minnesanvändningsbegränsare, vilken är avaktiverad som +standard. Även om vissa operativsystem kan tillhandahålla möjligheter att +begränsa minnesanvändningen hos processer bedömdes det inte som flexibelt +nog att lita på det (till exempel, att använda \fBulimit\fP(1) för att begränsa +det virtuella minnet tenderar att hämma \fBmmap\fP(2). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Minnesanvändningsbegränsaren kan aktiveras med kommandoradsflaggan +\fB\-\-memlimit=\fP\fIgräns\fP. Ofta är det bekvämare att aktivera begränsaren som +standard genom att sätta miljövariabeln \fBXZ_DEFAULTS\fP, till exempel, +\fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Det är möjligt att sätta gränser separat +för komprimering och dekomprimering genom att använda +\fB\-\-memlimit\-compress=\fP\fIlimit\fP och \fB\-\-memlimit\-decompress=\fP\fIlimit\fP. Att +använda dessa två flaggor utanför \fBXZ_DEFAULTS\fP är sällan meningsfullt +eftersom en enskild körning av \fBxz\fP inte kan göra både komprimering och +dekomprimering och and \fB\-\-memlimit=\fP\fIgräns\fP (eller \fB\-M\fP \fIgräns\fP) är +kortare att skriva på kommandoraden. +.PP +Om den angivna minnesanvändningsgränsen överskrid vid dekomprimering kommer +\fBxz\fP visa ett fel och dekomprimeringen av filen misslyckas. Om gröensen +överskrids vid komprimering kommer \fBxz\fP försöka skala ner inställningen så +att gränsen inte längre överskrids (utom när \fB\-\-format=raw\fP eller +\fB\-\-no\-adjust\fP används). På detta sätt kommer åtgärden inte misslyckas om +inte gränsen är väldigt liten. Skalningen av inställningen görs i steg som +inte matchar de förinställda komprimeringsnivåerna, till exempel, om gränsen +endast är något mindre än den mängd som behövs till \fBxz \-9\fP kommer +inställningen bara skalas ner lite, inte hela vägen ner till \fBxz \-8\fP. +. +.SS "Konkatenering och utfyllnad av .xz\-filer" +Det är möjligt att konkatenera \fB.xz\fP\-filer som de är. \fBxz\fP kommer +dekomprimera sådana filer som om de vore en enda \fB.xz\fP\-fil. +.PP +Det är möjligt att infoga utfyllnad mellan de konkatenerade delarna eller +efter den sista delen. Utfyllnaden måste bestå av null\-bytear och storleken +på utfyllnaden måste vara en multipel av fyra byte. Detta kan vara +användbart, till exempel, om \fB.xz\fP\-filen lagras på ett medium som mäter +filstorlekar i 512\-byteblock. +.PP +Konkaternering och utfyllnad är inte tillåtet med \fB.lzma\fP\-filer eller råa +strömmar. +. +.SH FLAGGOR +. +.SS "Heltalssuffix och speciella värden" +På de flesta platser där ett heltalsargument förväntas stödjs ett frivilligt +suffix för att enkelt indikera stora heltal. Det får inte finnas något +mellanrumm mellan heltalet och suffixet. +.TP +\fBKiB\fP +Multiplicera heltalet med 1 024 (2¹⁰). \fBKi\fP, \fBk\fP, \fBkB\fP, \fBK\fP och \fBKB\fP är +tillåtna som synomymer till \fBKiB\fP. +.TP +\fBMiB\fP +Multiplicera heltalet med 1 048 576 (2²⁰). \fBMi\fP, \fBm\fP, \fBM\fP och \fBMB\fP är +tillåtna som synomymer till \fBMiB\fP. +.TP +\fBGiB\fP +Multiplicera heltalet med 1 073 741 824 (2³⁰). \fBGi\fP, \fBg\fP, \fBG\fP och \fBGB\fP +är tillåtna som synonymer till \fBGiB\fP. +.PP +Specialvärdet \fBmax\fP kan användas för att indikera det maximala heltalet som +stödjs av flaggan. +. +.SS Arbetsläge +Om flera arbetslägesflaggor ges gäller den sista. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Komprimera. Detta är standardarbetsläget när ingen arbetslägesflagga anges +och inget annat arbetsläge impliceras från kommandonamnet (till exempel +implicerar \fBunxz\fP \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Efter lyckad komprimering källfilen bort såvida man inte skriver till +standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Dekomprimera. Efter lyckad dekomprimering tas källfilen bort såvida man inte +skriver till standard ut eller \fB\-\-keep\fP angavs. +.TP +\fB\-t\fP, \fB\-\-test\fP +Testa integriteten hos komprimerade \fIfiler\fP. Denna flagga är ekvivalent med +\fB\-\-decompress \-\-stdout\fP förutom att den dekomprimerade datan slängs +istället för att skrivas på standard ut. Inga filer skapas eller tas bort. +.TP +\fB\-l\fP, \fB\-\-list\fP +Skriv information om komprimerade \fIfiler\fP. Inge dekomprimeringsutdata +skapas, och inga filer skapas eller tas bort. I listläge kan programmet inte +läsa komprimerad data från standard in eller från andra källor där man inte +kan söka. +.IP "" +Standardlistningen visar grundläggande information om \fIfiler\fP, en fil per +rad. För att få mer detaljerad information, använd även flaggan +\fB\-\-verbose\fP. För ännu mer information, använd \fB\-\-verbose\fP två gånger, men +observera att detta kan vara långsamt, eftersom det behövs många sökningar +får att samla all den extra informationen. Bredden av utförlig utdata +överskrider 80 tecken, så att skicka utdata i ett rör till, till exempel, +\fBless\ \-S\fP kan vara bekvämt om terminalen inte är bred nog. +.IP "" +Den exakta utdatan kan variera mellan versioner av \fBxz\fP och olika +lokaler. För maskinläsbar utdata bör \fB\-\-robot \-\-list\fP användas. +. +.SS Arbetsmodifierare +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ta inte bort indatafilerna. +.IP "" +Från \fBxz\fP 5.2.6 gör denna flagga även att \fBxz\fP komprimerar eller +dekomprimerar även om indatan är en symbolisk länk till en normal fil, har +mer än en hård länk eller har biten setuid, setgid eller sticky +satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. I +tidigare versioner gjordes detta bara med \fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Denna flagga har flera funktioner: +.RS +.IP \(bu 3 +Om målfilen redan finns, radera den före komprimering eller dekomprimering. +.IP \(bu 3 +Komprimera eller dekomprimera även om indatan är en symbolisk länk till en +normal fil, har mer än en hård länk eller har biten setuid, setgid eller +sticky satt. Bitarna setuid, setgid och sticky kopieras inte till målfilen. +.IP \(bu 3 +När den används med \fB\-\-decompress\fP \fB\-\-stdout\fP och \fBxz\fP inte känner igen +typen på källfilen, kopiera källfilen som den är till standard ut. Detta gör +att \fBxzcat\fP \fB\-\-force\fP kan användas som \fBcat\fP(1) för filer som inte har +komprimerats med \fBxz\fP. Observera att i framtiden kan \fBxz\fP komma att stödja +nya komprimeringsfilformat, vilket kan få \fBxz\fP att dekomprimera fler typer +av filer istället för att kopiera dem till standard ut. +\fB\-\-format=\fP\fIformat\fP kan användas för att begränsa \fBxz\fP till att +dekomprimera endast ett enda filformat. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Skriv den komprimerade eller dekomprimerade datan till standard ut istället +för en fil. Detta implicerar \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Dekomprimera endast den första \fB.xz\fP\-strömmen, och ignorera tys eventuella +återstående indata som följer efter strömmen. Normalt får sådant avslutande +skräp \fBxz\fP att visa ett fel. +.IP "" +\fBxz\fP dekomprimerar aldrig mer än en ström från \fB.lzma\fP\-filer eller råa +strömmar, men denna flagga gör ändå att \fBxz\fP ignorerar den möjliga +efterföljande datan efter \fB.lzma\fP\-filen eller den råa strömmen. +.IP "" +Denna flagga har ingen effekt om arbetsläget inte är \fB\-\-decompress\fP eller +\fB\-\-test\fP. +.IP "" +Sedan \fBxz\fP 5.7.1alpha, implicerar \fB\-\-single\-stream\fP \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Avaktivera att glesa filer skapas. Som standard, om den dekomprimerar till +en normal fil, försöker \fBxz\fP att göra filen gles om den dekomprimerade +datan innehåller långa sekvenser av binära nollor. Det fungerar även när den +skriver till standard ut så länga standard ut är kopplad till en normal fil +och vissa ytterligare villkor möts för att göra det säkert. Att skapa glesa +filer kan spara diskutrymme och snabba upp dekomprimeringen genom att +begränsa mängden disk\-I/O. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +Vid komprimering, använd \fI.suf\fP som suffixet för målfilen istället för +\&\fB.xz\fP eller \fB.lzma\fP. Om den inte skriver till standard ut och källfilen +redan har suffixet \fI.suf\fP visas en varning och filen hoppas över. +.IP "" +Vid dekomprimering, känn igen filer med suffixet \fI.suf\fP utöver filer +medsuffixen \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP eller \fB.lz\fP. Om källfilen +har suffixet \fI.suf\fP tas suffixet bort för att få målfilnamnet. +.IP "" +Vid komprimering eller dekomprimering av råa strömmar (\fB\-\-format=raw\fP) +måste alltid suffixet anges om den inte skriver till standard ut, eftersom +det inte finns något standardsuffix för råa strömmar. +.TP +\fB\-\-files\fP[\fB=\fP\fIfil\fP] +Läs filnamnen att arbeta på från \fIfil\fP; om \fIfil\fP utelämnas läses filnamn +från standard in. Filnamn måste avslutas med nyradstecknet. Ett bindestreck +(\fB\-\fP) tas som ett vanligt filnamn; det betyder inte standard in. Om filnamn +även anges som kommandoradsargument, bearbetas de före filnamnen som läses +från \fIfil\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIfil\fP] +Detta är identiskt med \fB\-\-files\fP[\fB=\fP\fIfil\fP] förjutom att varje filnamn +måste avslutas med ett nulltecken. +. +.SS "Grundläggande flaggor för filformat och komprimering" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIformat\fP +Angi filens \fIformat\fP att komprimera eller dekomprimera: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Detta är standard. Vid komprimering är \fBauto\fP ekvivalent med \fBxz\fP. Vid +dekomprimering detekteras automatiskt formatet på indatafilen. Observera att +råa strömmar (skapade med \fB\-\-format=raw\fP inte kan detekteras automatiskt. +.TP +\fBxz\fP +Komprimera till filformatet \fB.xz\fP, eller acceptera endast \fB.xz\fP\-filer vid +dekomprimering. +.TP +\fBlzma\fP, \fBalone\fP +Komprimera till det föråldrade filformatet \fB.lzma\fP, eller acceptera endast +\&\fB.lzma\fP\-filer fid dekomprimering. Det alternativa namnet \fBalone\fP +tillhandahålls för bakåtkompatibilitet med LZMA Utils. +.TP +\fBlzip\fP +Acceptera endast \fB.lz\fP\-filer vid dekomprimering. Komprimering stödjs inte. +.IP "" +\&\fB.lz\fP\-formatet version 0 och 1 stödjs. Version 0\-filer producerades av +\fBlzip\fP 1.3 och tidigare. Sådana filer är inte vanliga men kan hittas från +filarkiv eftersom några källpaket släpptes i detta format. Folk kan ha även +ha gamla personliga filer i detta format. Dekomprimeringsstöd för format +version 0 togs bort i \fBlzip\fP 1.18. \fBlzip\fP 1.4 och senare kan skapa filer i +formatversion 1. +.TP +\fBraw\fP +Komprimera eller dekomprimera en rå ström (inga huvuden). Detta är endast +avsett för avancerade användare. För att avkoda råa strömmar behöver man +använda \fB\-\-format=raw\fP och explicit angi filterkedjan, vilken normalt +skulle ha lagrats i behållarens huvuden. +.RE +.TP +\fB\-C\fP \fIkontroll\fP, \fB\-\-check=\fP\fIkontroll\fP +Ange typen av integritetskontroll. Kontrollen beräknas från den +dekomprimerade datan och lagras i \fB.xz\fP\-filen. Denna flagga har endast +någon inverkan när man komprimerar till formatet \fB.xz\fP; formatet \fB.lzma\fP +stödjer inte integritetskontroller. Integritetskontrollen (om någon) +verifieras när \fB.xz\fP\-filen dekomprimeras. +.IP "" +\fIKontroll\fPtyper som stödjs: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Beräkna inte någon integritetskontroll alls. Detta är normalt en dålig +idé. Det kan vara användbart när datans integritet ändå verifieras på andra +sätt. +.TP +\fBcrc32\fP +Beräkna CRC32 med polynomet från IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Beräkna CRC64 med polynomet från ECMA\-182. Detta är standard, eftersom det +är något bättre än CRC32 på att upptäcka skadade filer och +hastighetsskillnaden är försumbar. +.TP +\fBsha256\fP +Beräkna SHA\-256. Detta är något långsammare än CRC32 och CRC64. +.RE +.IP "" +Integriteten hos \fB.xz\fP\-huvuden verifieras alltid med CRC32. Det är inte +möjligt att ändra eller avaktivera det. +.TP +\fB\-\-ignore\-check\fP +Verifiera inte integritetskontrollen av den komprimerade datan vid +dekomprimering. CRC32\-värden i \fB.xz\fP\-huvudena kommer fortfarande verifieras +normalt +.IP "" +\fBAnvänd inte denna flagga om du inte vet vad du gör.\fP Möjliga anledningar +till att använda denna flagga: +.RS +.IP \(bu 3 +Försöka återvinna data från en trasig .xz\-fil. +.IP \(bu 3 +Snabba upp dekomprimering. Detta har störst betydelse med SHA\-256 eller med +filer som har komprimerats extremt mycket. Det rekommenderas att inte +använda denna flagga för detta ändamål om inte filintegriteten verifieras +externt på något annat sätt. +.RE +.TP +\fB\-0\fP … \fB\-9\fP +Välj en förinställningsnivå för komprimering. Standard är \fB\-6\fP. Om flera +förinställningsnivåer anges gäller den sist angivna. Om en anpassad +fileterkedja redan angivits gör en inställning av en förinställningsnivå för +komprimering att den anpassade filterkedjan töms. +.IP "" +Skillnaden mellan förinställningarna har större betydelse än med \fBgzip\fP(1) +och \fBbzip2\fP(1). Den valda komprimeringsinställningen avgör minneskraven för +dekomprimeraren, att använda en för hög förinställningsnivå kan alltså göra +det plågsamt att dekomprimera filer på ett gammalt system med lite +RAM. Specifikt \fBär det inte en bra ide att blint använda \-9 för allt\fP +liksom det ofta är med \fBgzip\fP(1) och \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP … \fB\-3\fP +Dessa är ganska snabba förinställningar. \fB\-0\fP är ibland snabbare än \fBgzip \-9\fP samtidigt som komprimeringen är mycket bättre. De högre har ofta +hastighet jämförbar med \fBbzip2\fP(1) med jämförbar eller bättre +komprimeringsförhållande, även om resultatet mycket beror på typen av data +som komprimeras. +.TP +\fB\-4\fP … \fB\-6\fP +Bra för väldigt god komprimering samtidigt som dekomprimerarens +minnesanvändning hålls rimlig även på gamla system. \fB\-6\fP är standardvärdet, +vilket vanligen är ett bra val för att distribuera filer so behöver +dekomprimeras även på ssytem med endast 16\ MiB RAM. (\fB\-5e\fP eller \fB\-6e\fP +kan också vara värda att överväga. Se \fB\-\-extreme\fP.) +.TP +\fB\-7 … \-9\fP +Dessa liknar \fB\-6\fP med med högre krav på minne till komprimerare och +dekomprimerare. Dessa är bara användbara vid komprimering av filer större än +8\ MiB, 16\ MiB respektive 32\ MiB. +.RE +.IP "" +På samma hårdvara är dekomprimeringshastigheten ungefär ett konstant antal +byt av komprimerad data per sekund. Med andra ord, ju bättre komprimering, +desto snabbare kommer dekomprimeringen vanligen vara. Detta betyder även att +mängden av okomprimerad utdata skapad per sekund kan variera mycket. +.IP "" +Följande tabell sammanfattar funktionerna hos förinställningarna: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0;256 KiB;0;3 MiB;1 MiB +\-1;1 MiB;1;9 MiB;2 MiB +\-2;2 MiB;2;17 MiB;3 MiB +\-3;4 MiB;3;32 MiB;5 MiB +\-4;4 MiB;4;48 MiB;5 MiB +\-5;8 MiB;5;94 MiB;9 MiB +\-6;8 MiB;6;94 MiB;9 MiB +\-7;16 MiB;6;186 MiB;17 MiB +\-8;32 MiB;6;370 MiB;33 MiB +\-9;64 MiB;6;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Kolumnbeskrivningar: +.RS +.IP \(bu 3 +LexStrl är storleken på LZMA2:s lexikon. Det är slöseri med minne att +använda ett större lexikon än storleken på den okomprimerade filen. Detta är +anledningen till att det är bra att undvika förinställningarna \fB\-7\fP … \fB\-9\fP +när det inte finns något verkligt behov av dem. På \fB\-6\fP och lägre är +mängden bortslösat minne vanligen litet nog att inte ha någon betydelse. +.IP \(bu 3 +KompCPU är en förenklad representation av LZMA2\-inställningar som påverkar +komprimeringshastigheten. Lexikonstorleken påverkar också hastigheten, så +medan KompCPU är samma för nivåerna \fB\-6\fP … \fB\-9\fP tenderar fortfarande högre +nivåer att vara lite långsmmare. För ännu långsammare och möjligen bättre +komprimering, se \fB\-\-extreme\fP. +.IP \(bu 3 +KompMem innehåller komprimerarens minneskrav i enkeltrådat läge. Det kan +variera något mellan versioner av \fBxz\fP. +.IP \(bu 3 +DekMin innehåller dekomprimerarens minneskrav. Det vill säga, komprimerarens +inställningar avgör minneskravet för dekomprimeraren. Den exakta +minnesanvändningen hos dekomprimeraren är något mer än +LZMA2\-lexikonstorleken, men värdena i tabellen har avrundats upp till nästa +nästa hela MiB. +.RE +.IP "" +Minneskravet för det multitrådade läget är signifikant högre än det för +enkeltrådat läge. Med standardvärdet på \fB\-\-block\-size\fP behöver varje tråd +3·3·LexStrl plus KompMin eller DekMin. Till exempel, fyra trådar med +förinställningen behöver 660\(en670 MiB minne. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Använd en långsammare variant av den valda förinställningsnivån för +komprimering (\fB\-0\fP … \fB\-9\fP) för att förhoppningsvis få lite bättre +komprimeringsförhållande, men med otur kan detta även göra det +sämre. Dekomprimerarens minnesanvändning påverkas inte, men komprimerarens +minnesanvändning ökar lite vid förinställningsnivåerna \fB\-0\fP … \fB\-3\fP. +.IP "" +Eftersom det finns två förinställningar med lexikonstorlekar 4\ MiB och 8\ MiB använder förinställningarna \fB\-3e\fP och \fB\-5e\fP något snabbare +inställningar (lägre KompCPU) än \fB\-4e\fP respektive \fB\-6e\fP. På det sättet är +inte två förinställningar identiska. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Förinställning;LexStrl;KompCPU;KompMin;DekMin +\-0e;256 KiB;8;4 MiB;1 MiB +\-1e;1 MiB;8;13 MiB;2 MiB +\-2e;2 MiB;8;25 MiB;3 MiB +\-3e;4 MiB;7;48 MiB;5 MiB +\-4e;4 MiB;8;48 MiB;5 MiB +\-5e;8 MiB;7;94 MiB;9 MiB +\-6e;8 MiB;8;94 MiB;9 MiB +\-7e;16 MiB;8;186 MiB;17 MiB +\-8e;32 MiB;8;370 MiB;33 MiB +\-9e;64 MiB;8;674 MiB;65 MiB +.TE +.RE +.RE +.IP "" +Till exempel finns det totalt fyra förinställningar som använder 8\ MiB +lexikon, vars ordning från den snabbaste till den långsammaste är \fB\-5\fP, +\fB\-6\fP, \fB\-5e\fP och \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Dessa är något missledande alias för \fB\-0\fP respektive \fB\-9\fP. Dessa finns +endast för bakåtkompatibilitet med LZMA\-verktyg. Undvik att använda dessa +flaggor. +.TP +\fB\-\-block\-size=\fP\fIstorlek\fP +Vid komprimering till formatet \fB.xz\fP, dela indatai block med \fIstorlek\fP +bytes. Blocken komprimeras oberoende av varandra, vilket hjälper till vid +multitrådning och gör begränsad random\-access\-dekomprimering möjlig. Denna +flagga används typiskt för att åsidosätta blockstorleken i multitrådat läge, +men denna flagga kan användas även i enkeltrådat läge. +.IP "" +I multitrådat läge kommer ungefär tre gånger \fIstorlek\fP byte att allokeras i +varje tråd för buffring av indata och utdata. Standardvärdet på \fIstorlek\fP +är det större av tre gånger LZMA2\-lexikonstorleken eller 1 MiB. Typiskt är +ett bra värde 2\(en4 gånger storleken på LZMA2\-lexikonet eller åtminstone 1 +MiB. Att använda en \fIstorlek\fP mindre än LZMA2\-lexikonstorleken utgör +slöseri med RAM eftersom LZMA2\-lexikonbufferten då aldrig kommer användas +helt. I multitrådat läge lagras storlekarna på plocken i +blockhuvudena. Denna storleksinformation krävs för multitrådad +dekomprimering. +.IP "" +I singletrådat läge görs som standard ingen uppdelning i block. Att göra +denna inställning påverark inte minnesanvändningen. Ingen +storleksinformation lagras i blockhuvuden, därmed kommer filer som skapas i +enkeltrådat läge inte att vara identiska med filer skapade i multitrådat +läge. Avsaknaden av sotrleksinformation betyder också att \fBxz\fP inte kommer +kunna dekomprimera filerna i multitrådat läge. +.TP +\fB\-\-block\-list=\fP\fIposter\fP +Vid komprimering till formatet \fB.xz\fP, börja ett nytt block med en möjlig +anpassad filterkedja efter de angivna intervallen med okomprimerade data. +.IP "" +\fIPosterna\fP är en kommaseparerad lista. Varje post består av ett möjligt +filterkedjenummer mellan 0 och 9 följt av ett kolon (\fB:\fP) och en +obligatorisk storlek för okomprimerade data. Att utelämna en post (två på +varandra följande komman) är en kortform för att använda storleken och +filtren från föregående post. +.IP "" +Om indatafiler är större än summan av storlekarna i \fIposter\fP repeteras den +sista posten fram till slutet på filen. Ett speciellt värde \fB0\fP kan +användas som den sista storleken för att indikera att resten av filen skall +kodas som ett enda block. +.IP "" +En alternativ filterkedja för varje block kan anges i kombinaton med +flaggorna \fB\-\-filters1=\fP\fIfilter\fP \&…\& \fB\-\-filters9=\fP\fIfilter\fP. Dessa +flaggor definierar filterkedjor med en identifierare mellan +1\(en9. Filterkedja 0 kan användas för att referera till +standardfilterkedjan, vilket är samma sak som att inte ange någon +filterkedja. Filterkedjeidentifierare kan användas före den okomprimerade +sotrleken, följt av ett kolon (\fB:\fP). Till exempel, om man anger +\fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP kommer block skapas med: +.RS +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters1\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters3\fP och 2 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Filterkedjan angiven av \fB\-\-filters2\fP och 4 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 2 MiB indata +.IP \(bu 3 +Standardfilterkedjan och 4 MiB indata för varje block till slutet av indata. +.RE +.IP "" +Om man anger en storlek som överskrider kodarens blockstorlek (antingen +standardvärdet i trådat läge eller värdet som anges med +\fB\-\-block\-size=\fP\fIstorlek\fP) kommer kodaren skapa ytterligare block med +hänsyn taget till gränserna som anges i \fIposter\fP. Till exempel, om man +anger \fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP och +indatafilen är 80 MiB kommer man få 11 block: 5, 10, 8, 10, 2, 10, 10, 4, +10, 10 och 1 MiB. +.IP "" +I multitrådat läge lagras storleken på blocken i blockhuvudena. Detta görs +inte i enkeltrådat läge, så den kodade utdatan kommer inte vara identisk med +den från det multitrådade läget. +.TP +\fB\-\-flush\-timeout=\fP\fItidsgräns\fP +Vid komprimering, om mer än \fItidsgräns\fP millisekunder (ett positivt heltal) +har gått sedan den föregånde tömningen och en läsning av mer indata skulle +blockera töms all väntande indata från kodaren och görs tillgänglig i +utdataströmmen. Detta kan vara användbart om \fBxz\fP används för att +komprimera data som strömmas över ett nätverk. Små värden på \fItidsgräns\fP +gör data tillgänglig vid den mottagande änden med en liten fördröjning, men +större värden på \fItidsgräns\fP ger bättre komprimeringsförhållande. +.IP "" +Denna funktion är avaktiverad som standard. Om denna flagga anges mer än en +gång gäller den sista. Dett speciella värdet \fB0\fP på \fItidsgräns\fP kan +användas för att uttryckligen avaktivera denna funktion. +.IP "" +Denna funktion är inte tillgänglig på icke\-POSIX\-system. +.IP "" +.\" FIXME +\fBDenna funktion är fortfarande experimentell.\fP För närvarande är \fBxz\fP +olämplig för dekomprimering av strömmen i realtid på grund av hur \fBxz\fP +buffrar. +.TP +\fB\-\-no\-sync\fP +Synkronisera inte målfilen och dess katalog med lagringsenheten före +källfilen tas bort. Detta kan förbättra prestanda vid komprimering eller +dekomprimering av många små filer. Dock, om systemet kraschar snart efter +raderingen är det möjligt att målfilen inte skrevs till lagringsenheten men +att raderingen gjordes det. I det fallet är varken originalkällfilen eller +målfilen tillgänglig. +.IP "" +Denna flagga har bara någon effekt när \fBxz\fP kommer att ta bort källfilen. I +andra fall görs aldrig någon synkronisering. +.IP "" +Synkroniseringen och \fB\-\-no\-sync\fP lades till i \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIgräns\fP +Sätt en gräns på minnesanvändningen för komprimeringen. Om denna flaggan +anges flera gånger gäller den sista. +.IP "" +Om komprimeringsinställnigarna överskrider \fIgränsen\fP kommer \fBxz\fP försöka +justera inställningarna neråt så att gränsen inte längre överskrids och visa +en notis om att en automatisk justering gjorts. Justeringen görs i denna +ordning: reducera antalet trådar, byta till enkeltrådat läge om även en tråd +i multitrådat läge överskrider \fIgränsen\fP och slutligen reducera +LZMA2\-lexikonstorleken. +.IP "" +Vid komprimering med \fB\-\-format=raw\fP eller om \fB\-\-no\-adjust\fP har angetts kan +endast antalet trådar reduceras eftersom det kan göras utan att påverka den +komprimerade utdatan. +.IP "" +Om \fIgränsen\fP inte kan uppfyllas ens med justeringarna som beskrivs ovan +visas ett felmeddelande och \fBxz\fP kommer avsluta med slutstatus 1. +.IP "" +\fIGränsen\fP kan anges på flera sätt: +.RS +.IP \(bu 3 +\fIGränsen\fP kan vara ett absolut värde i byte. Att använda ett heltalssuffix +som \fBMiB\fP kan vara praktiskt. Exempel: \fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +\fIGränsen\fP kan anges som en procentsats av det totala fysiska minnet +(RAM). Detta kan vara användbart särskilt när man sätter miljövariabeln +\fBXZ_DEFAULTS\fP i ett skalinitieringsskript som delas mellan olika +datorer. På det sättet är gränsen automatiskt större på system med mer +minne. Exempel: \fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +\fIGränsen\fP kan återställas tillbaka till sitt standardvärde genom att sätta +den till \fB0\fP. Detta är för närvarande ekvivalent med att sätta \fIgränsen\fP +till \fBmax\fP (ingen gräns på minnesanvändning). +.RE +.IP "" +För 32\-bitars \fBxz\fP finns det ett specialfall: om \fIgränsen\fP skulle vara +över \fB4020\ MiB\fP sätts \fIgränsen\fP till \fB4020\ MiB\fP. På MIPS32 används +\fB2000\ MiB\fP istället. (Värdena \fB0\fP och \fBmax\fP påverkas inte av detta. En +liknande funktion finns inte för dekomprimering.) Detta kan hjälpa till när +ett 32\-bitarsprogram har tillgång till 4\ GiB adressrymd (2 GiB på MIPS32) +förhoppningsvis utan att göra någon skada i andra situationer. +.IP "" +Se även avsnittet \fBMinnesanvändning\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvnändningen vid dekomprimering. Detta påverkar +även läget \fB\-\-list\fP. Om åtgärden inte är möjlig utan att överskrida +\fIgränsen\fP kommer \fBxz\fP visa ett felmeddelande och dekomprimeringen av filen +kommer misslyckas. Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att +ange \fIgränsen\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP +Sätt en gräns för minnesanvändningen för multitrådad dekomprimering. Detta +kan endast påverka antalet trådar; det kommer aldrig att få \fBxz\fP att vägra +att dekomprimera en fil. Om \fIgränsen\fP är för låg för att tillåta någon +multitrådning ignoreras \fIgränsen\fP och \fBxz\fP kommer gå vidare i enkeltrådat +läge. Observera att om även \fB\-\-memlimit\-decompress\fP används kommer det +alltid att gälla både enkeltrådat och multitrådat läge, och därmed kommer +den gällande \fIgränsen\fP för multitrådning aldrig vara högre än gränsen som +sätts med \fB\-\-memlimit\-decompress\fP. +.IP "" +Till skillnad mot de andra flaggorna för gränser för minnesanvändning har +\fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP en systemspecifik +standard\fIgräns\fP. \fBxz \-\-info\-memory\fP kan användas för att se det aktuella +värdet. +.IP "" +Denna flagga och dess standardvärde finns för att utan någon gräns skulle +den trådade dekomprimeraren kunna allokera en vansinnig mängd minne med +några indatafiler. Om standard\fIgränsen\fP är för låg på ditt system, öka då +gärna \fIgränsen\fP men sätt den aldrig till ett större värde än mängden +användbart RAM eftersom att med passande indatafiler kommer \fBxz\fP försöka +använda den mängden av minne även med ett lågt antal trådar. Att få slut på +minne ller växling kommer inte förbättra dekomprimeringsprestandan. +.IP "" +Se \fB\-\-memlimit\-compress=\fP\fIgräns\fP för möjliga sätt att ange \fIgränsen\fP. Att +sätta \fIgräns\fP till \fB0\fP återställer \fIgränsen\fP till sdet systemspecifika +standardvärdet. +.TP +\fB\-M\fP \fIgräns\fP, \fB\-\-memlimit=\fP\fIgräns\fP, \fB\-\-memory=\fP\fIgräns\fP +Detta är ekvivalent med att ange \fB\-\-memlimit\-compress=\fP\fIgräns\fP +\fB\-\-memlimit\-decompress=\fP\fIgräns\fP \fB\-\-memlimit\-mt\-decompress=\fP\fIgräns\fP. +.TP +\fB\-\-no\-adjust\fP +Visa ett fel och avsluta om gränsen för minnesanvändning inte kan mötas utan +att justera inställnigar som påverkar den komprimerade utdatan. Det vill +säga, detta förhindrar att \fBxz\fP byter kodaren från multitrådat läge till +enkeltrådat läge och från att den reducerar LZMA2\-lexikonets storlek. Även +när denna flagga används kan antalet trådar reduceras för att möta gränsen +för minnesanvändning eftersom det inte kommer påverka den komprimerade +utdatan. +.IP "" +Automatisk justering är alltid avaktiverat när råa strömmar skapas +(\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fItrådar\fP, \fB\-\-threads=\fP\fItrådar\fP +Ange antalet arbetstrådar som skall användas. Att sätta \fItrådar\fP till ett +specialvärde \fB0\fP gör att \fBxz\fP använder så många trådar som processorerna +på systemet stödjer. Det aktuella antalet trådar kan vara färre än \fItrådar\fP +om indatafilen inte är stor nog för trådning med de givna inställningarna +eller om användning av fler trådar skulle överkrida gränsen för +minnesanvändning. +.IP "" +De enkeltrådade och multitrådade komprimerarna producerar olika utdata. Den +enkeltrådade komprimeraren kommer ge den minsta filstorleken men endast +utdata från den multitrådade komprimeraren kan dekomprimeras med flera +trådar. Att sätta \fItrådar\fP till \fB1\fP kommer använda enkeltrådat läge. Att +sätta \fItrådar\fP till något annat värde, inklusive \fB0\fP, kommer använda den +multitrådade komprimeraren även om systemet endast stödjer en hårdvarutråd. +(\fBxz\fP 5.2.x använde enkeltrådat läge i denna situation.) +.IP "" +För att använda multitrådat läge med endast en tråd, sätt \fItrådar\fP till +\fB+1\fP. Prefixet \fB+\fP har ingen påvrekan för andra värden än \fB1\fP. En gräns +för minnesanvändning kan fortfarande göra att \fBxz\fP byter till enkeltrådat +läge såvida inte \fB\-\-no\-adjust\fP används. Stöd för prefixet \fB+\fP lades till i +\fBxz\fP 5.4.0. +.IP "" +Om ett automatiskt antal trådar har begärts och ingen gräns för +minnesanvändning har angivits, då kommer en systemspecifik mjuk +standardgräns användas för att möjligen begränsa antalet trådar. Det är en +mjuk gräns i den meningen att den ignoreras om antalet trådar blir en, +alltså kommer en mjuk gräns aldrig hindra \fBxz\fP från att komprimera eller +dekomprimera. Denna mjuka standardgräns kommer inte göra att \fBxz\fP byter +från multitrådat läge till enkeltrådat läge. De aktiva gränserna kan ses med +\fBxz \-\-info\-memory\fP. +.IP "" +För närvarande är den enda trådningsmetoden att dela indata i block och +komprimera dem oberoende av varandra. Standardstorleken på block beror på +komprimeringsnivån och kan åsidosättas med flaggan +\fB\-\-block\-size=\fP\fIstorlek\fP. +.IP "" +Trådad dekomprimering fungerar bara på filer som innehåller flera block med +storleksinformation i blockhuvuden. Alla tillräckligt stora filer +komprimeras i multitrådat läge för att uppfylla detta villkor, men filer +komprimerade i enkeltrådat läge gör det inte ens om +\fB\-\-block\-size=\fP\fIstorlek\fP har använts. +.IP "" +Standardvärdet på \fItrådar\fP är \fB0\fP. I \fBxz\fP 5.4.x och tidigare är +standardvärdet \fB1\fP. +. +.SS "Anpassade komprimerarfilterkedjor" +Med en anpassad filterkedja kan man specificera kompressionsinställningarna +i detalj istället för att lita på inställningarna som hör till +förinställningarna. När en anpassad filterkedja anges glöms +förinställningsflaggor (\fB\-0\fP \&…\& \fB\-9\fP och \fB\-\-extreme\fP) tidigare på +kommandoraden. Om en förinställningsflagga anges efter en eller flera +flaggor för anpassade filterkedjor gäller den nya förinställningen och de +flaggor för anpassade filterkedjor som angivits tidigare glöms. +.PP +En filterkedja är jämförbar med att skapa rör på kommando. Vid komprimering +skickas den okomprimerade indatan till det första filtret, vars utdata +skickas till nästa filter (om något). Utdatan från det sista filtret blir +skrivet till den komprimerade filen. Det maximala antalet filter i kedjan är +fyra, men typiskt har en filterkedja bara ett ellet två filter. +.PP +Många filter har begränsningar på var de kan finnas i filterkedjan: några +filter kan bara fungera som det sista filtret i kedjan, några bara om de +inte är det sista filtret, och några fungerar i godtycklig position i +kedjan. Beroende på filtret är denna begränsning antingen en egenskap hos +filterdesignen eller finns för att förhindra säkerhetsproblem. +.PP +En anpassad filterkedja kan anges på två olika sätt. Med flaggorna +\fB\-\-filters=\fP\fIfilter\fP och \fB\-\-filters1=\fP\fIfilter\fP \&…\& +\fB\-\-filters9=\fP\fIfilter\fP kan man ange en hel filterkedja med en flagga genom +att använda syntaxen för liblzma\-filtersträngar. Alternativt kan en +filterkedja anges genom att använda en eller flera individuella +filterflaggor i den ordning de önskas i filterkedjan. Det vill säga, +ordningen på de individuella filterflaggorna är signifikant! Vid avkodning +av råa strömmar (\fB\-\-format=raw\fP) måste filterkedjan anges i samma ordning +som den specificerades vid komprimeringen. Eventuella individuella filter\- +eller förinstiällningsflaggor angivna före den fullständiga +filterkedjeflaggan (\fB\-\-filters=\fP\fIfilter\fP) kommer glömmas. Individuella +filter som anges efter den flaggan för en full kedja kommer återställa +filterkedjan. +.PP +Både den fullständiga och de individuella filterflaggorna tar +filterspecifika \fIflaggor\fP som en kommaseparerad lista. Extra komman +\fIflaggor\fP ignoreras. Varje flagga har ett standardvärde, så ange dem du +vill ändra. +.PP +För att se hela filterkedjan och \fIflaggor\fP, använd \fBxz \-vv\fP (det vill +säga, använd \fB\-\-verbose\fP två gånger). Detta fungerar även för att se +flaggorna för filterkedjor som används av förinställningar. +.TP +\fB\-\-filters=\fP\fIfilter\fP +Ange den fullständiga filterkedan eller en förinställning en en enda +flagga. Varje filter kan separeras med blanktecken eller två bindestreck +(\fB\-\-\fP). \fIfilter\fP kan behöva citeras på skalets kommandorad så att det +tolkas som en enda flagga. För att beteckna \fIflaggor\fP, använd \fB:\fP eller +\fB=\fP. En förinställning kan föregås med ett \fB\-\fP och följas av noll eller +flera flaggor. Den enda flaggan som stödjs är \fBe\fP för att tillämpa samma +flaggor som \fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIfilter\fP … \fB\-\-filters9\fP=\fIfilter\fP +Ange upp till nio ytterligare filterkedjor som kan användas med +\fB\-\-block\-list\fP. +.IP "" +Till exempel, vid komprimering av ett arkiv med körbara filer följt av +textfiler skulle den körbara delen kunna använda en filterkedja med ett +BCJ\-filter och endast textdelen med LZMA2\-filtret. +.TP +\fB\-\-filters\-help\fP +Visa ett hjälpmeddelande som beskriver hur man anger förinställningar och +anpassade filterkedjor i flaggorna \fB\-\-filters\fP och \fB\-\-filters1=\fP\fIfilter\fP +\&…\& \fB\-\-filters9=\fP\fIfilter\fP, och avsluta rent. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till LZMA1\- eller LZMA2\-filter till filterkedjan. Dessa filter kan +endast användas som det sista filtret i kedjan. +.IP "" +LZMA1 är ett föråldrat filter, vilket stödjs nästan enbart på grund av det +föråldrade filformatet \fB.lzma\fP, vilket bara stödjer LZMA1. LZMA2 är en +uppdaterad version av LZMA1 för att lösa några praktiska problem med +LZMA1. Formatet \fB.xz\fP använder LZMA2 och stödjer inte LZMA1 +alls. Komprimeringshastigheten och förhållandena för LZMA1 är LZMA2 är +praktiskt taget desamma. +.IP "" +LZMA1 och LZMA2 delar samma uppättning \fIflaggor\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIförinställning\fP +Återställ alla LZMA1\- eller LZMA2\-\fIflaggor\fP till +\fIförinställning\fP. \fIFörinställning\fP består av ett heltal, vilket kan följas +av enskilda bokstäver som modifierar förinställningen. Heltalet kan vara +från \fB0\fP till \fB9\fP, motsvarande kommandoradsflaggorna \fB\-0\fP \&…\& +\fB\-9\fP. Den enda modifierare som stödjs för närvarande är \fBe\fP, vilket +motsvarar \fB\-\-extreme\fP. Om ingen \fBpreset\fP anges tas standardvärden på +LZMA1\- eller LZMA2\-\fIflaggor\fP från förinställningen \fB6\fP. +.TP +\fBdict=\fP\fIstorlek\fP +Ett lexikons (historiebufferts) \fIstorlek\fP indikerar hur många byte med +nyligen bearbetad okomprimerad data som hålls i minnet. Algoritmen försöker +hitta återkommande bytesekvenser (matchningar) i den okomprimerade datan, +och ersätta dem med referenser till datan som för närvarande finns i +lexikonet. Ju större lexikon, desto högre är sannolikheten att hitta en +matchning. Att öka lexikonets \fIstorlek\fP förbättrar alltså vanligen +komprimeringsförhållandet, men ett lexikon som är större än den +okomprimerade filen är ett slöseri med minne. +.IP "" +En typisk \fIstorlek\fP på lexikon är från 64\ KiB till 64\ MiB. Minimum är 4\ KiB. Det maximala för komprimering är för närvarande 1,5\ GiB (1536\ MiB). Dekomprimeraren stödjer redan lexikon upp till en byte mindre än 4\ GiB, vilket är det maximala för strömformaten LZMA1 och LZMA2. +.IP "" +Lexikon\fIstorlek\fP och matchhittaren (\fImf\fP) avgör tillsammans +minnesanvändningen för LZMA1\- eller LZMA2\-kodaren. Ett lika \fIstort\fP (eller +större) lexikon behövs för dekomprimering som det som användes vid +komprimeringen, minnesanvändningen för avkodaren avgörs alltså av +lexikonstorleken vid komprimering. Huvudena i \fB.xz\fP innehåller lexikonets +\fIstorlek\fP antingen som 2^\fIn\fP eller 2^\fIn\fP + 2^(\fIn\fP\-1), så dessa +\fIstorlekar\fP är lite att föredra för komprimering. Andra \fIstorlekar\fP kommer +avrundas uppåt när de lagras i huvuden i \fB.xz\fP. +.TP +\fBlc=\fP\fIlk\fP +Ange antalet literala kontextbitar. Minimum är 0 och maximum är 4; +standardvärdet är 3. Dessutom får inte summan av \fIlk\fP och \fIlp\fP överskrida +4. +.IP "" +Alla byte som inte kan kodas som matchningar kodas som literaler. Det vill +säga, literaler är helt enkelt 8\-bits byte som kodas en åt gången. +.IP "" +Den literala kodningen gör antagandet att de högsta \fIlk\fP bitarna av den +föregående okomprimerade byten korrelerar med nästa byte. Till exempel, i +typisk engelsk text följs ofta en versal bokstav av en gemen bokstav, och en +gemen bokstav följs vanligen av en annan gemen bokstav. I +teckenuppsättningen US\-ASCII är de högsta tre bitarna 010 för versala +bokstäver och 011 för gemena bokstäver. När \fIlk\fP är åtminstone 3 kan den +literala kodningen dra nytta av denna egenskap i den okomprimerade datan. +.IP "" +Standardvärdet (3) är normalt bra. Om man vill ha maximal komprimering, +prova \fBlc=4\fP. Ibland hjälper det lite, och ibland gör det komprimeringen +sämre. Om det gör den sämre, testa också \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Ange antalet literala positionsbitar. Minimum är 0 och maximum är 4; +standardvärdet är 0. +.IP "" +\fILp\fP påverkar vilken sorts justering i den okomprimerade datan som antas +vid kodning av literaler. Se \fIpb\fP nedan för mer information om justering. +.TP +\fBpb=\fP\fIpb\fP +Ange antalet positionsbitar. Minimum är 0 och maximum är 4; standardvärdet +är 2. +.IP "" +\fIPb\fP påverkar vilken sort justering i den okomprimerade datan som antas i +allmänhet. Standardvärdet betyder fyrbytejustering (2^\fIpb\fP=2^2=4), vilket +ofta är ett bra val när det inte finns någon bättre gissning. +.IP "" +När justeringen är känd kan en inställning av \fIpb\fP därefter reducera +filstorleken något. Till exempel, med textfiler som har en\-byte\-justering +(US\-ASCII, ISO\-8859\-*, UTF\-8) kan att sätta \fBpb=0\fP förbättra komprimeringen +något. För UTF\-16\-text är \fBpb=1\fP ett bra val. Om justeringen är ett udda +tal som 3 byte kan \fBpb=0\fP vara det bästa valet. +.IP "" +Även om den antagna justeringen kan anpassas med \fIpb\fP och \fIlp\fP föredrar +LZMA1 och LZMA2 ändå något 16\-byte\-justering. Det kan vara värt att ta med i +beräkningen vid design av filformat som sannolikt ofta kan komma att +komprimeras med LZMA1 eller LZMA2. +.TP +\fBmf=\fP\fIms\fP +Matchsökaren har en stor poverkan på kodarens hastighet, minnesanvändning +och komprimeringsförhållande. Vanligen är Hashkedje\-matchsökare snabbare än +Binärträdsmatchsökare. Standardvärdet beror på \fIföinställningen\fP: 0 +använder \fBhc3\fP, 1\(en3 använder \fBhc4\fP, och resten använder \fBbt4\fP. +.IP "" +Följande matchsökare stödjs. Formlerna för minnesanvändning nedan är grova +uppskattningar, vilka är närmast sanningen när \fIdict\fP är en tvåpotens. +.RS +.TP +\fBhc3\fP +Hashkedja med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 7.5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 5,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBhc4\fP +Hashkedja med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 7,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 6,5 (om \fIdict\fP > 32 MiB) +.TP +\fBbt2\fP +Binärträd med 2\-bytehashning +.br +Minsta värde på \fInice\fP: 2 +.br +Minnesanvändning: \fIdict\fP · 9,5 +.TP +\fBbt3\fP +Binärträd med 2\- och 3\-bytehashning +.br +Minsta värde på \fInice\fP: 3 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 16 MiB); +.br +\fIdict\fP · 9,5 + 64 MiB (om \fIdict\fP > 16 MiB) +.TP +\fBbt4\fP +Binärträd med 2\-, 3\- och 4\-bytehashning +.br +Minsta värde på \fInice\fP: 4 +.br +Minnesanvändning: +.br +\fIdict\fP · 11,5 (om \fIdict\fP ≤ 32 MiB); +.br +\fIdict\fP · 10,5 (om \fIdict\fP > 32 MiB) +.RE +.TP +\fBmode=\fP\fIläge\fP +Komprimerings\fIläget\fP anger metoden som används för att analysera data +skapade av matchsökaren. De \fIlägen\fP som stödjs är \fBfast\fP och +\fBnormal\fP. Standardvärdet är \fBfast\fP för \fIförinställningarna\fP 0\(en3 och +\fBnormal\fP för \fIförinställningarna\fP 4\(en9 +.IP "" +Vanligen används \fBfast\fP med Hashkedjematchsökare och \fBnormal\fP med +Binärträdsmatchsökare. Detta är även vad \fIförinställningarna\fP gör. +.TP +\fBnice=\fP\fIlagom\fP +Ange vad som anses vara en lagom längt på en matchning. När en matchning på +åtminstone \fIlagom\fP byte hittats slutar algoritmen söka efter möjliga bättre +matchningar. +.IP "" +\fILagom\fP kan vara 2\(en273 byte. Högre värden tenderar att ge bättre +komprimeringsförhållande på bekostnad av tid. Standardvärdet beror på +\fIförinställningen\fP. +.TP +\fBdepth=\fP\fIdjup\fP +Ange det maximala sökdjupet i matchsökaren. Standardvärdet är specialvärdet +0, vilket får komprimeraren att avgöra ett lämpligt \fIdjup\fP från \fImf\fP och +\fInice\fP. +.IP "" +Lämpligt \fIdjup\fP för Hashkedjor är 4\(en100 och 16\(en1000 för +Binärträd. Att använda väldigt höga värden på \fIdjup\fP kan göra kodaren +extremt långsam för vissa filer. Undvik att sätta \fIdjup\fP över 1000 såvida +du inte är beredd att avbryta komprimeringen om den tar för lång tid. +.RE +.IP "" +Vid avkodning av råa strömmar (\fB\-\-format=raw\fP) behöver LZMA2 endast +lexikonets \fIstorlek\fP. LZMA1 behöver även \fIlc\fP, \fIlp\fP och \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIflaggor\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIflaggor\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIflaggor\fP] +.PD +Lägg till gren/anrop/hopp\-filter (branch/call/jump, BCJ) till +filterkedjan. Dessa filter kan inte användas som det sista filtret i +filterkedjan. +.IP "" +Ett BCJ\-filter konverterar relativa adresser i maskinkod till deras absoluta +motsvarigheter. Detta ändrar inte storleken på datan men det ökar +redundansen, vilket kan hjälpa LZMA2 att skapa 0\(en15\ % mindre +\&\fB.xz\fP\-filer. BCJ\-filtren är alltid reversibla, så att använda ett +BCJ\-filter för fel sorts data orsakar inte någon dataförlust, men det kan +göra komprimeringsförhållandet något sämre. BCJ\-filtren är mycket snabba +och använder en obetydling mängd minne. +.IP "" +Dessa BCJ\-filter har kända problem kopplade till komprimeringsförhållandet: +.RS +.IP \(bu 3 +Någr sortes filer som innehåller körbar kod (till exempel, objektfiler, +statiska bibliotek och Linux kärnmoduler) har adresserna i instruktionerna +fyllda med utfyllnadsvärden. Dessa BCJ\-filter kommer ändå göra +adresskonverteringen, vilket kommer göra komprimeringen sämre för dessa +filer. +.IP \(bu 3 +Om ett BCJ\-filter används på ett arkiv är det möjligt att det gör +komprimeringsförhållandet sämre än att inte använda något BCJ\-filter. Till +exempel, om det finns liknande eller till och med identiska körbara kommer +filtreringen sannolikt göra filerna mindre lika och därmed blir +kompressionen sämre. Innehållet i icke körbara filer i samma arkiv kan också +spela en roll. I praktiken måste man prova med och utan ett BCJ\-filter för +att se vilket som är det bästa i varje situation. +.RE +.IP "" +Olika instruktionsuppsättningar har olika justering: den körbara filen måste +vara justerad till en multipel av detta värde i indata för att filtret skall +fungera. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Filter;Justering;Kommentarer +x86;1;32\-bitars eller 64\-bitars x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;4096\-bytesjustering är bäst +PowerPC;4;Endast rak byteordning +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Eftersom BCJ\-filtrerad data vanligen komprimeras med LZMA2 kan +komprimeringsförhållandet förbättras något om LZMA2\-flaggorna sätts till att +matcha justeringen hos det valda BCJ\-filtret. Exempel: +.RS +.IP \(bu 3 +IA\-64\-filter har 16\-bytejustering så \fBpb=4,lp=4,lc=0\fP är bra med LZMA2 +(2⁴=16). +.IP \(bu 3 +RISC\-V\-kod har 2\-byte\- eller 4\-bytejustering beroende på huruvida filen +innehåller 16\-bitars komprimerade instruktioner (utvidgningen C). När +16\-bitarsinstruktioner används är \fBpb=2,lp=1,lc=3\fP eller \fBpb=1,lp=1,lc=3\fP +bra. När det inte finns några 16\-bitsinstruktioner är \fBpb=2,lp=2,lc=2\fP +bäst. \fBreadelf \-h\fP kan användas för att kontrollera om ”RVC” förekommer på +raden ”Flaggor”. +.IP \(bu 3 +ARM64 är alltid 4\-bytejusterad så \fBpb=2,lp=2,lc=2\fP är bäst. +.IP \(bu 3 +Filtret x86 är ett undantag. Det är normalt bra att hålla sig till LZMA2:s +standardvärden (\fBpb=2,lp=0,lc=3\fP) när körbar x86 komprimeras. +.RE +.IP "" +Alla BCJ\-filter stödjer samma \fIflaggor\fP: +.RS +.TP +\fBstart=\fP\fIavstånd\fP +Ange start\fIavståndet\fP som används vid konvertering mellan relativa och +absoluta adresser. \fIAvståndet\fP måste vara en multipel av filtrets justering +(se tabellen ovan). Standardvärdet är noll. I praktiken är standardvärdet +bra; det är nästan aldrig användbart att ange ett anpassat \fIavstånd\fP. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIflaggor\fP] +Lägg till Deltafiltret till filterkedjan. Deltafiltret kan inte användas som +det sista filtret i filterkedjan. +.IP "" +För närvarande stödjs bara enkel byte\-vis deltaberäkning. Det kan vara +användbart vid komprimering, till exempel av okomprimerade +bitavbildningsbilder eller okomprimerad PCM\-audio. Dock kan algoritmer för +särskilda ändamål ge betydligt bättre resultat än Delta + LZMA2. Detta är +särskilt sant med audio, vilket komprimerar snabbare och bättre med till +exempel \fBflac\fP(1). +.IP "" +Stödda \fIflaggor\fP: +.RS +.TP +\fBdist=\fP\fIavstånd\fP +Ange \fIavståndet\fP för deltaberäkningen i byte. \fIAvstånd\fP måste varea +1\(en256. Standardvärdet är 1. +.IP "" +Till exempel, med \fBdist=2\fP och åtta byte indata A1 B1 A2 B3 A3 B5 A4 B7, +kommer utdata vara A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Andra flaggor" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Utelämna varningar och noteringar. Ange detta två gånger för att även +utelämna felmeddelandet. Denna flagga har ingen påverkan på +slutstatusen. Det vill säga, även om en varning utelämnades kommer +slutstatusen fortfarandeindikera att en varning gavs. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Var utförlig. Om standard fel är kopplat till en terminal kommer \fBxz\fP visa +en förloppsmätare. Att ange \fB\-\-verbose\fP två gånger kommer ge än mer +utförlig utmatning. +.IP "" +Förloppsmätaren visar följande information: +.RS +.IP \(bu 3 +Procent färdigt visas om storleken på indatafilen är känd. Det vill säga, +procentsatsen kan inte visas i rör. +.IP \(bu 3 +Mängd komprimerad data som producerats (komprimering) eller konsumerats +(dekomprimering). +.IP \(bu 3 +Mängd okomprimerad data som konsumerats (komprimering) eller producerats +(dekomprimering). +.IP \(bu 3 +Komprimeringsförhållande, vilket beräknas genom att dividera mängden +komprimerad data bearbetad så lång med mängde okomprimerad data bearbetad så +långt. +.IP \(bu 3 +Kompressions eller dekompressionshastighet. Detta mäts som mängden +okomprimerad data konsumerad (komprimering) eller producerad +(dekomprimering) per sekund. Det visas efter att några sekunder har gåt +efter att \fBxz\fP började bearbeta filen. +.IP \(bu 3 +Förfluten tid på formatet MM:SS eller H:MM:SS. +.IP \(bu 3 +Beräknad återstående tid visas endast när storleken på indatafilen är känd +och några sekunder redan gått efter att \fBxz\fP började bearbeta filen. Tiden +visas i ett mindre precist format vilket aldrig har några kolon, till +exempel, 2 min 30 s. +.RE +.IP "" +När standard fel inte är en terminal kommer \fB\-\-verbose\fP göra att \fBxz\fP +skriver filnamnet, komprimerad storlek, okomprimerad storlek, +komprimeringsförhållande och möjligen även hastigheten och den förlupna +tiden på en enda rad till standard fel efter att ha komprimerat eller +dekomprimerat filen. Hastigheten och den förlupna tiden inkluderas endast +när åtgärden tog åtminstone några sekunder. Om åtgärden inte slutfördes, +till exempel för att användaren avbröt, skrivs även den fullbordade +procentsatsen om storleken på indatafilen är känd. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Sätt inte slutstatus till 2 även om ett tillstånd som är värt en varning +upptäcktes. Denna flagga påverkar inte utförlighetsnivån, allts måste både +\fB\-\-quiet\fP och \fB\-\-no\-warn\fP användas för att inte visa varningar och för att +inte ändra slutstatusen. +.TP +\fB\-\-robot\fP +Skriv meddelanden i maskinläsbart form. Detta är avsett att förenkla att +skriva framändar som vill använda \fBxz\fP istället för liblzma, vilken kan +vara fallet i olika skript. Utdatan med denna flagga aktiverad är avsedd att +vara stabil mellan utgåvor av \fBxz\fP. Se avsnitett \fBROBOTLÄGE\fP för detaljer. +.TP +\fB\-\-info\-memory\fP +Visa, på mänskligt läsbar form, hur mycket fysiskt minne (RAM) och hur många +processortrådar \fBxz\fP tror att systemet har och gränserna för +minnesanvändning vid komprimering och dekomprimering, och avsluta. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande som beskriver de vanligast använda flaggorna, och +avsluta. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Visa ett hjälpmeddelande som beskriver alla funktioner i \fBxz\fP, och avsluta +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret för \fBxz\fP och liblzma i mänskligt läsbar form. För att +få maskinläsbar utdata, ange \fB\-\-robot\fP före \fB\-\-version\fP. +. +.SH ROBOTLÄGE +Robotläget aktiveras med flaggan \fB\-\-robot\fP. Det gör att utdata från \fBxz\fP +är enklare att tolka av andra program. För närvarande stödjs \fB\-\-robot\fP +endast tillsammans med \fB\-\-list\fP, \fB\-\-filters\-help\fP, \fB\-\-info\-memory\fP och +\fB\-\-version\fP. Den kommer att stödjas för komprimering och dekomprimering i +framtiden. +. +.SS Listläge +\fBxz \-\-robot \-\-list\fP använder tab\-separerad utmatning. Första kolumnen av +varje rad har en sträng som indikerar typen av informationen som finns på +den raden: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Detta är alltid första raden när en fil börjar listas. Den andra kolumen på +raden är filnamnet. +.TP +\fBfile\fP +Denna rad innehåller övergripande information om \fB.xz\fP\-filen. Denna rad +skrivs alltid efter raden \fBname\fP. +.TP +\fBstream\fP +Denna radtyp används endast när \fB\-\-verbose\fP angetts. Det finns lika många +\fBstream\fP\-rader som det finns strömmar i \fB.xz\fP\-filen. +.TP +\fBblock\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts. Det finns lika många +\fBblock\fP\-rader som det finns block i \fB.xz\fP\-filen. \fBblock\fP\-rader visas +efter alla \fBstream\fP\-raderna; olika radtyper blandas inte. +.TP +\fBsummary\fP +Denna radtyp används bara när \fB\-\-verbose\fP angetts två gånger. Denna rad +skrivs eefter alla \fBblock\fP\-rader. Liksom raden \fBfile\fP inenhåller raden +\fBsummary\fP övergripande information om \fB.xz\fP\-filen. +.TP +\fBtotals\fP +Denna rad är alltid den allra sista raden i listutmatningen. Den visar det +totala antalen och storlekarna. +.PP +Kolumnerna på \fBfile\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Antalet strömmar i filen +.IP 3. 4 +Totalt antal block i strömmarna +.IP 4. 4 +Komprimerad storlek på filen +.IP 5. 4 +Okomprimerad storlek på filen +.IP 6. 4 +Komprimeringsförhållande, till exempel \fB0.123\fP. Om förhållandet är över +9.999 visas tre bindestreck (\fB\-\-\-\fP) istället för förhållandet. +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Kommaseparerad lista med integritetskontrollnamn. Följande strängar används +för de kända kontrolltyperna: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP och +\fBSHA\-256\fP. För okända kontrolltyper används \fBUnknown\-\fP\fIN\fP, där \fIN\fP är +kontroll\-ID:t som ett decimalt nummer (en eller två siffror). +.IP 8. 4 +Total storlek på strömutfyllnad i filen +.RE +.PD +.PP +Kolumnerna på \fBstream\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Strömnummer (den första strömmen är 1) +.IP 3. 4 +Antal block i strömmen +.IP 4. 4 +Komprimerat startavstånd +.IP 5. 4 +Okomprimerat startavstånd +.IP 6. 4 +Komprimerad storlek (inkluderar inte strömutfyllnad) +.IP 7. 4 +Okomprimerad storlek +.IP 8. 4 +Komprimeringsförhållande +.IP 9. 4 +Namnet på integritetskontrollen +.IP 10. 4 +Storleken på strömutfyllnad +.RE +.PD +.PP +Kolumnerna på \fBblock\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Numret på strömmen som innehåller detta block +.IP 3. 4 +Blocknummer relativt början på strömmen (det första blocket är 1) +.IP 4. 4 +Blocknummer relativt början på filen +.IP 5. 4 +Komprimerat startavstånd relativt början av filen +.IP 6. 4 +Okomprimerat startavstånd relativt början av filen +.IP 7. 4 +Total komprimerad storlek på blocket (inkluderar huvuden) +.IP 8. 4 +Okomprimerad storlek +.IP 9. 4 +Komprimeringsförhållande +.IP 10. 4 +Namnet på integritetskontrollen +.RE +.PD +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBblock\fP\-raderna. Dessa visas inte med bara ett \fB\-\-verbose\fP, eftersom det +för att få fram denna information krävs många sökningar och kan därmed vara +långsamt: +.PD 0 +.RS +.IP 11. 4 +Värdet på integritetskontrollen hexadecimalt +.IP 12. 4 +Blockhuvudstorlek +.IP 13. 4 +Blockflaggor: \fBc\fP indikerar att komprimerad storlek finns, och \fBu\fP +indikerar att okomprimerad storlek finns. Om flaggan inte är satt visas ett +bindestreck (\fB\-\fP) istället för att hålla stränglängden fast. Nya flaggor +kan läggas till i slutet av strängen i frmtiden. +.IP 14. 4 +Storlek på den faktiska komprimerade datan i blocket (detta utelämnar +blockhuvud, blockutfyllnad och kontrollfält) +.IP 15. 4 +Mängd minne (i byte) som behövs för att dekomprimera detta block med denna +version av \fBxz\fP +.IP 16. 4 +Filterkedja. Observera att de flesta av flaggorna som användes vid +komprimeringstillfället inte kan vara kända, eftersom endat de flaggor som +behövs för dekomprimering lagras i \fB.xz\fP\-huvudet. +.RE +.PD +.PP +Kolumnerna på \fBsummary\fP\-raderna: +.PD 0 +.RS +.IP 2. 4 +Mängd minne (i byte) som behövs för att dekomprimera denna fil med denna +version av \fBxz\fP +.IP 3. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Kolumnerna på \fBtotals\fP\-raden: +.PD 0 +.RS +.IP 2. 4 +Antal strömmar +.IP 3. 4 +Antal block +.IP 4. 4 +Komprimerad storlek +.IP 5. 4 +Okomprimerad storlek +.IP 6. 4 +Genomsnittligt komprimeringsförhållande +.IP 7. 4 +Kommaseparerad lista med integritetskontrollnamn som fanns i filerna +.IP 8. 4 +Strömutfyllnadsstorlek +.IP 9. 4 +Antal filer. Denna finns här för att hålla ordningen av de tidigare +kolumnerna desamma som på \fBfile\fP\-rader. +.PD +.RE +.PP +Om \fB\-\-verbose\fP angavs två gånger inkluderas ytterligare kolumner på +\fBtotals\fP\-raden: +.PD 0 +.RS +.IP 10. 4 +Maximal mängd minne (i byte) som behövs för att dekomprimera filerna med +denna version av \fBxz\fP +.IP 11. 4 +\fByes\fP eller \fBno\fP som indikerar om alla blockhuvuden både har komprimerad +storlek och okomprimerad storlek i sig +.PP +\fIFrån\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Minsta version av \fBxz\fP som krävs för att dekomprimera filen +.RE +.PD +.PP +Framtida versioner kan lägga till fler radtyper och fler kolumner kan läggas +til på de befintliga radtyperna, men de befintliga kolumnerna kommmer inte +ändras. +. +.SS Filterhjälp +\fBxz \-\-robot \-\-filters\-help\fP skriver ut de filter som stödjs i följande +format: +.PP +\fIfilter\fP\fB:\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>,\fP\fIflagga\fP\fB=<\fP\fIvärde\fP\fB>\fP… +.TP +\fIfilter\fP +Namn på filtret +.TP +\fIflagga\fP +Namn på en filterspecifik flagga +.TP +\fIvärde\fP +Numeriska \fIvärde\fPintervall ser ut som +\fB<\fP\fImin\fP\fB\-\fP\fImax\fP\fB>\fP. Sträng\fIvärdes\fP val visas inom \fB< >\fP och separerade med ett \fB|\fP\-tecken. +.PP +Varje filter skrivs på en egen rad. +. +.SS Minnesgränsinformation +\fBxz \-\-robot \-\-info\-memory\fP skriver en rad med flera tab\-separerade +kolumner: +.IP 1. 4 +Total mängd med fysiskt minne (RAM) i byte. +.IP 2. 4 +Minnesanvändningsgräns för komprimering i byte (\fB\-\-memlimit\-compress\fP). Ett +specialvärde \fB0\fP indikerar standardinställningen vilken för enkeltrådat +läge är detsamma som ingen gräns. +.IP 3. 4 +Minnesanvändningsgräns för dekomprimering i byte +(\fB\-\-memlimit\-decompress\fP). Ett specialvärde \fB0\fP indikerar +standdartinställningen vilken för enkeltrådat läge är detsamma som ingen +gräns. +.IP 4. 4 +Från \fBxz\fP 5.3.4alpha: Minnesanvändningen för multitrådad dekomprimering i +byte (\fB\-\-memlimit\-mt\-decompress\fP). Detta är aldrig noll eftersom ett +systemspecifikt standardvärde som visas i kolumn 5 används om ingen gräns +har angivits uttryckligen. Detta är heller aldrig större än värdet i kolumn +3 även om ett större värde har angivits med \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Från \fBxz\fP 5.3.4alpha: Ett systemspecifikt standardgräns för +minnesanvändning som används för att begränsa antalet trådar vid +komprimering med ett automatiskt antal trådar (\fB\-\-threads=0\fP) och ingen +gräns för minnesanvändning har angivits (\fB\-\-memlimit\-compress\fP). Detta +används även som standardvärdet på \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Från \fBxz\fP 5.3.4alpha: antal tillgängliga processortrådar. +.PP +I framtiden kan utdata från \fBxz \-\-robot \-\-info\-memory\fP ha fler kolumner, +men aldrig mer än en rad. +. +.SS Version +\fBxz \-\-robot \-\-version\fP skriver versionsnumret på \fBxz\fP och liblzma i +följande format: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Huvudversion. +.TP +\fIYYY\fP +Underversion. Jämna nummer är stabila. Udda nummer är alfa\- eller +betaversioner. +.TP +\fIZZZ\fP +Rättningsnivå för stabila utgåvor eller bara en räknare för +utvecklingsutgåvor. +.TP +\fIS\fP +Stabilitet. 0 är alfa, 1 beta beta och 2 är stabil. \fIS\fP skall alltid vara +2 när \fIYYY\fP är jämnt. +.PP +\fIXYYYZZZS\fP är samma på båda raderna om \fBxz\fP och liblzma kommer från samma +utgåva av XZ Utils. +.PP +Exempel: 4.999.9beta är \fB49990091\fP och 5.0.0 är \fB50000002\fP. +. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt är bra. +.TP +\fB1\fP +Ett fel uppstod. +.TP +\fB2\fP +Något värt en varning uppstod, men inga faktiska fel uppstod. +.PP +Noteringar (inte varningar eller fel) som skrivs på standard fel påverkar +inte slutstatusen. +. +.SH MILJÖ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP tolkar mellanrumsseparerade listor av flaggor från miljövariablerna +\fBXZ_DEFAULTS\fP och \fBXZ_OPT\fP, i den ordningen, före flaggorna på +kommandoraden. Observera att endast flaggor tolkas från miljövariablerna; +alla andra argument än flaggor ignoreras tyst. Tolkningen görs med +\fBgetopt_long\fP(3) vilket även används för kommandoradsargumenten. +.PP +\fBVarning:\fP genom att sätta dessa miljövariabler ändrar man i praktiken +program och skript som kör \fBxz\fP. för det mesta är set säkert att sätta +begränsningar på minnesanvändning, antal trådar och komprimeringsflaggor via +miljövariablerna. Några flaggor kan dock göra att skript går sönder. Ett +uppenbart exempel är \fB\-\-help\fP vilket gör att \fBxz\fP visar en hjälptext +istället för att komprimera eller dekomprimera en fil. Mer subtila exempel +är \fB\-\-quiet\fP och \fB\-\-verbose\fP. I många fall fungerar det bra att aktivera +en förloppsindikator med \fB\-\-verbose\fP, men i några fall skapar de extra +meddelandena problem. Utförlighetsnivån påverkar även beteendet hos +\fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Användarspecifika eller systemspecifika standardflaggor. Typiskt sätts detta +i ett initieringsskript för skal för att aktivera \fBxz\fP:s begränsning av +minnesanvändning som standard eller att ställa in ett standardantal +trådar. Med undantag för skalinitieringsskript och liknande specialfall +skall skript aldrig sätta eller ta bort \fBXZ_DEFAULTS\fP. +.TP +\fBXZ_OPT\fP +Detta är för att skicka flaggor till \fBxz\fP när det inte är möjligt att sätta +flaggorna direkt på kommandoraden för \fBxz\fP. Detta är fallet när \fBxz\fP körs +av ett skript eller verktyg, till exempel, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf apa.tar.xz apa\fR +.fi +.RE +.RE +.IP "" +Skript kan använda \fBXZ_OPT\fP, till exempel, för att sätta skriptspecifika +standardflaggor för komprimering. Det rekommenderas fortfarande att tillåta +användaren att åsidosätta \fBXZ_OPT\fP om det är rimligt. Till exempel, i +\fBsh\fP(1)\-skript kan man använda något i still med detta: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "KOMPATIBILITET MED LZMA UTILS" +Kommandoradssyntaxen för \fBxz\fP är praktiskt taget en utökning av \fBlzma\fP, +\fBunlzma\fP och \fBlzcat\fP så som de kommer från LZMA Utils 4.32.x. I de flesta +fall, är det möjligt att ersätta LZMA Utils med XZ Utils utan att göra +sönder befintliga skript. Det finns dock några inkompatibiliteter, vilka +ibland kan orsaka problem. +. +.SS "Komprimeringens förinställda nivåer" +Numreringen av förinställda nivåer för komprimering är inte identiska i +\fBxz\fP och LZMA Utils. Den viktigaste skillnade är hur lexikonstorlekar +avbildas till olika förinställningar. Lexikonstorleken är i stort sett lika +med dekomprimerarens minnesanvändning. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils +\-0;256 KiB;N/A +\-1;1 MiB;64 KiB +\-2;2 MiB;1 MiB +\-3;4 MiB;512 KiB +\-4;4 MiB;1 MiB +\-5;8 MiB;2 MiB +\-6;8 MiB;4 MiB +\-7;16 MiB;8 MiB +\-8;32 MiB;16 MiB +\-9;64 MiB;32 MiB +.TE +.RE +.PP +Lexikonstorlekens skillnader påverkar komprimerarens minnesanvändning också, +men det finns några andra skillnader mellan LZMA Utils och XZ Utils, vilket +gör skillnaden ännu större: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Nivå;xz;LZMA Utils 4.32.x +\-0;3 MiB;N/A +\-1;9 MiB;2 MiB +\-2;17 MiB;12 MiB +\-3;32 MiB;12 MiB +\-4;48 MiB;16 MiB +\-5;94 MiB;26 MiB +\-6;94 MiB;45 MiB +\-7;186 MiB;83 MiB +\-8;370 MiB;159 MiB +\-9;674 MiB;311 MiB +.TE +.RE +.PP +Standardförinställningsninvån i LZMA Utils är \fB\-7\fP medan i XZ Utils är den +\fB\-6\fP, så båda använder ett 8 MiB lexikon som standard. +. +.SS "Strömmade visavi icke strömmade .lzma\-filer" +Den ikomprimerade storleken på filen kan lagras i huvudet i \fB.lzma\fP. LZMA +Utils gör det när den komprimerar normala filer. Alternativet är att markera +att den okomprimerade storleken är okänd och använda en markör för lastslut +för att indikera var dekomprimeraren skall stanna. LZMA Utils använder denna +metod när den okomprimerade storleken inte är känd, vilket är fallet, till +exempel, i rör. +.PP +\fBxz\fP stödjer dekomprimering av \fB.lzma\fP\-filer med eller utan markör för +lastslut, men alla \fB.lzma\fP filer som skapas av \fBxz\fP kommer använda markör +för lastslut och ha den okomprimerade storleken markerad som okänd i +\&\fB.lzma\fP\-huvudet. Detta kan bli ett problem i några ovanliga fall. Till +exempel kan en \fB.lzma\fP\-dekomprimerare i en inbäddad enhet fungera endast +med filer som har en känd okomprimerad storlek. Om man stöter på detta +problem behöver man använda LZMA Utils eller LZMA SDK för att skapa +\&\fB.lzma\fP\-filer med känd okomprimerad storlek. +. +.SS "Ej stödda .lzma\-filer" +Formatet \fB.lzma\fP tillåter värden på \fIlc\fP upp till 8, och värden på \fIlp\fP +upp till 4. LZMA Utils kan dekomprimera filer med godtyckliga \fIlc\fP och +\fIlp\fP, men skapar alltid filer med \fBlc=3\fP och \fBlp=0\fP. Att skapa filer med +andra \fIlc\fP och \fIlp\fP är möjligt med \fBxz\fP och med LZMA SDK. +.PP +Implementationen av LZMA1\-filtret i liblzma kräver att summan av \fIlc\fP och +\fIlp\fP inte överstiger 4. Alltså, \fB.lzma\fP\-filer, vilka överstiger denna +gräns, kan inte dekomprimeras med \fBxz\fP. +.PP +LZMA Utils skapar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP +(en potens av 2) men godtar filer med godtycklig lexikonstorlek. liblzma +godtar endast \fB.lzma\fP\-filer som har en lexikonstorlek på 2^\fIn\fP eller +2^\fIn\fP + 2^(\fIn\fP\-1). Detta är för att minska falska positiva vid detektering +av \fB.lzma\fP\-filer. +.PP +Dessa begränsningar bör inte vara ett problem i praktiken, eftersom +praktiskt taget alla \fB.lzma\fP\-filer har komprimerats med inställningar som +liblzma kommer godta. +. +.SS "Avslutande skräp" +Vid dekomprimering ignorerar LZMA Utils tyst allting efter den första +\&\fB.lzma\fP\-strömmen. I de flesta situationer är detta fel. Detta betyder även +att LZMA Utils inte stödjer dekomprimering av konkatenerade \fB.lzma\fP\-filer. +.PP +Om det finns data kvar efter den första \fB.lzma\fP\-strömmen betraktar \fBxz\fP +filen som trasig om inte \fB\-\-single\-stream\fP användes. Detta kan göra sönder +obskyra skript vilka har antagit att avslutande skräp ignoreras. +. +.SH NOTERINGAR +. +.SS "Den komprimerade utdatan kan variera" +Den exakta komprimerade utdatan som produceras från samma okomprimerade +indatafil kan variera mellan versioner av XZ Utils även om +komprimeringsflaggorna är identiska. Detta beror på att kodaren kan +förbättras (snabbare eller bättre komprimering) utan att påverka +filformatet. Utdatan kan variera även mellan olika byggen av samma version +av XZ Utils, om olika byggflaggor används. +.PP +Ovanstående betyder att när väl \fB\-\-rsyncable\fP har implementerats kommer +inte nödvändigtvis de resulterande filerna vara rsync\-bara om inte både +gamla och nya filer har komprimerats med samma version av xz. Detta problem +kan lösas om en del av kodarimplementeringen fryses för att hålla rsync\-bar +utdata stabil mellan xz\-versioner. +. +.SS "Inbäddade .xz\-dekomprimerare" +Inbäddade implementationer av \fB.xz\fP\-dekomprimerare som XZ Embedded stödjer +inte nödvändigtvis filer som skapas med andra typer av +integritets\fIkontroll\fP än \fBnone\fP och \fBcrc32\fP. Eftersom standardvärdet är +\fB\-\-check=crc64\fP måste man använda \fB\-\-check=none\fP eller \fB\-\-check=crc32\fP +när filer skapas för inbäddade system. +.PP +Utanför inbäddade system stödjer alla dekomprimerare av \fB.xz\fP\-format alla +typerna av \fIkontroller\fP, eller åtminstone kan de dekomprimera filern utan +att verifiera integritetskontrollen om den specifika \fIkontrollen\fP inte +stödjs. +.PP +XZ Embedded stödjer BCJ\-filter, men endast med standard startavstånd. +. +.SH EXEMPEL +. +.SS Grundläggande +Komprimera filen \fIapa\fP till \fIapa.xz\fP med standardkomprimeringsnivån +(\fB\-6\fP), och ta bort \fIapa\fP om komprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz apa\fR +.fi +.RE +.PP +Dekomprimera \fIbepa.xz\fP till \fIbepa\fP och ta inte bort \fIbepa.xz\fP även om +dekomprimeringen lyckas: +.RS +.PP +.nf +\f(CRxz \-dk bepa.xz\fR +.fi +.RE +.PP +Skapa \fIcepa.tar.xz\fP med förinställningen \fB\-4e\fP (\fB\-4 \-\-extreme\fP), vilket +är långsammare än standardvärdet \fB\-6\fP, men behöver mindre minne till +komprimering och dekomprimering (48\ MiB respektive 5\ MiB): +.RS +.PP +.nf +\f(CRtar cf \- cepa | xz \-4e > cepa.tar.xz\fR +.fi +.RE +.PP +En blandning av komprimerade och okomprimerade filer kan dekomprimeras till +standard ut med ett enda kommando: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Parallell komprimering av många filer" +På GNU och *BSD kan \fBfind\fP(1) och \fBxargs\fP(1) användas för att +parallellisera komprimeringen av många filer: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Flaggan \fB\-P\fP till \fBxargs\fP(1) anger antalet parallella \fBxz\fP\-processer. Det +bästa värdet till flaggan \fB\-n\fP beror på hur många filer det finns som skapp +komprimeras. Om det bara finns några stycken filer bör värdet förmodigen +vara 1; med tiotusentals filer kan 100 eller mer vara lämpligt för att +reducera antalet \fBxz\fP\-processer som \fBxargs\fP(1) kommer att skapa. +.PP +Flaggan \fB\-T1\fP till \fBxz\fP finns för att tvinga den till enkeltrådsläge, +eftersom \fBxargs\fP(1) används för att styra mängden parallellisering. +. +.SS Robotläge +Beräkna hur många byt som har sparats totalt efter komprimering av flera +filer: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Ett skript kan vilja veta att det använder en tillräckligt ny +\fBxz\fP. Följande \fBsh\fP(1)\-skript kontrollerar att versionsnumret för +verktyget \fBxz\fP är åtminstone 5.0.0. Denna metod är kompatibel med gamla +betaversioner, vilka inte stödde flaggan \fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Din xz är för gammal." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Ange en gräns för minnesanvändning för dekomprimering med \fBXZ_OPT\fP, men om +en gräns redan har satts, öka den inte: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Anpassade komprimerarfilterkedjor" +Den enklaste användningen av anpassade filterkedjor är att anpassa en +LZMA2\-förinställning. Detta kan vara användbart eftersom förinställningarna +endast täcker en delmängd av de potentiellt användbara kombinationerna av +komprimeringsinställningar. +.PP +Kolumnerna CompCPU i tabellerna från beskrivningen av flaggorna options +\fB\-0\fP ... \fB\-9\fP och \fB\-\-extreme\fP är användbara vid anpassning av +LZMA2\-förinställningar. Här är de relevanta delarna samlade från dessa två +tabeller: +.RS +.PP +.TS +tab(;); +c c +n n. +Förinställning;KompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Om man vet att en fil behöver ett rätt stort lexikon (till exempel, 32\ MiB) +för att komprimeras bra, men man vill komprimera den snabbare än \fBxz \-8\fP +skulle gjort kan en förinställning med ett lågt värde på CompCPU (till +exempel, 1) ändras till att använda ett större lexikon: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB apa.tar\fR +.fi +.RE +.PP +Med vissa filer kan ovanstående kommando vara snabbare än \fBxz \-6\fP samtidigt +som det komprimerar betydligt bättre. Dock måste det påpekas att endast +några filer drar fördel av ett stort lexikon samtidigt som värdet CompCPU +hålls lågt. Den mest uppenbara situationen, är ett stort lexikon kan hälpa +till mycket, är ett arkiv som innehåller väldigt snarlika filer på åtmistone +några megabyte var. Lexikonstorleken måste vara signifikant större än någon +enskild fil för att låta LZMA2 dra full nytta av likheterna mellan på +varandra följande filer. +.PP +Om det går bra med väldigt hög minnesanvändning i komprimeraren och +dekomprimeraren, och filen som komprimeras är åtminstone flera hundra +megabyte, kan det vara användbart att använda ännu större lexikon än de 64 +MiB som \fBxz \-9\fP skulle använda: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB stor_apa.tar\fR +.fi +.RE +.PP +Att använda \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP) som i exemplet ovan kan vara +användbart för att se minnesbehoven för komprimeraren och +dekomprimeraren. Kom ihåg att använda ett större lexikon än storleken på den +okomprimerade filen är slöseri med minne, så ovanstående kommando är inte +användbart för små filer. +.PP +Ibland spelar inte dekomprimeringstiden någon roll, men dekomprimerarens +minnesanvändning måste hållas låg, till exempel för att göra det möjligt att +dekomprimera filen på ett inbäddat system. Följande kommando använder \fB\-6e\fP +(\fB\-6 \-\-extreme\fP) som en bas och sätter lexikonstorleken till bara 64\ KiB. Den resulterande filen kan dekomprimeras med XZ Embedded (det är därför +det finns \fB\-\-check=crc32\fP) som använder ungerfär 100\ KiB minne. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB apa\fR +.fi +.RE +.PP +Om man vill krama ur så många byte som möjligt kan justering av antalet +literala kontextbitar (\fIlc\fP) och antalet positionsbitar (\fIpb\fP) ibland +hjälpa. Justering av antalet literala positionsbitar (\fIlp\fP) kan också +hjälpa, men vanligen är \fIlc\fP och \fIpb\fP viktigare. Till exempel innehåller +ett källkodsarkiv huvudsakligen US\-ASCII\-text, så något i stil med följande +kan ge aningen (som 0.1\ %) mindre fil än \fBxz \-6e\fP (försök även utan +\fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 källkod.tar\fR +.fi +.RE +.PP +Att använda ett annat filter tillsammans med LZMA2 kan förbättra +komprimeringen med vissa filtyper. Till exempel, för att komprimera ett +delat x86\-32\- eller x86\-64\-bibliotek med filtret x86 BCJ: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libapa.so\fR +.fi +.RE +.PP +Observera att ordningen på filterflaggorna spelar roll. Om \fB\-\-x86\fP anges +efter \fB\-\-lzma2\fP kommer \fBxz\fP avge ett fel, eftersom det inte kan vara något +filter efter LZMA2, och även för att filtret x86 BCJ inte kan användas som +det sista filtret i kedjan. +.PP +Deltafiltret tillsammans med LZMA2 gan ge bra resultat med +bitkartebilder. Det bör vanligen slå PNG, som har några mer avancerade +filter än enkla delta men använder Deflat för den faktiska komprimeringen. +.PP +Bilden måste sparas i okomprimerat format, till exempel som okomprimerad +TIFF. Avståndsparametern i Deltafiltret sätts till att motsvara natalet byte +per bildpunkt i bilden. Till exempel, 24\-bitars RGB bitkarta behöver +\fBdist=3\fP, och det är även bra att skicka \fBpb=0\fP till LZMA2 för att ge +plats för trebytejustering: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 apa.tiff\fR +.fi +.RE +.PP +Om flera bilder har lagts in i ett gemensamt arkiv (till exempel, \fB.tar\fP) +kommer Deltafiltret fungera på det också så länge alla bilder har samma +antal byte per bildpunkt. +. +.SH "SE ÄVEN" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +XZ Embedded: +.br +LZMA SDK: diff --git a/miniconda3/share/man/sv/man1/xzcmp.1 b/miniconda3/share/man/sv/man1/xzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..2d1516dcb59720f083abf68f8101c5de6fb19a89 --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzcmp.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzcmp, xzdiff, lzcmp, lzdiff — jämför komprimerade filer +. +.SH SYNOPSIS +\fBxzcmp\fP [\fIflagga…\fP] \fIfil1\fP [\fIfil2\fP] +.br +\fBxzdiff\fP \&… +.br +\fBlzcmp\fP \&… (FÖRÅLDRAT) +.br +\fBlzdiff\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzcmp\fP och \fBxzdiff\fP jämför det okomprimerade innehållet i två +filer. Okomprimerad data skickas till \fBcmp\fP(1) eller \fBdiff\fP(1) såvida inte +\fB\-\-help\fP eller \fB\-\-version\fP anges. +.PP +Om både \fIfil1\fP och \fIfil2\fP anges kan de vara okomprimerade filer eller +filer i format som \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) +eller \fBlz4\fP(1) kan dekomprimera. De nödvändiga dekomprimeringskommandona +avgörs från filnamnsändelsen på \fIfil1\fP och \fIfil2\fP. En fil med en okänd +ändelse antas antingen vara okomprimerad eller i ett format som \fBxz\fP(1) kan +dekomprimera. +.PP +Om endast ett filnamn anges måste \fIfil1\fP ha en ändelse med ett av de stödda +komprimeringsformaten och namnet på \fIfil2\fP antas vara \fIfil1\fP med +komprimeringsformatsändelsen borttagen. +.PP +Kommandona \fBlzcmp\fP och \fBlzdiff\fP finns för bakåtkompatibilitet med LZMA +Utils. De rekommenderas inte och kommer tas bort i en framtida version. +. +.SH SLUTSTATUS +Om ett dekomprimeringsfel uppstår är slutstatus \fB2\fP. Annars används +slutstatusen från \fBcmp\fP(1) respektive \fBdiff\fP(1). +. +.SH "SE ÄVEN" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzdec.1 b/miniconda3/share/man/sv/man1/xzdec.1 new file mode 100644 index 0000000000000000000000000000000000000000..63612b0c437ef25509d89f649853119c5e476786 --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzdec.1 @@ -0,0 +1,87 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 2024\-04\-08 Tukaani "XZ Utils" +.SH NAMN +xzdec, lzmadec \- Små .xz\- och .lzma\-dekomprimerare +.SH SYNOPSIS +\fBxzdec\fP [\fIflagga…\fP] [\fIfil…\fP] +.br +\fBlzmadec\fP [\fIflagga…\fP] [\fIfil…\fP] +.SH BESKRIVNING +\fBxzdec\fP är ett liblzma\-baserat verktyg endast för dekomprimering för \fB.xz\fP +(och endast \fB.xz\fP) filer. \fBxzdec\fP är avsett att fungera som en drop +in\-ersättning för \fBxz\fP(1) i de vanligaste situationerna där ett skript har +skrivits för att använda \fBxz \-\-decompress \-\-stdout\fP (och möjligen några +andra vanliga flaggor) för att dekomprimera \fB.xz\fP\-filer. \fBlzmadec\fP är +identisk med \fBxzdec\fP förutom att \fBlzmadec\fP stödjer \fB.lzma\fP\-filer istället +för \fB.xz\fP\-filer. +.PP +För att reducera storleken på det körbara programmet stödjer inte \fBxzdec\fP +multitrådning eller lokalisering, och läser inte flaggor från +miljövariablerna \fBXZ_DEFAULTS\fP eller \fBXZ_OPT\fP. \fBxzdec\fP stödjer inte att +visa mellanliggande förloppsinformation: att skicka \fBSIGINFO\fP till \fBxzdec\fP +gör ingenting, med att skicka \fBSIGUSR1\fP avslutar processen istället för att +visa förloppsinformation. +.SH FLAGGOR +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP stödjer endast +dekomprimering. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP skapar aldrig eller tar +aldrig bort några filer. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP skriver alltid +dekomprimerad data till standard ut. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Att ange detta en gång gör inget eftersom \fBxzdec\fP aldrig visar några +varningar eller noteringar. Att ange detta två gånger utelämnar +felmeddelanden. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Ignoreras för kompatibilitet med \fBxz\fP(1). \fBxzdec\fP använder aldrig +slutstatus 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Visa ett hjälpmeddelande och avsluta. +.TP +\fB\-V\fP, \fB\-\-version\fP +Visa versionsnumret på \fBxzdec\fP och liblzma. +.SH SLUTSTATUS +.TP +\fB0\fP +Allt gick bra. +.TP +\fB1\fP +Ett fel uppstod. +.PP +\fBxzdec\fP har inte några varningsmeddelanden så som \fBxz\fP(1) har, och därför +används aldrig slutstatusen 2 av \fBxzdec\fP. +.SH NOTERINGAR +Använd \fBxz\fP(1) istället för \fBxzdec\fP eller \fBlzmadec\fP för dagligt +bruk. \fBxzdec\fP och \fBlzmadec\fP är bara avsedda för situationer där det är +viktigt att ha en mindre dekomprimerare än den fullständiga \fBxz\fP(1). +.PP +\fBxzdec\fP och \fBlzmadec\fP är egentligen inte riktigt så små. Storleken kan +reduceras ytterligare genom att ta bort funktioner från liblzma vid +kompileringstidpunkten, men det skall normalt inte göras för körbara program +som distribueras i en typisk, inte inbäddad, distribution av +operativsystem. Om man behöver en verkligt liten \fB.xz\fP\-dekomprimerare skall +man överväga XZ Embedded. +.SH "SE ÄVEN" +\fBxz\fP(1) +.PP +XZ Embedded: diff --git a/miniconda3/share/man/sv/man1/xzdiff.1 b/miniconda3/share/man/sv/man1/xzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..2d1516dcb59720f083abf68f8101c5de6fb19a89 --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzdiff.1 @@ -0,0 +1,54 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzcmp, xzdiff, lzcmp, lzdiff — jämför komprimerade filer +. +.SH SYNOPSIS +\fBxzcmp\fP [\fIflagga…\fP] \fIfil1\fP [\fIfil2\fP] +.br +\fBxzdiff\fP \&… +.br +\fBlzcmp\fP \&… (FÖRÅLDRAT) +.br +\fBlzdiff\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzcmp\fP och \fBxzdiff\fP jämför det okomprimerade innehållet i två +filer. Okomprimerad data skickas till \fBcmp\fP(1) eller \fBdiff\fP(1) såvida inte +\fB\-\-help\fP eller \fB\-\-version\fP anges. +.PP +Om både \fIfil1\fP och \fIfil2\fP anges kan de vara okomprimerade filer eller +filer i format som \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) +eller \fBlz4\fP(1) kan dekomprimera. De nödvändiga dekomprimeringskommandona +avgörs från filnamnsändelsen på \fIfil1\fP och \fIfil2\fP. En fil med en okänd +ändelse antas antingen vara okomprimerad eller i ett format som \fBxz\fP(1) kan +dekomprimera. +.PP +Om endast ett filnamn anges måste \fIfil1\fP ha en ändelse med ett av de stödda +komprimeringsformaten och namnet på \fIfil2\fP antas vara \fIfil1\fP med +komprimeringsformatsändelsen borttagen. +.PP +Kommandona \fBlzcmp\fP och \fBlzdiff\fP finns för bakåtkompatibilitet med LZMA +Utils. De rekommenderas inte och kommer tas bort i en framtida version. +. +.SH SLUTSTATUS +Om ett dekomprimeringsfel uppstår är slutstatus \fB2\fP. Annars används +slutstatusen från \fBcmp\fP(1) respektive \fBdiff\fP(1). +. +.SH "SE ÄVEN" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzegrep.1 b/miniconda3/share/man/sv/man1/xzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzegrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzfgrep.1 b/miniconda3/share/man/sv/man1/xzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzfgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzgrep.1 b/miniconda3/share/man/sv/man1/xzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf4653d6c7aed44d0f7fc53205f6d44e080f3ddc --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzgrep.1 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzgrep — sök i eventuellt komprimerade filer efter mönster +. +.SH SYNOPSIS +\fBxzgrep\fP [\fIflagga…\fP] [\fImönsterlista\fP] [\fIfil…\fP] +.br +\fBxzegrep\fP \&… +.br +\fBxzfgrep\fP \&… +.br +\fBlzgrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzegrep\fP \&… (FÖRÅLDRAT) +.br +\fBlzfgrep\fP \&… (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzgrep\fP anropar \fBgrep\fP(1) på det okomprimerade innehållet i +filerna. Formaten på \fIfilerna\fP bestäms utgående från filnamnsändelsen. En +\fIfil\fP med en ändelse som stödjs av \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), +\fBlzop\fP(1), \fBzstd\fP(1) eller \fBlz4\fP(1) kommer att dekomprimeras; alla andra +filer antas vara okomprimerade. +.PP +Om inga \fIfiler\fP anges eller om \fIfil\fP är \fB\-\fP lästes standard in. När +standard in läses är de enda filerna som dekomprimeras de som stödjs av +\fBxz\fP(1). Andra filer antas redan vara i okomprimerad form. +.PP +De flesta \fIflaggor\fP till \fBgrep\fP(1) stödjs. Dock stödjs inte följande +flaggor: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIåtgärd\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIfil\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP är ett alias för \fBxzgrep \-E\fP. \fBxzfgrep\fP är ett alias för +\fBxzgrep \-F\fP. +.PP +Kommandona \fBlzgrep\fP, \fBlzegrep\fP och \fBlzfgrep\fP finns för +bakåtkompatibilitet med LZMA Utils. De rekommenderas inte och kommer tas +bort i en framtida version. +. +.SH SLUTSTATUS +.TP +0 +Åtminstone en matchning hittades från åtminstone en av infilerna. Inga fel +uppstod. +.TP +1 +Inga matchningar hittades i någon av infilerna. Inga fel uppstod. +.TP +>1 +Ett eller flera fel uppstod. Det är okänt om några matchningar hittades. +. +.SH MILJÖ +.TP +\fBGREP\fP +Om \fBGREP\fP är satt till något icketomt värde används det istället för +\fBgrep\fP, \fBgrep \-E\fP respektive \fBgrep \-F\fP. +. +.SH "SE ÄVEN" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzless.1 b/miniconda3/share/man/sv/man1/xzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..52b702820a9af7788772d2a30896263902aa1042 --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzless.1 @@ -0,0 +1,47 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzless, lzless — visa xz\- eller lzma\-komprimerade (text)filer +.SH SYNOPSIS +\fBxzless\fP [\fIfil\fP…] +.br +\fBlzless\fP [\fIfil\fP…] (FÖRÅLDRAT) +.SH BESKRIVNING +\fBxzless\fP är ett filter som visar text från komprimerade filer i en +terminal. Filer som stödjs av \fBxz\fP(1) dekomprimeras; andra filer antas +redan vara i okomprimerad form. Om inga \fIfiler\fP ges läser \fBxzless\fP från +standard in. +.PP +\fBxzless\fP använder \fBless\fP(1) för att visa sin utdata. Till skillnad mot +\fBxzmore\fP kan inte dess val av bläddrare ändras genom att sätta en +miljövariabel. Kommandon är baserade på både \fBmore\fP(1) och \fBvi\fP(1) och +tillåter förflytting fram och tillbaka samt sökning. Se manualen \fBless\fP(1) +för mer information. +.PP +Kommandot som heter \fBlzless\fP finns för bakåtkompatibilitet med LZMA +Utils. Det rekommenderas inte och kommer tas bort i en framtida version. +.SH MILJÖ +.TP +\fBLESSMETACHARS\fP +En lista på tecken som är speciella för skalet. Sätts av \fBxzless\fP om den +inte redan är satt i miljön. +.TP +\fBLESSOPEN\fP +Satt till en kommandorad för att köra dekomprimeraren \fBxz\fP(1) för +förbehandling av infiler till \fBless\fP(1). +.SH "SE ÄVEN" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/sv/man1/xzmore.1 b/miniconda3/share/man/sv/man1/xzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..b5bb68d4df784fe5c3fcbdf884e0667ee9fc791e --- /dev/null +++ b/miniconda3/share/man/sv/man1/xzmore.1 @@ -0,0 +1,48 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Swedish translation of xz-man +.\" Göran Uddeborg , 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 2025\-03\-06 Tukaani "XZ Utils" +.SH NAMN +xzmore, lzmore — visa xz\- eller lzma\-komprimerade (text)filer +. +.SH SYNOPSIS +\fBxzmore\fP [\fIfil\fP…] +.br +\fBlzmore\fP [\fIfil\fP…] (FÖRÅLDRAT) +. +.SH BESKRIVNING +\fBxzmore\fP visar text från komprimerade filer i en terminal med användning av +\fBmore\fP(1). Filer som stödjs av \fBxz\fP(1) dekomprimeras; andra filer antas +redan vara i okomprimerad form. Om inga \fIfiler\fP ges läser \fBxzmore\fP från +standard in. Se manualen för \fBmore\fP(1) för tangentbordskommandona. +.PP +Observera att det kanske inte är möjligt att rulla baklänges, beroende på +implementationen av \fBmore\fP(1). Detta är för att \fBxzmore\fP använder ett rör +för att skicka dekomprimerad data till \fBmore\fP(1). \fBxzless\fP(1) använder +\fBless\fP(1) vilken ger mer avancerade funktioner. +.PP +Kommandot \fBlzmore\fP finns för bakåtkompatibilitet med LZMA Utils. Det +rekommenderas inte och kommer tas bort i en framtida version. +. +.SH MILJÖ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Om \fBPAGER\fP är satt används dess värde som bläddrare istället för +\fBmore\fP(1). +. +.SH "SE ÄVEN" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzcat.1 b/miniconda3/share/man/uk/man1/lzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzcat.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/lzcmp.1 b/miniconda3/share/man/uk/man1/lzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..0dd388c06a0fd2c32b4164b145f89739fe369a42 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzcmp.1 @@ -0,0 +1,56 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzcmp, xzdiff, lzcmp, lzdiff — порівняння стиснених файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzcmp\fP [\fIпараметр...\fP] \fIфайл1\fP [\fIфайл2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРІЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzcmp\fP і \fBxzdiff\fP порівнюють нестиснені дані двох файлів. Нестиснені дані +та параметри буде передано \fBcmp\fP(1) або \fBdiff\fP(1), якщо не вказано +\fB\-\-help\fP або \fB\-\-version\fP. +.PP +Якщо вказано одразу \fIфайл1\fP і \fIфайл2\fP, це можуть бути нестиснені файли або +файли у форматах, які може бути розпаковано за допомогою \fBxz\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1). Потрібні +команди розпаковування визначаються з суфіксів назв файлів \fIфайл1\fP і +\fIфайл2\fP. Файли із невідомими програмі суфіксами вважатимуться або +нестисненими або такими, що мають формат, дані у якому може розпаковувати +\fBxz\fP(1). +.PP +Якщо вказано лише одну назву файла, \fIфайл1\fP повинен мати суфікс +підтримуваного формату стискання, а назвою \fIфайл2\fP має бути назва \fIфайл1\fP +з вилученим суфіксом формату стискання. +.PP +Працездатність команд \fBlzcmp\fP і \fBlzdiff\fP забезпечено для зворотної +сумісності із LZMA Utils. Ці команди вважаються застарілими, їх буде +вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +Якщо станеться помилка розпаковування, станом виходу буде \fB2\fP. Інакше, +станом виходу буде \fBcmp\fP(1) або буде використано \fBdiff\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzdiff.1 b/miniconda3/share/man/uk/man1/lzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..0dd388c06a0fd2c32b4164b145f89739fe369a42 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzdiff.1 @@ -0,0 +1,56 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzcmp, xzdiff, lzcmp, lzdiff — порівняння стиснених файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzcmp\fP [\fIпараметр...\fP] \fIфайл1\fP [\fIфайл2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРІЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzcmp\fP і \fBxzdiff\fP порівнюють нестиснені дані двох файлів. Нестиснені дані +та параметри буде передано \fBcmp\fP(1) або \fBdiff\fP(1), якщо не вказано +\fB\-\-help\fP або \fB\-\-version\fP. +.PP +Якщо вказано одразу \fIфайл1\fP і \fIфайл2\fP, це можуть бути нестиснені файли або +файли у форматах, які може бути розпаковано за допомогою \fBxz\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1). Потрібні +команди розпаковування визначаються з суфіксів назв файлів \fIфайл1\fP і +\fIфайл2\fP. Файли із невідомими програмі суфіксами вважатимуться або +нестисненими або такими, що мають формат, дані у якому може розпаковувати +\fBxz\fP(1). +.PP +Якщо вказано лише одну назву файла, \fIфайл1\fP повинен мати суфікс +підтримуваного формату стискання, а назвою \fIфайл2\fP має бути назва \fIфайл1\fP +з вилученим суфіксом формату стискання. +.PP +Працездатність команд \fBlzcmp\fP і \fBlzdiff\fP забезпечено для зворотної +сумісності із LZMA Utils. Ці команди вважаються застарілими, їх буде +вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +Якщо станеться помилка розпаковування, станом виходу буде \fB2\fP. Інакше, +станом виходу буде \fBcmp\fP(1) або буде використано \fBdiff\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzegrep.1 b/miniconda3/share/man/uk/man1/lzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzegrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzfgrep.1 b/miniconda3/share/man/uk/man1/lzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzfgrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzgrep.1 b/miniconda3/share/man/uk/man1/lzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzgrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzless.1 b/miniconda3/share/man/uk/man1/lzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..c3b275d0dcadddd3e60054103f9c2a77a4eec341 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzless.1 @@ -0,0 +1,49 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzless, lzless — перегляд стиснених xz або lzma (текстових) файлів +.SH "КОРОТКИЙ ОПИС" +\fBxzless\fP [\fIфайл\fP...] +.br +\fBlzless\fP [\fIфайл\fP...] (ЗАСТАРІЛО) +.SH ОПИС +\fBxzless\fP є фільтром, який показує текст зі стиснених файлів у +терміналі. Файли, підтримку обробки яких передбачено у \fBxz\fP(1), буде +розпаковано; інші файли вважатимуться нестисненими. Якщо не вказано жодного +\fIфайла\fP, \fBxzless\fP читатиме дані зі стандартного джерела вхідних даних. +.PP +Для показу виведених даних \fBxzless\fP використовує \fBless\fP(1). На відміну від +\fBxzmore\fP, вибір програми для поділу на сторінки не можна змінити за +допомогою змінної середовища. Команди засновано на \fBmore\fP(1) і \fBvi\fP(1). За +допомогою команд можна просуватися назад і вперед даними та шукати дані. Щоб +дізнатися більше, ознайомтеся із підручником з \fBless\fP(1). +.PP +Команду \fBlzless\fP реалізовано для забезпечення зворотної сумісності з LZMA +Utils. Ця команда вважається застарілою, її буде вилучено у майбутній версії +комплекту програм. +.SH СЕРЕДОВИЩЕ +.TP +\fBLESSMETACHARS\fP +Список символів, які є особливими символами командної +оболонки. Встановлюється \fBxzless\fP, якщо його ще не встановлено у +середовищі. +.TP +\fBLESSOPEN\fP +Має значення рядка команди для виклику засобу розпаковування \fBxz\fP(1) для +обробки вхідних файлів \fBless\fP(1). +.SH "ДИВ. ТАКОЖ" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzma.1 b/miniconda3/share/man/uk/man1/lzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzma.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/lzmadec.1 b/miniconda3/share/man/uk/man1/lzmadec.1 new file mode 100644 index 0000000000000000000000000000000000000000..85a82215945dbd97edde051df4a2009126bc4b21 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzmadec.1 @@ -0,0 +1,85 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 "8 квітня 2024 року" Tukaani "XZ Utils" +.SH НАЗВА +xzdec, lzmadec — невеличкі розпакувальники .xz і .lzma +.SH "КОРОТКИЙ ОПИС" +\fBxzdec\fP [\fIпараметр...\fP] [\fIфайл...\fP] +.br +\fBlzmadec\fP [\fIпараметр...\fP] [\fIфайл...\fP] +.SH ОПИС +\fBxzdec\fP є інструментом на основі liblzma, який призначено лише для +розпаковування файлів \fB.xz\fP (і лише файлів \fB.xz\fP). \fBxzdec\fP призначено для +того, щоб працювати як повноцінний замінник \fBxz\fP(1) у більшості типових +ситуацій, де скрипт було написано для використання \fBxz \-\-decompress \-\-stdout\fP (і, можливо, декількох інших типових параметрів), для +розпаковування файлів \fB.xz\fP. \fBlzmadec\fP є тотожним до \fBxzdec\fP, але у +\fBlzmadec\fP передбачено підтримку файлів \fB.lzma\fP, замість файлів \fB.xz\fP. +.PP +Щоб зменшити розмір виконуваного файла, у \fBxzdec\fP не передбачено підтримки +багатопотокової обробки та локалізації, а також читання параметрів зі +змінних середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP. У \fBxzdec\fP не передбачено +підтримки показу проміжних даних щодо поступу: надсилання \fBSIGINFO\fP до +\fBxzdec\fP не призводить ні до яких наслідків, але надсилання \fBSIGUSR1\fP +перериває процес, замість показу даних щодо поступу. +.SH ПАРАМЕТРИ +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Буде проігноровано для сумісності з \fBxz\fP(1). У \fBxzdec\fP передбачено +підтримку лише розпаковування. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Буде проігноровано. Призначено для сумісності з \fBxz\fP(1). \fBxzdec\fP ніколи не +створюватиме і ніколи не вилучатиме ці файли. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Буде проігноровано. Для сумісності з \fBxz\fP(1). \fBxzdec\fP завжди записує +розпаковані дані до стандартного виведення. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Якщо цей параметр вказано один раз, нічого не станеться, оскільки \fBxzdec\fP +ніколи не показуватиме жодних попереджень або нотаток. Вкажіть параметр +двічі, щоб придушити повідомлення про помилки. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Буде проігноровано для сумісності із \fBxz\fP(1). \fBxzdec\fP ніколи не +використовує стан виходу 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести довідкове повідомлення і успішно завершити роботу. +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxzdec\fP та liblzma. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.PP +\fBxzdec\fP не має жодних повідомлень із попередженнями, на відміну від +\fBxz\fP(1), тому у \fBxzdec\fP стан виходу 2 не використовується. +.SH ПРИМІТКИ +Користуйтеся \fBxz\fP(1), замість \fBxzdec\fP або \fBlzmadec\fP, для щоденних +потреб. \fBxzdec\fP та \fBlzmadec\fP призначено лише для тих ситуацій, коли +важливо мати меншу програму для розпаковування, ніж \fBxz\fP(1). +.PP +\fBxzdec\fP і \fBlzmadec\fP не такі вже і малі програми. Їхній розмір можна +зменшити викиданням можливостей з liblzma під час збирання, але цього +зазвичай не роблять для виконуваних файлів, які поширюються у типових, не +вбудованих, дистрибутивах операційних систем. Якщо вам потрібний дуже мала +програма для розпаковування \fB.xz\fP, варто скористатися XZ Embedded. +.SH "ДИВ. ТАКОЖ" +\fBxz\fP(1) +.PP +Вбудовуваний XZ: diff --git a/miniconda3/share/man/uk/man1/lzmainfo.1 b/miniconda3/share/man/uk/man1/lzmainfo.1 new file mode 100644 index 0000000000000000000000000000000000000000..fea640b06d1d782db41bc75f432a790d6d54908e --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzmainfo.1 @@ -0,0 +1,45 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LZMAINFO 1 "30 червня 2013 року" Tukaani "XZ Utils" +.SH НАЗВА +lzmainfo — показ відомостей, які зберігаються у заголовку файла .lzma +.SH "КОРОТКИЙ ОПИС" +\fBlzmainfo\fP [\fB\-\-help\fP] [\fB\-\-version\fP] [\fIфайл...\fP] +.SH ОПИС +\fBlzmainfo\fP показує дані, що зберігаються у заголовку файла \fB.lzma\fP. Вона +читає перші 13 байтів із вказаного \fIфайла\fP, розкодовує заголовок і виводить +його до стандартного виведення у зручному для читання форматі. Якщо не +вказано жодного \fIфайла\fP або замість \fIфайла\fP вказано \fB\-\fP, дані буде +прочитано зі стандартного вхідного джерела даних. +.PP +Зазвичай, найцікавішою інформацією є розпакований розмір та розмір +словника. Розпакований розмір може бути показано, лише якщо файл записано у +непотоковому варіанті формату \fB.lzma\fP. Об'єм пам'яті, потрібний для +розпаковування файла, складає декілька десятків кілобайтів плюс розмір +словника. +.PP +\fBlzmainfo\fP включено до XZ Utils в основному для зворотної сумісності із +LZMA Utils. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.SH ВАДИ +\fBlzmainfo\fP використовує \fBMB\fP, хоча правильним суфіксом мав би бути \fBMiB\fP +(2^20 байтів). Так зроблено, щоб зберегти сумісність виведених даних із LZMA +Utils. +.SH "ДИВ. ТАКОЖ" +\fBxz\fP(1) diff --git a/miniconda3/share/man/uk/man1/lzmore.1 b/miniconda3/share/man/uk/man1/lzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf320be54129079b0f7310ac7f4d733a9f4d9945 --- /dev/null +++ b/miniconda3/share/man/uk/man1/lzmore.1 @@ -0,0 +1,51 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzmore, lzmore — перегляд стиснених xz або lzma (текстових) файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzmore\fP [\fIфайл\fP...] +.br +\fBlzmore\fP [\fIфайл\fP...] (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzmore\fP показує текст зі стиснених файлів у терміналі за допомогою +\fBmore\fP(1). Файли, підтримку яких передбачено у \fBxz\fP(1), буде розпаковано; +інші файли вважатимуться вже наданими у розпакованій формі. Якщо не вказано +аргументу \fIфайли\fP, \fBxzmore\fP читатиме дані зі стандартного джерела +даних. Див. підручник з \fBmore\fP(1), щоб дізнатися більше про клавіатурні +команди. +.PP +Зауважте, що гортання у зворотному напрямку може бути неможливим через +реалізацію \fBmore\fP(1). Причиною є те, що \fBxzmore\fP використовує канал для +передавання розпакованих даних \fBmore\fP(1). \fBxzless\fP(1) використовує +\fBless\fP(1), можливості якої є ширшими. +.PP +Команду \fBlzmore\fP реалізовано для забезпечення зворотної сумісності з LZMA +Utils. Ця команда вважається застарілою, її буде вилучено у майбутній версії +комплекту програм. +. +.SH СЕРЕДОВИЩЕ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Якщо встановлено значення \fBPAGER\fP, значення буде використано для засобу +поділу на сторінки, замість \fBmore\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/man/uk/man1/unlzma.1 b/miniconda3/share/man/uk/man1/unlzma.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/unlzma.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/unxz.1 b/miniconda3/share/man/uk/man1/unxz.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/unxz.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/xz.1 b/miniconda3/share/man/uk/man1/xz.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xz.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/xzcat.1 b/miniconda3/share/man/uk/man1/xzcat.1 new file mode 100644 index 0000000000000000000000000000000000000000..bff0472c4495c4b8c84495967535bcd7b99dc205 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzcat.1 @@ -0,0 +1,2039 @@ +'\" t +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZ 1 "8 березня 2025 року" Tukaani "XZ Utils" +. +.SH НАЗВА +xz, unxz, xzcat, lzma, unlzma, lzcat — стискання та розпаковування файлів +\&.xz і .lzma +. +.SH "КОРОТКИЙ ОПИС" +\fBxz\fP [\fIпараметр...\fP] [\fIфайл...\fP] +. +.SH "СКОРОЧЕННЯ КОМАНД" +\fBunxz\fP є рівноцінним до \fBxz \-\-decompress\fP. +.br +\fBxzcat\fP є рівноцінним до \fBxz \-\-decompress \-\-stdout\fP. +.br +\fBlzma\fP є рівноцінним до \fBxz \-\-format=lzma\fP. +.br +\fBunlzma\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress\fP. +.br +\fBlzcat\fP є рівноцінним до \fBxz \-\-format=lzma \-\-decompress \-\-stdout\fP. +.PP +При написанні скриптів, де потрібно розпаковувати файли, рекомендуємо завжди +використовувати \fBxz\fP із відповідними аргументами (\fBxz \-d\fP або \fBxz \-dc\fP), +замість \fBunxz\fP і \fBxzcat\fP. +. +.SH ОПИС +\fBxz\fP інструмент загального призначення для стискання даних із синтаксисом +командного рядка, подібним для \fBgzip\fP(1) і \fBbzip2\fP(1). Власним форматом +файлів є \fB.xz\fP, але передбачено підтримку застарілого формату \fB.lzma\fP, +який було використано у LZMA Utils, та необроблених потоків стиснених даних +без заголовків формату контейнера. Крім того, передбачено підтримку +розпаковування формату \fB.lz\fP, який використано у \fBlzip\fP. +.PP +\fBxz\fP стискає або розпаковує кожен \fIфайл\fP відповідно до вибраного режиму +дій. Якщо \fIфайли\fP не задано або якщо \fIфайлом\fP є \fB\-\fP, \fBxz\fP читатиме дані +зі стандартного джерела вхідних даних і записуватиме оброблені дані до +стандартного виведення. \fBxz\fP відмовить (покаже повідомлення про помилку і +пропустить \fIфайл\fP) у записів стиснених даних до стандартного виведення, +якщо це термінал. Так само, \fBxz\fP відмовить у читанні стиснених даних зі +стандартного джерела вхідних даних, якщо це термінал. +.PP +Якщо не вказано \fB\-\-stdout\fP, \fIфайли\fP, відмінні від \fB\-\fP, буде записано до +нового файла, чию назву буде визначено з назви початкового \fIфайла\fP: +.IP \(bu 3 +При стисканні суфікс формату файла призначення (\fB.xz\fP або \fB.lzma\fP) буде +дописано до назви початкового файла для отримання назви файла призначення. +.IP \(bu 3 +При розпаковуванні суфікс \fB.xz\fP, \fB.lzma\fP або \fB.lz\fP буде вилучено з назви +файла для отримання назви файла призначення. Крім того, \fBxz\fP розпізнає +суфікси \fB.txz\fP і \fB.tlz\fP і замінює їх на суфікс \fB.tar\fP. +.PP +Якщо файл призначення вже існує, буде показано повідомлення про помилку, а +\fIфайл\fP буде пропущено. +.PP +Окрім випадку запису до стандартного виведення, \fBxz\fP покаже попередження і +пропустить обробку \fIфайла\fP, якщо буде виконано будь\-яку з таких умов: +.IP \(bu 3 +\fIФайл\fP не є звичайним файлом. Програма не переходитиме за символічними +посиланнями, а отже, не вважатиме їх звичайними файлами. +.IP \(bu 3 +На \fIфайл\fP існує декілька жорстких посилань. +.IP \(bu 3 +Для \fIфайла\fP встановлено setuid, setgid або «липкий» біт. +.IP \(bu 3 +Режим дій встановлено у значення «стискання», і \fIфайл\fP вже має суфікс назви +формату файла призначення (\fB.xz\fP або \fB.txz\fP при стисканні до формату +\&\fB.xz\fP, і \fB.lzma\fP або \fB.tlz\fP при стисканні до формату \fB.lzma\fP). +.IP \(bu 3 +Режим дій встановлено у значення «розпаковування», і \fIфайл\fP не має суфікса +назви жодного з підтримуваних форматів (\fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP +або \fB.lz\fP). +.PP +Після успішного стискання або розпаковування \fIфайла\fP, \fBxz\fP копіює дані +щодо власника, групи, прав доступу, часу доступу та моменту внесення змін з +початкового \fIфайла\fP до файла призначення. Якщо копіювання даних щодо групи +зазнає невдачі, права доступу буде змінено так, що файл призначення стане +недоступним для користувачів, які не мають права доступу до початкового +\fIфайла\fP. В \fBxz\fP ще не передбачено підтримки копіювання інших метаданих, +зокрема списків керування доступом або розширених атрибутів. +.PP +Щойно файл призначення буде успішно закрито, початковий \fIфайл\fP буде +вилучено, якщо не вказано параметра \fB\-\-keep\fP. Початковий \fIфайл\fP ніколи не +буде вилучено, якщо виведені дані буде записано до стандартного виведення +або якщо станеться помилка. +.PP +Надсилання \fBSIGINFO\fP або \fBSIGUSR1\fP до процесу \fBxz\fP призводить до +виведення даних щодо поступу до стандартного виведення помилок. Це має лише +обмежене використання, оскільки якщо стандартним виведенням помилок є +термінал, використання \fB\-\-verbose\fP призведе до показу автоматично +оновлюваного індикатора поступу. +. +.SS "Використання пам'яті" +Використання \fBxz\fP пам'яті може бути різним: від декількох сотень кілобайтів +до декількох гігабайтів, залежно від параметрів стискання. Параметри, які +використано при стисканні файла, визначають вимоги до об'єму пам'яті при +розпакуванні. Типово, засобу розпаковування потрібно від 5\ % до 20\ % +об'єму пам'яті, якого засіб стискання потребує при створенні +файла. Наприклад, розпаковування файла, який створено з використанням \fBxz \-9\fP, у поточній версії потребує 65\ МіБ пам'яті. Втім, можливе створення +файлів \fB.xz\fP, які потребуватимуть для розпаковування декількох гігабайтів +пам'яті. +.PP +Ймовірність високого рівня використання пам'яті може бути особливо +дошкульною для користувачів застарілих комп'ютерів. Щоб запобігти прикрим +несподіванкам, у \fBxz\fP передбачено вбудований обмежувач пам'яті, який типово +вимкнено. Хоча у деяких операційних системах передбачено спосіб обмежити +використання пам'яті процесами, сподівання на його ефективність не є аж +надто гнучким (наприклад, використання \fBulimit\fP(1) для обмеження +віртуальної пам'яті призводить до викривлення даних \fBmmap\fP(2)). +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS. +.\" It's a name of an environment variable. +Обмежувач пам'яті можна увімкнути за допомогою параметра командного рядка +\fB\-\-memlimit=\fP\fIобмеження\fP. Часто, зручніше увімкнути обмежувач на типовому +рівні, встановивши значення для змінної середовища \fBXZ_DEFAULTS\fP, +наприклад, \fBXZ_DEFAULTS=\-\-memlimit=150MiB\fP. Можна встановити обмеження +окремо для стискання і розпакування за допомогою +\fB\-\-memlimit\-compress=\fP\fIlimit\fP and +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP. Використання цих двох параметрів поза +\fBXZ_DEFAULTS\fP не таке вже і корисне, оскільки одноразовий запуск \fBxz\fP не +може одночасно призводити до стискання та розпаковування, а набрати у +командному рядку \fB\-\-memlimit=\fP\fIобмеження\fP (або \fB\-M\fP \fIобмеження\fP) +набагато швидше. +.PP +Якщо під час розпаковування вказане обмеження буде перевищено, \fBxz\fP покаже +повідомлення про помилку, а розпаковування файла зазнає невдачі. Якщо +обмеження буде перевищено при стисканні, \fBxz\fP спробує масштабувати +параметри так, щоб не перевищувати обмеження (окрім випадків використання +\fB\-\-format=raw\fP або \fB\-\-no\-adjust\fP). Отже, дію буде виконано, якщо обмеження +не є надто жорстким. Масштабування параметрів буде виконано кроками, які не +збігаються із рівнями шаблонів стискання. Наприклад, якщо обмеження лише +трохи не вкладається у об'єм потрібний для \fBxz \-9\fP, параметри буде змінено +лише трохи, не до рівня \fBxz \-8\fP. +. +.SS "Поєднання і заповнення з файлами .xz" +Можна поєднати файли \fB.xz\fP без додаткової обробки. \fBxz\fP розпакує такі +файли так, наче вони є єдиним файлом \fB.xz\fP. +.PP +Можна додати доповнення між з'єднаними частинами або після останньої +частини. Доповнення має складатися із нульових байтів і мати розмір, який є +кратним до чотирьох байтів. Це може бути корисним, наприклад, якщо файл +\&\fB.xz\fP зберігається на носії даних, де розміри файла вимірюються у +512\-байтових блоках. +.PP +Поєднання та заповнення не можна використовувати для файлів \fB.lzma\fP або +потоків необроблених даних. +. +.SH ПАРАМЕТРИ +. +.SS "Цілочисельні суфікси і спеціальні значення" +У більшості місць, де потрібен цілочисельний аргумент, передбачено підтримку +необов'язкового суфікса для простого визначення великих цілих чисел. Між +цілим числом і суфіксом не повинно бути пробілів. +.TP +\fBKiB\fP +Помножити ціле число на 1024 (2^10). Синонімами \fBKiB\fP є \fBKi\fP, \fBk\fP, \fBkB\fP, +\fBK\fP та \fBKB\fP. +.TP +\fBMiB\fP +Помножити ціле число на 1048576 (2^20). Синонімами \fBMiB\fP є B, \fBMi\fP, \fBm\fP, +\fBM\fP та \fBMB\fP. +.TP +\fBGiB\fP +Помножити ціле число на 1073741824 (2^30). Синонімами \fBGiB\fP є B, \fBGi\fP, +\fBg\fP, \fBG\fP та \fBGB\fP. +.PP +Можна скористатися особливим значенням \fBmax\fP для позначення максимального +цілого значення, підтримку якого передбачено для параметра. +. +.SS "Режим операції" +Якщо вказано декілька параметрів режиму дій, буде використано лише останній +з них. +.TP +\fB\-z\fP, \fB\-\-compress\fP +Стиснути. Це типовий режим дій, якщо не вказано параметр режиму дій, а назва +команди неявним чином не визначає іншого режиму дій (наприклад, \fBunxz\fP +неявно визначає \fB\-\-decompress\fP). +.IP "" +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Після успішного пакування початковий файл буде вилучено, якщо виведення не +відбувається до стандартного виведення або не вказано параметра \fB\-\-keep\fP. +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +.\" The DESCRIPTION section already says this but it's good to repeat it +.\" here because the default behavior is a bit dangerous and new users +.\" in a hurry may skip reading the DESCRIPTION section. +Розпакувати. Після успішного розпаковування початковий файл буде вилучено, +якщо виведення не відбувається до стандартного виведення або не вказано +параметра \fB\-\-keep\fP. +.TP +\fB\-t\fP, \fB\-\-test\fP +Перевірити цілісність стиснених файлів \fIфайли\fP. Цей параметр еквівалентний +до \fB\-\-decompress \-\-stdout\fP, але розпаковані дані буде відкинуто, замість +запису до стандартного виведення. Жодних файлів не буде створено або +вилучено. +.TP +\fB\-l\fP, \fB\-\-list\fP +Вивести відомості щодо стиснених файлів \fIфайли\fP. Розпакування даних не +виконуватиметься, жодних файлів не буде створено або вилучено. У режимі +списку програма не може читати дані зі стандартного введення або з інших +джерел, де неможливе позиціювання. +.IP "" +У типовому списку буде показано базові відомості щодо файлів \fIфайли\fP, по +одному файлу на рядок. Щоб отримати докладніші відомості, скористайтеся +параметром \fB\-\-verbose\fP. Щоб розширити спектр відомостей, скористайтеся +параметром \fB\-\-verbose\fP двічі, але зауважте, що це може призвести до +значного уповільнення роботи, оскільки отримання додаткових відомостей +потребує великої кількості позиціювань. Ширина області докладного виведення +даних перевищує 80 символів, тому передавання конвеєром виведених даних, +наприклад, до \fBless\ \-S\fP, може бути зручним способом перегляду даних, якщо +термінал недостатньо широкий. +.IP "" +Виведені дані залежать від версії \fBxz\fP та використаної локалі. Для +отримання даних, які будуть придатні до обробки комп'ютером, слід +скористатися параметрами \fB\-\-robot \-\-list\fP. +. +.SS "Модифікатори режиму роботи" +.TP +\fB\-k\fP, \fB\-\-keep\fP +Не вилучати вхідні файли. +.IP "" +Починаючи з версії \fBxz\fP 5.2.6, використання цього параметра також наказує +\fBxz\fP виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий +біт. setuid, setgid та липкий біт не буде скопійовано до файла\-результату. У +попередніх версіях, ці дії виконувалися, лише якщо було використано параметр +\fB\-\-force\fP. +.TP +\fB\-f\fP, \fB\-\-force\fP +Результатів використання цього параметра буде декілька: +.RS +.IP \(bu 3 +Якщо файл\-результат вже існує, вилучити його до стискання або +розпаковування. +.IP \(bu 3 +Виконувати стискання або розпаковування, навіть якщо вхідними даними є +символічне посилання на звичайний файл, файл, який має декілька жорстких +посилань, або файл, для якого встановлено setuid, setgid або липкий біт +setuid, setgid та липкий біт не буде скопійовано до файла\-результату. +.IP \(bu 3 +Якщо використано разом із \fB\-\-decompress\fP, \fB\-\-stdout\fP, і \fBxz\fP не зможе +розпізнати тип початкового файла, копіювати початковий файл без змін до +стандартного виведення. Це надає змогу користуватися \fBxzcat\fP \fB\-\-force\fP +подібно до \fBcat\fP(1) для файлів, які не було стиснено за допомогою +\fBxz\fP. Зауважте, що у майбутньому у \fBxz\fP може бути реалізовано підтримку +нових форматів стиснених файлів, замість копіювання їх без змін до +стандартного виведення. Можна скористатися \fB\-\-format=\fP\fIформат\fP для +обмеження стискання у \fBxz\fP єдиним форматом файлів. +.RE +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Записати стиснені або розпаковані дані до стандартного виведення, а не до +файла. Неявним чином встановлює \fB\-\-keep\fP. +.TP +\fB\-\-single\-stream\fP +Розпакувати лише перший потік даних \fB.xz\fP і без повідомлень проігнорувати +решту вхідних даних, які слідують за цим потоком. Зазвичай, такі зайві дані +наприкінці файла призводять до показу \fBxz\fP повідомлення про помилку. +.IP "" +\fBxz\fP ніколи не виконуватиме спроби видобути декілька потоків даних з файлів +\&\fB.lzma\fP або необроблених потоків даних, але використання цього параметра +все одно наказує \fBxz\fP ігнорувати можливі кінцеві дані після файла \fB.lzma\fP +або необробленого потоку даних. +.IP "" +Цей параметр нічого не змінює, якщо режимом дій не є \fB\-\-decompress\fP або +\fB\-\-test\fP. +.IP "" +З \fBxz\fP 5.7.1alpha, \fB\-\-single\-stream\fP неявно визначає \fB\-\-keep\fP. +.TP +\fB\-\-no\-sparse\fP +Вимкнути створення розріджених файлів. Типово, якщо видобування виконується +до звичайного файла, \fBxz\fP намагається створити розріджений файл, якщо +розпаковані дані містять довгі послідовності двійкових нулів. Це також +працює, коли виконується запис до стандартного виведення, доки стандартне +виведення з'єднано зі звичайним файлом і виконуються певні додаткові умови, +які убезпечують роботу. Створення розріджених файлів може заощадити місце на +диску і пришвидшити розпаковування шляхом зменшення кількості дій введення +та виведення даних на диску. +.TP +\fB\-S\fP \fI.suf\fP, \fB\-\-suffix=\fP\fI.suf\fP +При стисканні використати суфікс \fI.suf\fP для файлів призначення, замість +суфікса \fB.xz\fP або \fB.lzma\fP. Якщо записування виконується не до стандартного +виведення і початковий файл вже має суфікс назви \fI.suf\fP, буде показано +попередження, а файл буде пропущено під час обробки. +.IP "" +При розпаковуванні розпізнавати файли із суфіксом назви \fI.suf\fP, окрім +файлів із суфіксами назв \fB.xz\fP, \fB.txz\fP, \fB.lzma\fP, \fB.tlz\fP або \fB.lz\fP. Якщо +початковий файл мав суфікс назви \fI.suf\fP, для отримання назви файла +призначення цей суфікс буде вилучено. +.IP "" +При стисканні або розпакуванні необроблених потоків даних (\fB\-\-format=raw\fP) +суфікс слід вказувати завжди, якщо запис не виконується до стандартного +виведення, оскільки типового суфікса назви для необроблених потоків даних не +передбачено. +.TP +\fB\-\-files\fP[\fB=\fP\fIфайл\fP] +Прочитати назви файлів для обробки з файла \fIфайл\fP; якщо \fIfile\fP не вказано, +назви файлів буде прочитано зі стандартного потоку вхідних даних. Назви +файлів має бути відокремлено символом нового рядка. Символ дефіса (\fB\-\fP) +буде оброблено як звичайну назву файла; він не позначатиме стандартного +джерела вхідних даних. Якщо також буде вказано назви файлів у аргументах +рядка команди, файли з цими назвами буде оброблено до обробки файлів, назви +яких було прочитано з файла \fIфайл\fP. +.TP +\fB\-\-files0\fP[\fB=\fP\fIфайл\fP] +Те саме, що і \fB\-\-files\fP[\fB=\fP\fIфайл\fP], але файли у списку має бути +відокремлено нульовим символом. +. +.SS "Параметри базового формату файлів та стискання" +.TP +\fB\-F\fP \fIformat\fP, \fB\-\-format=\fP\fIформат\fP +Вказати файл \fIформат\fP для стискання або розпакування: +.RS +.TP +.\" TRANSLATORS: Don't translate bold string B. +\fBauto\fP +Типовий варіант. При стисканні \fBauto\fP є еквівалентом \fBxz\fP. При +розпакуванні формат файла вхідних даних буде виявлено автоматично. Зауважте, +що автоматичне виявлення необроблених потоків даних (створених за допомогою +\fB\-\-format=raw\fP) неможливе. +.TP +\fBxz\fP +Стиснути до формату \fB.xz\fP або приймати лише файли \fB.xz\fP при +розпаковуванні. +.TP +\fBlzma\fP, \fBalone\fP +Стиснути дані до застарілого формату файлів \fB.lzma\fP або приймати лише файли +\&\fB.lzma\fP при розпаковуванні. Альтернативну назву \fBalone\fP може бути +використано для зворотної сумісності із LZMA Utils. +.TP +\fBlzip\fP +Приймати лише файли \fB.lz\fP при розпакуванні. Підтримки стискання не +передбачено. +.IP "" +Передбачено підтримку версії формату \fB.lz\fP 0 та 1. Файли версії 0 було +створено \fBlzip\fP 1.3 та старішими версіями. Такі файли не є поширеними, але +їх можна знайти у файлових архівах, оскільки певну незначну кількість +пакунків із початковим кодом було випущено у цьому форматі. Також можуть +існувати особисті файли у цьому форматі. Підтримку розпаковування для +формату версії 0 було вилучено у \fBlzip\fP 1.18. Версія \fBlzip\fP 1.4 і новіші +версії створюють файли у форматі версії 1. +.TP +\fBraw\fP +Стиснути або розпакувати потік необроблених даних (лез заголовків). Цей +параметр призначено лише для досвідчених користувачів. Для розпаковування +необроблених потоків даних слід користуватися параметром \fB\-\-format=raw\fP і +явно вказати ланцюжок фільтрування, який за звичайних умов мало б бути +збережено у заголовках контейнера. +.RE +.TP +\fB\-C\fP \fIперевірка\fP, \fB\-\-check=\fP\fIперевірка\fP +Вказати тип перевірки цілісності. Контрольну суму буде обчислено на основі +нестиснених даних і збережено у файлі \fB.xz\fP. Цей параметр працюватиме, лише +якщо дані стиснено до файла у форматі \fB.xz\fP; для формату файлів \fB.lzma\fP +підтримки перевірки цілісності не передбачено. Перевірку контрольної суми +(якщо така є) буде виконано під час розпаковування файла \fB.xz\fP. +.IP "" +Підтримувані типи \fIперевірок\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, and B. The command line option --check accepts +.\" only the untranslated strings. +\fBnone\fP +Не обчислювати контрольну суму взагалі. Зазвичай, не варто цього робити. Цим +варіантом слід скористатися, якщо цілісність даних буде перевірено в інший +спосіб. +.TP +\fBcrc32\fP +Обчислити CRC32 за допомогою полінома з IEEE\-802.3 (Ethernet). +.TP +\fBcrc64\fP +Обчислити CRC64 за допомогою полінома з ECMA\-182. Це типовий варіант, +оскільки він дещо кращий за CRC32 при виявленні пошкоджених файлів, а +різниця у швидкості є незрачною. +.TP +\fBsha256\fP +Обчислити SHA\-256. Цей варіант дещо повільніший за CRC32 і CRC64. +.RE +.IP "" +Цілісність заголовків \fB.xz\fP завжди перевіряють за допомогою CRC32. Таку +перевірку не можна змінити або скасувати. +.TP +\fB\-\-ignore\-check\fP +Не перевіряти цілісність стиснених даних при розпаковуванні. Значення CRC32 +у заголовках \fB.xz\fP буде у звичайний спосіб перевірено попри цей параметр. +.IP "" +\fBНе користуйтеся цим параметром, якщо ви не усвідомлюєте наслідків ваших дій.\fP Можливі причини скористатися цим параметром: +.RS +.IP \(bu 3 +Спроба отримання даних з пошкодженого файла .xz. +.IP \(bu 3 +Пришвидшення розпакування. Це, здебільшого, стосується SHA\-256 або файлів із +надзвичайно високим рівнем пакування. Не рекомендуємо користуватися цим +параметром з цією метою, якщо цілісність файлів не буде перевірено у якийсь +інший спосіб. +.RE +.TP +\fB\-0\fP ... \fB\-9\fP +Вибрати рівень стискання. Типовим є \fB\-6\fP. Якщо буде вказано декілька рівнів +стискання, програма використає останній вказаний. Якщо вже було вказано +нетиповий ланцюжок фільтрів, встановлення рівня стискання призведе до +нехтування цим нетиповим ланцюжком фільтрів. +.IP "" +Різниця між рівнями є суттєвішою, ніж у \fBgzip\fP(1) і \fBbzip2\fP(1). Вибрані +параметри стискання визначають вимоги до пам'яті під час розпаковування, +отже використання надто високого рівня стискання може призвести до проблем +під час розпаковування файла на застарілих комп'ютерах із невеликим обсягом +оперативної пам'яті. Зокрема, \fBне варто використовувати \-9 для усього\fP, як +це часто буває для \fBgzip\fP(1) і \fBbzip2\fP(1). +.RS +.TP +\fB\-0\fP ... \fB\-3\fP +Це дещо швидші набори налаштувань. \fB\-0\fP іноді є швидшим за \fBgzip \-9\fP, +забезпечуючи набагато більший коефіцієнт стискання. Вищі рівні часто мають +швидкість, яку можна порівняти з \fBbzip2\fP(1) із подібним або кращим +коефіцієнтом стискання, хоча результати значно залежать від типу даних, які +стискають. +.TP +\fB\-4\fP ... \fB\-6\fP +Стискання від доброго до дуже доброго рівня із одночасним підтриманням +помірного рівня споживання пам'яті засобом розпаковування, навіть для +застарілих системи. Типовим є значення \fB\-6\fP, яке є добрим варіантом для +поширення файлів, які мають бути придатними до розпаковування навіть у +системах із лише 16\ МіБ оперативної пам'яті. (Також можна розглянути +варіанти \fB\-5e\fP і \fB\-6e\fP. Див. \fB\-\-extreme\fP.) +.TP +\fB\-7 ... \-9\fP +Ці варіанти подібні до \fB\-6\fP, але із вищими вимогами щодо пам'яті для +стискання і розпаковування. Можуть бути корисними лише для стискання файлів +з розміром, що перевищує 8\ МіБ, 16\ МіБ та 32\ МіБ, відповідно. +.RE +.IP "" +На однаковому обладнанні швидкість розпакування є приблизно сталою кількістю +байтів стиснених даних за секунду. Іншими словами, чим кращим є стискання, +тим швидшим буде, зазвичай, розпаковування. Це також означає, що об'єм +розпакованих виведених даних, які видає програма за секунду, може коливатися +у широкому діапазоні. +.IP "" +У наведеній нижче таблиці підсумовано можливості шаблонів: +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0;256 КіБ;0;3 МіБ;1 МіБ +\-1;1 МіБ;1;9 МіБ;2 МіБ +\-2;2 МіБ;2;17 МіБ;3 МіБ +\-3;4 МіБ;3;32 МіБ;5 МіБ +\-4;4 МіБ;4;48 МіБ;5 МіБ +\-5;8 МіБ;5;94 МіБ;9 МіБ +\-6;8 МіБ;6;94 МіБ;9 МіБ +\-7;16 МіБ;6;186 МіБ;17 МіБ +\-8;32 МіБ;6;370 МіБ;33 МіБ +\-9;64 МіБ;6;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Описи стовпчиків: +.RS +.IP \(bu 3 +DictSize є розміром словника LZMA2. Використання словника, розмір якого +перевищує розмір нестисненого файла, — проста витрата пам'яті. Ось чому не +варто використовувати шаблони \fB\-7\fP ... \fB\-9\fP, якщо у них немає реальної +потреби. Для \fB\-6\fP та нижчих рівнів об'єм витраченої пам'яті, зазвичай, +такий низький, що цей фактор ні на що не впливає. +.IP \(bu 3 +CompCPU є спрощеним представленням параметрів LZMA2, які впливають на +швидкість стискання. Розмір словника також впливає на швидкість, тому, хоча +значення CompCPU є однаковим для рівнів \fB\-6\fP ... \fB\-9\fP, обробка на вищих +рівнях все одно є трошки повільнішою. Що отримати повільніше і, ймовірно, +краще стискання, див. \fB\-\-extreme\fP. +.IP \(bu 3 +CompMem містить вимоги до пам'яті засобу стискання у однопотоковому +режимі. Значення можуть бути дещо різними для різних версій \fBxz\fP. +.IP \(bu 3 +У DecMem містяться вимоги до пам'яті при розпаковуванні. Тобто параметри +засобу стискання визначають вимоги до пам'яті при розпаковуванні. Точний +об'єм пам'яті, яка потрібна для розпаковування, дещо перевищує розмір +словника LZMA2, але значення у таблиці було округлено до наступного цілого +значення МіБ. +.RE +.IP "" +Вимоги до пам'яті у багатопотоковому режимі є значно вищими, ніж у +однопотоковому. З типовим значенням \fB\-\-block\-size\fP для кожного потоку треба +3*3*DictSize плюс CompMem або DecMem. Наприклад, для чотирьох потоків з +шаблоном \fB\-6\fP потрібно 660\(en670\ МіБ пам'яті. +.TP +\fB\-e\fP, \fB\-\-extreme\fP +Використати повільніший варіант вибраного рівня стискання (\fB\-0\fP ... \fB\-9\fP) +у сподіванні отримати трохи кращий коефіцієнт стискання, але, якщо не +поталанить, можна його і погіршити. Не впливає на використання пам'яті при +розпаковуванні, але використання пам'яті при стисканні дещо збільшиться на +рівнях \fB\-0\fP ... \fB\-3\fP. +.IP "" +Оскільки існує два набори налаштувань із розмірами словників 4\ МіБ та 8\ МіБ, у наборах \fB\-3e\fP і \fB\-5e\fP використано трошки швидші параметри (нижче +CompCPU), ніж у наборах \fB\-4e\fP і \fB\-6e\fP, відповідно. Тому двох однакових +наборів у списку немає. +.RS +.RS +.PP +.TS +tab(;); +c c c c c +n n n n n. +Шаблон;DictSize;CompCPU;CompMem;DecMem +\-0e;256 КіБ;8;4 МіБ;1 МіБ +\-1e;1 МіБ;8;13 МіБ;2 МіБ +\-2e;2 МіБ;8;25 МіБ;3 МіБ +\-3e;4 МіБ;7;48 МіБ;5 МіБ +\-4e;4 МіБ;8;48 МіБ;5 МіБ +\-5e;8 МіБ;7;94 МіБ;9 МіБ +\-6e;8 МіБ;8;94 МіБ;9 МіБ +\-7e;16 МіБ;8;186 МіБ;17 МіБ +\-8e;32 МіБ;8;370 МіБ;33 МіБ +\-9e;64 МіБ;8;674 МіБ;65 МіБ +.TE +.RE +.RE +.IP "" +Наприклад, передбачено загалом чотири набори налаштувань із використанням +словника у 8\ МіБ, порядок яких від найшвидшого до найповільнішого є таким: +\fB\-5\fP, \fB\-6\fP, \fB\-5e\fP і \fB\-6e\fP. +.TP +\fB\-\-fast\fP +.PD 0 +.TP +\fB\-\-best\fP +.PD +Це дещо оманливі альтернативні варіанти для \fB\-0\fP і \fB\-9\fP, +відповідно. Реалізовано лише для забезпечення зворотної сумісності із LZMA +Utils. Намагайтеся не користуватися цими варіантами параметрів. +.TP +\fB\-\-block\-size=\fP\fIрозмір\fP +При стисканні до формату \fB.xz\fP поділити вхідні дані на блоки у \fIрозмір\fP +байтів. Ці блоки буде стиснуто незалежно один від одного, що допоможе у +багатопотоковій обробці і зробить можливим обмежене розпакування для доступу +до будь\-яких даних. Цим параметром слід типово користуватися для +перевизначення типового розміру блоку у багатопотоковому режимі обробки, але +цим параметром можна також скористатися в однопотоковому режимі обробки. +.IP "" +У багатопотоковому режимі для кожного потоку буде отримано для буферів +вхідних і вихідних даних майже утричі більше за \fIрозмір\fP байтів. Типовий +\fIрозмір\fP утричі більший за розмір словника LZMA2 або дорівнює 1 МіБ, буде +вибрано більше значення. Типовим добрим значенням буде значення, яке у +2\(en4 рази перевищує розмір словника LZMA2 або дорівнює принаймні 1 +МіБ. Використання значення \fIрозмір\fP, яке є меншим за розмір словника LZMA2, +має наслідком марну витрату оперативної пам'яті, оскільки його використання +призводить до того, що буфер словника LZMA2 ніколи не буде використано +повністю. У багатопотоковому режимі розміри блоків зберігатимуться у +заголовках блоків. Ці дані потрібні для багатопотокового розпаковування. +.IP "" +У однопотоковому режимі поділ на блоки типово не +виконуватиметься. Встановлення значення для цього параметра не впливатиме на +використання пам'яті. У заголовках блоків не зберігатимуться дані щодо +розміру, отже файли, які створено в однопотоковому режимі не будуть +ідентичними до файлів, які створено у багатопотоковому режимі. Те, що у +заголовках блоків не зберігатимуться дані щодо розміру також означає, що +\fBxz\fP не зможе розпаковувати такі файли у багатопотоковому режимі. +.TP +\fB\-\-block\-list=\fP\fIзаписи\fP +При стисканні у форматі \fB.xz\fP починати новий блок із необов'язковим +ланцюжком фільтрів після вказаної кількості інтервалів нестиснених даних. +.IP "" +\fIзаписи\fP є списком відокремлених комами значень. Кожен запис складається з +необов'язкового номера ланцюжка фільтрів від 0 до 9, після якого йде +двокрапка (\fB:\fP) і необхідний розмір нестиснутих даних. Пропущення запису +(дві або більше послідовних ком) є скороченим варіантом визначення +використання розміру та фільтрів попереднього запису. +.IP "" +Якщо файл вхідних даних є більшим за розміром за суму розмірів \fIзаписів\fP, +останнє значення у \fIрозмірах\fP буде повторено до кінця файла. Особливе +значення \fB0\fP може бути використано як останній розмір, щоб позначити, що +решту файла має бути закодовано як єдиний блок. +.IP "" +Альтернативний ланцюжок фільтрів для кожного блоку можна вказати в поєднанні +з параметрами \fB\-\-filters1=\fP\fIфільтри\fP \&...\& \fB\-\-filters9=\fP\fIфільтри\fP. Ці +параметри визначають ланцюжки фільтрів з ідентифікатором у діапазоні +1\(en9. Ланцюжок фільтрів 0 можна використовувати для посилання на типовий +ланцюжок фільтрів — це те саме, що не вказувати ланцюжок +фільтрів. Ідентифікатор ланцюжка фільтрів можна використовувати перед +нестисненим розміром, після якого йде двокрапка (\fB:\fP). Наприклад, якщо +вказати \fB\-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB\fP, блоки будуть +створені так: +.RS +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters1\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters3\fP із вхідними даними у 2 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Ланцюжок фільтрів задано \fB\-\-filters2\fP із вхідними даними у 4 МіБ +.IP \(bu 3 +Типовий ланцюжок даних і вхідні дані у 2 МіБ +.IP \(bu 3 +Типовий ланцюжок фільтрів та вхідні дані у 4 МіБ для кожного блоку до кінця +вхідних даних. +.RE +.IP "" +Якщо вказати розмір, який перевищує розмір блоку кодувальника (або типове +значення у режимі із потоками обробки, або значення, яке встановлено за +допомогою \fB\-\-block\-size=\fP\fIрозмір\fP), засіб кодування створить додаткові +блоки, зберігаючи межі, які вказано у \fIзаписах\fP. Наприклад, якщо вказати +\fB\-\-block\-size=10MiB\fP \fB\-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB\fP, а файл +вхідних даних має розмір 80 МіБ, буде отримано такі 11 блоків: 5, 10, 8, 10, +2, 10, 10, 4, 10, 10 і 1 МіБ. +.IP "" +У багатопотоковому режимі розмір блоків буде збережено у заголовках +блоків. Програма не зберігатиме ці дані у однопотоковому режимі, отже +закодований результат не буде ідентичним до отриманого у багатопотоковому +режимі. +.TP +\fB\-\-flush\-timeout=\fP\fIчас_очікування\fP +При стискання, якщо з моменту попереднього витирання мине понад +\fIчас_очікування\fP мілісекунд (додатне ціле значення) і читання додаткових +даних буде заблоковано, усі вхідні дані у черзі обробки буде витерто з +кодувальника і зроблено доступним у потоці вихідних даних. Це може бути +корисним, якщо \fBxz\fP використовують для стискання даних, які передають +потоком мережею. Невеликі значення аргументу \fIчас_очікування\fP зроблять дані +доступними на боці отримання із малою затримкою, а великі значення аргумент +\fIчас_очікування\fP уможливлять кращий коефіцієнт стискання. +.IP "" +Типово, цю можливість вимкнено. Якщо цей параметр вказано декілька разів, +буде використано лише останнє вказане значення. Особливим значенням +аргументу \fIчас_очікування\fP, рівним \fB0\fP, можна скористатися для вимикання +цієї можливості явним чином. +.IP "" +Ця можливість недоступна у системах, які не є системами POSIX. +.IP "" +.\" FIXME +\fBЦя можливість усе ще є експериментальною.\fP У поточній версії, \fBxz\fP не +може розпаковувати потік даних у режимі реального часу через те, у який +спосіб \fBxz\fP виконує буферизацію. +.TP +\fB\-\-no\-sync\fP +Не синхронізувати файл призначення та його каталог із пристроєм зберігання +даних до вилучення початкового файла. Це може підвищити швидкодію, якщо +виконується стискання або розпаковування багатьох малих файлів. Втім, якщо +система аварійно завершує роботу невдовзі після вилучення, можлива ситуація, +коли файл призначення не буде записано на пристрій зберігання даних, а дію з +вилучення буде записано. У цьому випадку буде знищено дані як початкового +файла, так і файла призначення. +.IP "" +Цей параметр матиме хоч який вплив, лише якщо \fBxz\fP вилучає початковий +файл. В інших випадках синхронізація не виконується. +.IP "" +Синхронізацію і \fB\-\-no\-sync\fP було додано у версії \fBxz\fP 5.7.1alpha. +.TP +\fB\-\-memlimit\-compress=\fP\fIобмеження\fP +Встановити обмеження на використання пам'яті при стисканні. Якщо цей +параметр вказано декілька разів, враховано буде лише останнє вказане +значення. +.IP "" +Якщо параметри стискання перевищують \fIобмеження\fP, \fBxz\fP спробує скоригувати +параметри так, щоб обмеження не було перевищено, і покаже повідомлення про +те, що було виконано автоматичне коригування. Коригування буде виконано у +такому порядку: зменшення кількості потоків обробки, перемикання у +однопотоковий режим, якщо хоч в одному потоці багатопотокового режиму буде +перевищено \fIобмеження\fP, і нарешті, зменшення розміру словника LZMA2. +.IP "" +При стисканні з використанням \fB\-\-format=raw\fP, або якщо було вказано +\fB\-\-no\-adjust\fP, може бути зменшена лише кількість потоків обробки, оскільки +це може бути зроблено без впливу на стиснені виведені дані. +.IP "" +Якщо \fIобмеження\fP не може бути виконано за допомогою коригувань, які описано +вище, буде показано повідомлення про помилку, а \fBxz\fP завершить роботу зі +станом виходу 1. +.IP "" +Аргумент \fIобмеження\fP можна вказати у декілька способів: +.RS +.IP \(bu 3 +Значенням \fIобмеження\fP може бути додатне ціле значення у байтах. Можна +скористатися цілочисельним суфіксом, подібним до \fBMiB\fP. Приклад: +\fB\-\-memlimit\-compress=80MiB\fP +.IP \(bu 3 +Аргумент \fIобмеження\fP може бути задано у відсотках від загальної фізичної +пам'яті системи (RAM). Це може бути корисним особливо при встановленні +змінної середовища \fBXZ_DEFAULTS\fP у скрипті ініціалізації системи, який є +спільним для різних комп'ютерів. У такий спосіб можна вказати вищий рівень +обмеження для систем із більшим об'ємом пам'яті. Приклад: +\fB\-\-memlimit\-compress=70%\fP +.IP \(bu 3 +Аргументу \fIобмеження\fP може бути повернуто типове значення встановленням +значення \fB0\fP. У поточній версії це еквівалентно до встановлення значення +аргументу \fIобмеження\fP \fBmax\fP (без обмеження на використання пам'яті). +.RE +.IP "" +Для 32\-бітової версії \fBxz\fP передбачено особливий випадок: якщо \fIобмеження\fP +перевищуватиме \fB4020\ МіБ\fP, для \fIобмеження\fP буде встановлено значення +\fB4020\ MiB\fP. На MIPS32 замість цього буде використано \fB2000\ MiB\fP. (Це не +стосується значень \fB0\fP і \fBmax\fP. Подібної можливості для розпаковування не +існує.) Це може бути корисним, коли 32\-бітовий виконуваний файл має доступ +до простору адрес у 4\ ГіБ (2 GiB на MIPS32), хоча, сподіваємося, не +зашкодить і в інших випадках. +.IP "" +Див. також розділ \fBВикористання пам'яті\fP. +.TP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +Встановити обмеження пам'яті на розпаковування. це також вплине на режим +\fB\-\-list\fP. Якщо дія є неможливою без перевищення \fIобмеження\fP, \fBxz\fP покаже +повідомлення про помилку і розпаковування файла не +відбудеться. Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб дізнатися більше +про те, як можна задати \fIобмеження\fP. +.TP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP +Встановити обмеження використання пам'яті для багатопотокового +розпаковування. Це може вплинути лише на кількість потоків обробки; це +ніколи не призводитиме до відмови \fBxz\fP у розпаковуванні файла. Якщо +\fIобмеження є надто низьким\fP, щоб уможливити будь\-яку багатопотокову +обробку, \fIобмеження\fP буде проігноровано, і \fBxz\fP продовжить обробку в +однопотоковому режимі. Зауважте, що якщо використано також +\fB\-\-memlimit\-decompress\fP, цей параметр буде застосовано до обох режимів, +однопотокового та багатопотокового, а отже, задіяне \fIобмеження\fP для +багатопотокового режиму ніколи не перевищуватиме обмеження, яке встановлено +за допомогою \fB\-\-memlimit\-decompress\fP. +.IP "" +На відміну від інших параметрів обмеження використання пам'яті, +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP містить специфічне для системи +типове значення \fIобмеження\fP. Можна скористатися \fBxz \-\-info\-memory\fP для +перегляду поточного значення. +.IP "" +Цей параметр і його типове значення існують, оскільки без будь\-яких обмежень +засіб розпакування зі підтримкою потокової обробки міг би намагатися +отримати величезний об'єм пам'яті для деяких файлів вхідних даних. Якщо +типове \fIобмеження\fP є надто низьким для вашої системи, не вагайтеся і +збільшуйте \fIобмеження\fP, але ніколи не встановлюйте для нього значення, яке +є більшим за придатний до користування об'єм оперативної пам'яті, оскільки +за відповідних файлів вхідних даних \fBxz\fP спробує скористатися цим об'ємом +пам'яті, навіть із низькою кількістю потоків обробки. Вичерпання об'єму +оперативної пам'яті або використання резервної пам'яті на диску не покращить +швидкодію системи під час розпаковування. +.IP "" +Див. \fB\-\-memlimit\-compress=\fP\fIобмеження\fP, щоб ознайомитися із можливими +способами визначення \fIобмеження\fP. Встановлення для \fIобмеження\fP значення +\fB0\fP відновлює типове специфічне для системи значення \fIобмеження\fP. +.TP +\fB\-M\fP \fIобмеження\fP, \fB\-\-memlimit=\fP\fIобмеження\fP, \fB\-\-memory=\fP\fIобмеження\fP +Є еквівалентом визначення \fB\-\-memlimit\-compress=\fP\fIобмеження\fP +\fB\-\-memlimit\-decompress=\fP\fIобмеження\fP +\fB\-\-memlimit\-mt\-decompress=\fP\fIобмеження\fP. +.TP +\fB\-\-no\-adjust\fP +Показати повідомлення про помилку і завершити роботу, якщо не вдасться +виконати умови щодо обмеження використання пам'яті без коригування +параметрів, які впливають на стиснених виведених даних. Тобто це забороняє +\fBxz\fP перемикати кодувальник з багатопотокового режиму на однопотоковий +режим і зменшувати розмір словника LZMA2. Навіть якщо використано цей +параметр, кількість потоків може бути зменшено для виконання обмеження на +використання пам'яті, оскільки це не вплине на результати стискання. +.IP "" +Автоматичне коригування завжди буде вимкнено при створенні потоків +необроблених даних (\fB\-\-format=raw\fP). +.TP +\fB\-T\fP \fIпотоки\fP, \fB\-\-threads=\fP\fIпотоки\fP +Вказати кількість потоків обробки, якими слід скористатися. Встановлення для +аргументу \fIпотоки\fP особливого значення \fB0\fP наказує \fBxz\fP використати не +більше потоків обробки, ніж передбачено підтримку у процесорах +системи. Справжня кількість потоків може бути меншою за значення \fIпотоки\fP, +якщо файл вхідних даних не є достатньо великим для поділу на потоки обробки +при заданих параметрах або якщо використання додаткових потоків призведе до +перевищення обмеження на використання пам'яті. +.IP "" +Засоби стискання в однопотоковому та багатопотоковому режимі дають різні +результати. Однопотоковий засіб стискання дасть найменший розмір файла, але +лише результати роботи багатопотокового засобу стискання може бути +розпаковано з використанням декількох потоків. Встановлення для аргументу +\fIпотоки\fP значення \fB1\fP призведе до використання однопотокового +режиму. Встановлення для аргументу \fIпотоки\fP будь\-якого іншого значення, +включно з \fB0\fP, призведе до використання багатопотокового засобу стискання, +навіть якщо у системі передбачено підтримки лише одного апаратного потоку +обробки даних. (Версія \fBxz\fP 5.2.x у цьому випадку використовувала +однопотоковий режим.) +.IP "" +Щоб скористатися багатопотоковим режимом із лише одним потоком обробки, +встановіть для аргументу \fIпотоки\fP значення \fB+1\fP. Префікс \fB+\fP не впливає +на значення, окрім \fB1\fP. Обмеження на використання пам'яті можуть перемкнути +\fBxz\fP в однопотоковий режим, якщо не використано параметр +\fB\-\-no\-adjust\fP. Підтримку \fB+\fP prefix було додано у версії \fBxz\fP 5.4.0. +.IP "" +Якщо було вказано автоматичне визначення кількості потоків і не вказано +обмеження на використання пам'яті, буде використано специфічне для системи +типове м'яке обмеження для можливого обмеження кількості потоків обробки. Це +обмеження є м'яким у сенсі того, що його буде проігноровано, якщо кількість +потоків зрівняється з одиницею, а отже, м'яке обмеження ніколи не +запобігатиму у \fBxz\fP стисканню або розпаковуванню. Це типове м'яке обмеження +не перемкне \fBxz\fP з багатопотокового режиму на однопотоковий режим. Активні +обмеження можна переглянути за допомогою команди \fBxz \-\-info\-memory\fP. +.IP "" +У поточній версії єдиним способом поділу на потоки обробки є поділ вхідних +даних на блоки і стискання цих блоків незалежно один від одного. Типовий +розмір блоку залежить від рівня стискання. Його може бути перевизначено за +допомогою параметра \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Розпакування з потоками обробки працює лише для файлів, які містять декілька +блоків із даними щодо розміру у заголовках блоків. Цю умову задовольняють +усі достатньо великі файли, які стиснено у багатопотоковому режимі, але не +задовольняють будь\-які файли, які було стиснуто у однопотоковому режимі, +навіть якщо було використано параметр \fB\-\-block\-size=\fP\fIрозмір\fP. +.IP "" +Типовим значенням для \fIпотоків\fP є \fB0\fP. У \fBxz\fP 5.4.x та старіших версіях +типовим значенням є \fB1\fP. +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Нетиповий ланцюжок фільтрування уможливлює докладне визначення параметрів +стискання замість використання параметрів, які пов'язано із наперед +визначеними рівнями стискання. Якщо вказано нетиповий ланцюжок фільтрів, +параметри рівнів стискання (\fB\-0\fP \&...\& \fB\-9\fP і \fB\-\-extreme\fP), які +передують їм у рядку команди, буде знехтувано. Якщо параметр рівня стискання +вказано після одного або декількох параметрів нетипового ланцюжка фільтрів, +буде використано рівень стискання, а попередніми параметрами ланцюжка +фільтрування буде знехтувано. +.PP +Ланцюжок фільтрів можна порівняти із конвеєром у командному рядку. При +стисканні нестиснені вхідні дані потрапляють до першого фільтра, виведені +ним дані йдуть до наступного фільтра (якщо такий є). Виведені останнім +фільтром дані буде записано до стисненого файла. Максимальна кількість +фільтрів у ланцюжку дорівнює чотирьом, але у типовому ланцюжку фільтрів +використовують один або два фільтри. +.PP +У багатьох фільтрів є обмеження на місце перебування у ланцюжку фільтрів: +деякі фільтри можуть працювати, лише якщо вони є останніми у ланцюжку, +деякі, лише якщо не останніми, а деякі працюють у будь\-якій позиції +ланцюжка. Залежно від фільтра, це обмеження є наслідком структури фільтра +або існує для запобігання проблем із захистом. +.PP +Нетиповий ланцюжок фільтрів можна вказати двома різними способами. Параметри +\fB\-\-filters=\fP\fIфільтри\fP і \fB\-\-filters1=\fP\fIфільтри\fP \&...\& +\fB\-\-filters9=\fP\fIфільтри\fP надають змогу вказати цілий ланцюжок фільтрів в +одному варіанті з використанням синтаксису рядків фільтрів liblzma. Крім +того, ланцюжок фільтрів можна вказати за допомогою одного або кількох +окремих параметрів фільтрування у тому порядку, в якому їх слід використати +у ланцюжку фільтрів. Тобто порядок окремих параметрів фільтра є важливим! +Під час декодування необроблених потоків (\fB\-\-format=raw\fP) ланцюжок фільтрів +має бути вказано у тому ж порядку, що й під час стиснення. Будь\-який окремий +фільтр або параметри попереднього налаштування, вказані перед параметром +повного ланцюжка (\fB\-\-filters=\fP\fIфільтри\fP), буде відкинуто. Окремі фільтри, +указані після параметра повного ланцюжка, відновлять типовий ланцюжок +фільтрів. +.PP +І параметр повного і параметр окремого фільтра приймають специфічні для +фільтрів \fIпараметри\fP у форматі списку значень, які відокремлено +комами. Зайві коми у \fIпараметрах\fP буде проігноровано. У кожного параметра є +типове значення, отже, вам слід вказати ті параметри, значення яких ви +хочете змінити. +.PP +Щоб переглянути увесь ланцюжок фільтрів та \fIпараметри\fP, скористайтеся +командою \fBxz \-vv\fP (тобто, скористайтеся \fB\-\-verbose\fP двічі). Це працює +також для перегляду параметрів ланцюжка фільтрів, який використано у рівнях +стискання. +.TP +\fB\-\-filters=\fP\fIфільтри\fP +Визначає повний ланцюжок фільтрів або шаблон у форматі одного +параметра. Кожен фільтр можна відокремити від інших пробілами або двома +дефісами (\fB\-\-\fP). Можливо, \fIфільтри\fP доведеться взяти в лапки в командному +рядку оболонки, щоб їх було оброблено як один параметр. Для позначення +\fIпараметрів\fP скористайтеся \fB:\fP або \fB=\fP. До шаблона можна додати префікс +\fB\-\fP і завершити без прапорців або декількома прапорцями. Єдиним +підтримуваним прапорцем є \fBe\fP для застосування тих самих параметрів, що й +\fB\-\-extreme\fP. +.TP +\fB\-\-filters1\fP=\fIфільтри\fP ... \fB\-\-filters9\fP=\fIфільтри\fP +Вказати до дев'яти додаткових ланцюжків фільтрів, якими можна скористатися +за допомогою \fB\-\-block\-list\fP. +.IP "" +Наприклад, якщо виконується стискання архіву із виконуваними файлами, за +якими йдуть текстові файли, для виконуваної частини може бути використано +ланцюжок фільтрів з фільтром BCJ, а для текстової частини — лише фільтр +LZMA2. +.TP +\fB\-\-filters\-help\fP +Вивести довідкове повідомлення з описом того, як вказати шаблони та нетипові +ланцюжки фільтрів у параметри \fB\-\-filters\fP і \fB\-\-filters1=\fP\fIфільтри\fP +\&...\& \fB\-\-filters9=\fP\fIфільтри\fP і завершити роботу із кодом успіху. +.TP +\fB\-\-lzma1\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-lzma2\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр LZMA1 або LZMA2 до ланцюжка фільтрів. Ці фільтри може бути +використано лише як останній фільтр у ланцюжку. +.IP "" +LZMA1 є застарілим фільтром, підтримку якого збережено майже лише через +використання формату файлів \fB.lzma\fP, у яких передбачено підтримку лише +LZMA1. LZMA2 є оновленою версією LZMA1, у якій виправлено деякі практичні +вади LZMA1. У форматі \fB.xz\fP використано LZMA2 і взагалі не передбачено +підтримки LZMA1. Швидкість стискання та коефіцієнт стискання для LZMA1 і +LZMA2 є практично однаковими. +.IP "" +LZMA1 і LZMA2 спільно використовують той самий набір \fIпараметрів\fP: +.RS +.TP +.\" TRANSLATORS: Don't translate bold strings like B, B, +.\" B, B, B, or B because those are command line +.\" options. On the other hand, do translate the italic strings like +.\" I, I, and I, because such italic strings are +.\" placeholders which a user replaces with an actual value. +\fBpreset=\fP\fIшаблон\fP +Скинути усі \fIпараметри\fP LZMA1 або LZMA2 до параметрів \fIшаблона\fP. Аргумент +\fIшаблон\fP складається з цілого числа, після якого може бути однолітерний +модифікатор шаблона. Ціле число може належати лише діапазону від \fB0\fP до +\fB9\fP, що відповідає параметрам командного рядка \fB\-0\fP \&...\& \fB\-9\fP. Єдиним +підтримуваним модифікатором у поточній версії є \fBe\fP, щоб відповідає +параметру \fB\-\-extreme\fP. Якщо аргумент \fBшаблон\fP не вказано, типові значення +\fIпараметрів\fP LZMA1 або LZMA2 буде взято із шаблона \fB6\fP. +.TP +\fBdict=\fP\fIрозмір\fP +Параметр \fIрозміру\fP словника (буфера журналу) визначає, скільки байтів +нещодавно оброблених нестиснених даних слід зберігати у пам'яті. Алгоритм +намагається знайти повторювані послідовності байтів (відповідники) у +нестиснених даних і замінити їх на посилання на дані зі словника. Чим +більшим є словник, тим вищою є ймовірність відшукати відповідник. Отже, +збільшення \fIрозміру\fP словника, зазвичай, покращує коефіцієнт стискання, але +використання словника, розмір якого перевищу є розмір нестисненого файла є +простоюю витратою пам'яті. +.IP "" +\fIРозмір\fP типового словника складає від 64\ КіБ до 64\ МіБ. Мінімальним є +розмір 4\ КіБ. Максимальним розміром для стискання у поточній версії 1.5\ ГіБ (1536\ МіБ). У засобі розпаковування вже передбачено підтримку словників +на один байт менших за 4\ ГіБ, що є максимальним значенням для форматів +потоків даних LZMA1 і LZMA2. +.IP "" +Аргумент \fIрозміру\fP словника і засіб пошуку відповідників (\fImf\fP) разом +визначають параметри використання пам'яті для кодувальника LZMA1 або +LZMA2. Для розпаковування потрібен такий самий (або більший) \fIрозмір\fP +словника, що і для стискання, отже, використання пам'яті для засобу +розпаковування буде визначено за розміром словника, який було використано +для стискання. У заголовках \fB.xz\fP зберігається \fIрозмір\fP словника або як +2^\fIn\fP, або як 2^\fIn\fP + 2^(\fIn\fP\-1), отже, ці \fIрозміри\fP є дещо пріоритетними +для стискання. Інші \fIрозміри\fP буде отримано округленням при зберіганні у +заголовках \fB.xz\fP. +.TP +\fBlc=\fP\fIlc\fP +Визначає кількість буквальних контекстних бітів. Мінімальною кількістю є 0, +а максимальною — 4. Типовою кількістю є 3. Крім того, сума \fIlc\fP і \fIlp\fP має +не перевищувати 4. +.IP "" +Усі байти, які не може бути закодовано як відповідності, буде закодовано як +літерали. Тобто літерали є просто 8\-бітовими байтами, які буде закодовано по +одному за раз. +.IP "" +При кодуванні літералів роблять припущення, що найвищі біти \fIlc\fP +попереднього нестисненого байта корелюють із наступним байтом. Наприклад, у +типовому тексті англійською за літерою у верхньому регістрі йде літера у +нижньому регістрі, а за літерою у нижньому регістрі, зазвичай, йде інша +літера у нижньому регістрі. У наборі символів US\-ASCII найвищими трьома +бітами є 010 для літер верхнього регістру і 011 для літер нижнього +регістру. Якщо \fIlc\fP дорівнює принаймні 3, при кодуванні літералів можна +отримати перевагу встановлення цієї властивості для нестиснених даних. +.IP "" +Зазвичай, типового значення (3) достатньо. Якщо вам потрібне максимальне +стискання, спробуйте \fBlc=4\fP. Іноді це трохи допомагає, а іноді, робить +стискання гіршим. Якщо стискання стане гіршим, спробуйте також \fBlc=2\fP. +.TP +\fBlp=\fP\fIlp\fP +Визначає кількість буквальних позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 0. +.IP "" +\fILp\fP впливає на те, яке вирівнювання у нестиснених даних слід припускати +при кодуванні літералів. Див. \fIpb\fP нижче, щоб дізнатися більше про +вирівнювання. +.TP +\fBpb=\fP\fIpb\fP +Визначає кількість позиційних бітів. Мінімальною кількістю є 0, а +максимальною — 4. Типовою кількістю є 2. +.IP "" +\fIPb\fP впливає на те, який тип вирівнювання загалом припускатиметься для +нестиснених даних. Типовим є чотирибайтове вирівнювання (2^\fIpb\fP=2^2=4), +яке, зазвичай, є добрим варіантом, якщо немає кращих припущень. +.IP "" +Якщо вирівнювання є відомим, встановлення відповідним чином \fIpb\fP може трохи +зменшити розмір файла. Наприклад, у текстових файлах із однобайтовим +вирівнюванням (US\-ASCII, ISO\-8859\-*, UTF\-8), встановлення значення \fBpb=0\fP +може трохи поліпшити стискання. Для тексту UTF\-16 добрим варіантом є +\fBpb=1\fP. Якщо вирівнювання є непарним числом, наприклад 3 байти, найкращим +вибором, ймовірно, є \fBpb=0\fP. +.IP "" +Хоча прогнозоване вирівнювання можна скоригувати за допомогою \fIpb\fP і \fIlp\fP, +у LZMA1 і LZMA2 дещо пріоритетним є 16\-байтове вирівнювання. Це, ймовірно, +слід враховувати при компонуванні форматів файлів, які, ймовірно, часто +будуть стискатися з використанням LZMA1 або LZMA2. +.TP +\fBmf=\fP\fImf\fP +Засіб пошуку відповідників має значний вплив на швидкість, використання +пам'яті та коефіцієнт стискання кодувальника. Зазвичай, засоби пошуку +відповідників на основі ланцюжка хешів є швидшими за засоби пошуку +відповідників на основі двійкового дерева. Типовий засіб залежить від +\fIшаблона\fP: для 0 використовують \fBhc3\fP, для 1\(en3 — \fBhc4\fP, а для решти +використовують \fBbt4\fP. +.IP "" +Передбачено підтримку вказаних нижче засобів пошуку відповідників. Наведені +нижче формули обчислення використання пам'яті є грубими наближеннями, які є +найближчими до реальних значень, якщо значенням \fIсловник\fP є степінь двійки. +.RS +.TP +\fBhc3\fP +Ланцюжок хешів із 2\- та 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 5.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBhc4\fP +Ланцюжок хешів із 2\-, 3\- та 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 7.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 6.5 (якщо \fIdict\fP > 32 МіБ) +.TP +\fBbt2\fP +Двійкове дерево із 2\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 2 +.br +Використання пам'яті: \fIdict\fP * 9.5 +.TP +\fBbt3\fP +Двійкове дерево із 2\- і 3\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 3 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 16 МіБ); +.br +\fIdict\fP * 9.5 + 64 МіБ (якщо \fIdict\fP > 16 МіБ) +.TP +\fBbt4\fP +Двійкове дерево із 2\-, 3\- і 4\-байтовим хешуванням +.br +Мінімальне значення \fIпріоритетності\fP: 4 +.br +Використання пам'яті: +.br +\fIdict\fP * 11.5 (якщо \fIdict\fP <= 32 МіБ); +.br +\fIdict\fP * 10.5 (якщо \fIdict\fP > 32 МіБ) +.RE +.TP +\fBmode=\fP\fIрежим\fP +Параметр \fIрежиму\fP стискання визначає спосіб, який буде використано для +аналізу даних, які створено засобом пошуку відповідників. Підтримуваними +\fIрежимами\fP є \fBfast\fP (швидкий) і \fBnormal\fP (нормальний). Типовим є режим +\fBfast\fP для \fIшаблонів\fP 0\(en3 і режим \fBnormal\fP для \fIшаблонів\fP 4\(en9. +.IP "" +Зазвичай, із засобом пошуку відповідників на основі ланцюжка хешів +використовують \fBfast\fP, а із засобом пошуку відповідників на основі +двійкового дерева використовують \fBnormal\fP. Так само налаштовано і +\fIшаблони\fP. +.TP +\fBnice=\fP\fIпріоритетність\fP +Вказати, яка довжина є пріоритетною для відповідності. Щойно буде виявлено +відповідність у принаймні \fIпріоритетність\fP байтів, алгоритм зупинятиме +пошук можливих кращих відповідників. +.IP "" +\fIПріоритетністю\fP може бути число до 2\(en273 байтів. Вищі значення дають +кращий коефіцієнт стискання за рахунок швидкості. Типове значення залежить +від \fIшаблона\fP. +.TP +\fBdepth=\fP\fIглибина\fP +Вказати максимальну глибину пошуку у засобі пошуку відповідності. Типовим є +особливе значення 0, яке наказує засобу стискання визначити прийнятну +\fIглибину\fP на основі \fImf\fP і \fIпріоритетності\fP. +.IP "" +Прийнятним значенням \fIглибини\fP для ланцюжків хешів є 4\(en100 і 16\(en1000 +для двійкових дерев. Використання дуже високих значень для \fIглибини\fP може +зробити кодувальник дуже повільним для деяких файлів. Не встановлюйте +значення \fIглибини\fP, що перевищує 1000, якщо ви не готові перервати +стискання, якщо воно триватиме надто довго. +.RE +.IP "" +При декодуванні необроблених потоків даних (\fB\-\-format=raw\fP), LZMA2 потребує +лише \fIрозміру\fP словника. LZMA1 потребує також \fIlc\fP, \fIlp\fP і \fIpb\fP. +.TP +\fB\-\-x86\fP[\fB=\fP\fIпараметри\fP] +.PD 0 +.TP +\fB\-\-arm\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-armthumb\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-arm64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-powerpc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-ia64\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-sparc\fP[\fB=\fP\fIпараметри\fP] +.TP +\fB\-\-riscv\fP[\fB=\fP\fIпараметри\fP] +.PD +Додати фільтр гілок/викликів/переходів (branch/call/jump або BCJ) до +ланцюжка фільтрів. Цими фільтрами можна скористатися, лише якщо вони не є +останнім фільтром у ланцюжку фільтрів. +.IP "" +Фільтр BCJ перетворює відносні адреси у машинному коді на їхні абсолютні +відповідники. Це не змінює розміру даних, але підвищує резервування, що може +допомогти LZMA2 створити файл \fB.xz\fP на 0\(en15\ % менше. Фільтри BCJ завжди +є придатними до обернення, тому використання фільтра BCJ до помилкового типу +даних не спричинятиме втрати даних, хоча може дещо погіршити коефіцієнт +стискання. Фільтри BCJ є дуже швидкими і такими, що використовують незначний +об'єм пам'яті. +.IP "" +Ці фільтри BCJ мають відомі проблеми, які пов'язано із рівнем стискання: +.RS +.IP \(bu 3 +У деяких типах файлів, де зберігається виконуваний код, (наприклад, в +об'єктних файлах, статичних бібліотеках та модулях ядра Linux) адреси в +інструкціях заповнено значеннями заповнювача. Ці фільтри BCJ виконуватимуть +перетворення адрес, яке зробить стискання для цих файлів гіршим. +.IP \(bu 3 +Якщо фільтр BCJ застосовано до архіву, може так статися, що він погіршить +коефіцієнт стискання порівняно із варіантом без фільтра BCJ. Наприклад, якщо +є подібні або навіть однакові виконувані файли, фільтрування, ймовірно, +зробить ці файли менш подібними, а отже, зробить стискання гіршим. Вміст +файлів, які не є виконуваними, у тому самому архіві також може вплинути на +результат. На практиці, варто спробувати варіанти з фільтром BCJ і без +нього, щоб визначитися із тим, що буде кращим у кожній ситуації. +.RE +.IP "" +Різні набори інструкцій мають різне вирівнювання: виконуваний файл має бути +вирівняно на кратне до цього значення у вхідних даних, щоб фільтр спрацював. +.RS +.RS +.PP +.TS +tab(;); +l n l +l n l. +Фільтр;Вирівнювання;Нотатки +x86;1;32\-бітова або 64\-бітова x86 +ARM;4; +ARM\-Thumb;2; +ARM64;4;Найкращим є вирівнювання за +;;4096 байтами +PowerPC;4;Лише зворотний порядок байтів +IA\-64;16;Itanium +SPARC;4; +RISC\-V;2; +.TE +.RE +.RE +.IP "" +Оскільки фільтровані BCJ дані, зазвичай, стискають за допомогою LZMA2, +коефіцієнт стискання можна трохи поліпшити, якщо параметри LZMA2 буде +встановлено так, щоб вони відповідали вирівнюванню вибраного фільтра +BCJ. Приклади: +.RS +.IP \(bu 3 +Фільтр IA\-64 має 16\-байтове вирівнювання, отже \fBpb=4,lp=4,lc=0\fP дасть добрі +результати у поєднанні із LZMA2 (2^4=16). +.IP \(bu 3 +Код RISC\-V має 2\-байтове або 4\-байтове вирівнювання залежно від того, чи +містить файл 16\-бітові стислі інструкції (розширення C). Якщо використано +16\-бітові інструкції, добрі результати дасть \fBpb=2,lp=1,lc=3\fP або +\fBpb=1,lp=1,lc=3\fP. Якщо 16\-бітових інструкцій немає, найкращим варіантом є +\fBpb=2,lp=2,lc=2\fP. Можна скористатися \fBreadelf \-h\fP, щоб перевірити, чи є +"RVC" у рядку "Flags". +.IP \(bu 3 +ARM64 завжди вирівняно на 4 байти, тому найкращим варіантом буде +\fBpb=2,lp=2,lc=2\fP. +.IP \(bu 3 +Фільтр x86 є виключенням. Зазвичай, добрі результати дають типові для LZMA2 +значення (\fBpb=2,lp=0,lc=3\fP), якщо стискають виконувані файли x86. +.RE +.IP "" +У всіх фільтрах BCJ передбачено підтримку тих самих \fIпараметрів\fP: +.RS +.TP +\fBstart=\fP\fIзсув\fP +Встановити початковий \fIзсув\fP, який буде використано при перетворенні між +відносною та абсолютною адресами. Значення \fIзсув\fP має бути кратним до +вирівнювання фільтра (див. таблицю вище). Типовим зсувом є нульовий. На +практиці, типове значення є прийнятним; визначення нетипового значення +\fIзсув\fP майже завжди нічого корисного не дає. +.RE +.TP +\fB\-\-delta\fP[\fB=\fP\fIпараметри\fP] +Додати дельта\-фільтр до ланцюжка фільтрів. Дельта\-фільтр може бути +використано, лише якщо він не є останнім у ланцюжку фільтрів. +.IP "" +У поточній версії передбачено підтримку обчислення лише простої побітової +дельти. Це може бути корисним при стисканні, наприклад, нестиснутих +растрових зображень або нестиснутих звукових даних PCM. Втім, спеціалізовані +алгоритми можуть давати значно кращі результати за дельту + LZMA2. Це +правило особливо стосується звукових даних, які стискає швидше і краще, +наприклад, \fBflac\fP(1). +.IP "" +Підтримувані \fIпараметри\fP: +.RS +.TP +\fBdist=\fP\fIвідстань\fP +Вказати \fIвідстань\fP обчислень різниці у байтах. Значення \fIвідстань\fP має +потрапляти у діапазон 1\(en256. Типовим значенням є 1. +.IP "" +Наприклад, з \fBdist=2\fP та восьмибайтовими вхідними даними A1 B1 A2 B3 A3 B5 +A4 B7, результатом буде A1 B1 01 02 01 02 01 02. +.RE +. +.SS "Інші параметри" +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Придушити попередження та сповіщення. Вкажіть цей параметр двічі, щоб +придушити також повідомлення про помилки. Цей параметр не впливає на стан +виходу з програми. Тобто, навіть якщо було придушено попередження, стан +виходу вказуватиме на те, що попередження були. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Докладний режим повідомлень. Якщо стандартне виведення помилок з'єднано із +терміналом, \fBxz\fP показуватиме індикатор поступу. Використання \fB\-\-verbose\fP +двічі призведе до ще докладнішого виведення. +.IP "" +Індикатор поступу показує такі дані: +.RS +.IP \(bu 3 +Частку завершеності буде показано, якщо відомий розмір файла вхідних +даних. Тобто, для каналів даних частку не може бути показано. +.IP \(bu 3 +Об'єм стиснених виведених даних (стискання) або оброблених (розпаковування). +.IP \(bu 3 +Об'єм незапакованих даних (стискання) або виведених даних (розпаковування). +.IP \(bu 3 +Коефіцієнт стискання, який обчислено діленням об'єму оброблених стиснутих +даних на об'єм оброблених нестиснутих даних. +.IP \(bu 3 +Швидкість стискання або розпаковування. Обчислюється як об'єм нестиснутих +даних (стискання) або виведених даних (розпаковування) за секунду. Його буде +показано за декілька секунд з моменту, коли \fBxz\fP почала обробляти файл. +.IP \(bu 3 +Витрачений час у форматі Х:СС або Г:ХХ:СС. +.IP \(bu 3 +Оцінку часу, що лишився, буде показано, лише якщо розмір файла вхідних даних +є відомим, і минуло принаймні декілька секунд з моменту, коли \fBxz\fP почала +обробляти файл. Час буде показано у менш точному форматі, без двокрапок, +наприклад, 2 хв. 30 с. +.RE +.IP "" +Якщо стандартним виведенням помилок не є термінал, \fB\-\-verbose\fP призведе до +того, що \fBxz\fP виведе назву файла, стиснений розмір, нестиснений розмір, +коефіцієнт стискання та, можливо, також швидкість та витрачений час у одному +рядку до стандартного виведення помилок після стискання або розпаковування +файла. Швидкість та витрачений час буде включено, лише якщо дія триває +принаймні декілька секунд. Якщо дію не буде завершено, наприклад, через +втручання користувача, буде також виведено частку виконання, якщо відомий +розмір файла вхідних даних. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Не встановлювати стан виходу 2, навіть якщо було виявлено відповідність +умові, яка варта попередження. Цей параметр не впливає на рівень докладності +повідомлень, отже, слід використати \fB\-\-quiet\fP і \fB\-\-no\-warn\fP, щоб програма +не показувала попереджень і не змінювала стан виходу. +.TP +\fB\-\-robot\fP +Виводити повідомлення у придатному для обробки комп'ютером форматі. Цей +формат призначено для полегшення написання оболонок, які використовуватимуть +\fBxz\fP замість liblzma, що може бути зручним для різноманітних +скриптів. Виведені дані з цим параметром має бути стабільним для усіх +випусків \fBxz\fP. Докладніший опис можна знайти у розділі \fBРЕЖИМ РОБОТА\fP. +.TP +\fB\-\-info\-memory\fP +Вивести у придатному для читання людиною форматі, скільки фізичної пам'яті +(RAM) та скільки потоків процесора є за даними \fBxz\fP у системі, обмеження +для стискання та розпаковування, а потім успішно завершити роботу. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести повідомлення про помилку з описом найбільш типових використаних +параметрів і успішно завершити роботу. +.TP +\fB\-H\fP, \fB\-\-long\-help\fP +Вивести довідкове повідомлення з описом усіх можливостей \fBxz\fP і успішно +завершити роботу +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxz\fP та liblzma у зручному для читання форматі. Щоб +отримати дані, зручні для обробки на комп'ютері, вкажіть \fB\-\-robot\fP до +\fB\-\-version\fP. +. +.SH "РЕЖИМ РОБОТА" +Режим робота активують за допомогою параметра \fB\-\-robot\fP. Він спрощує +обробку виведених \fBxz\fP даних іншими програмами. У поточній версії підтримку +\fB\-\-robot\fP передбачено лише разом із \fB\-\-list\fP, \fB\-\-filters\-help\fP, +\fB\-\-info\-memory\fP і \fB\-\-version\fP. У майбутньому підтримку параметра буде +передбачено для стискання та розпаковування. +. +.SS "Режим списку" +У \fBxz \-\-robot \-\-list\fP використано табуляції для поділу виведених +даних. Першим стовпчиком у кожному рядку є рядок, що вказує на тип +відомостей, які можна знайти у цьому рядку: +.TP +.\" TRANSLATORS: The bold strings B, B, B, B, +.\" B, and B are produced by the xz tool for scripts to +.\" parse, thus the untranslated strings must be included in the translated +.\" man page. It may be useful to provide a translated string in parenthesis +.\" without bold, for example: "B (nimi)" +\fBname\fP +Це завжди перший рядок на початку списку файла. Другим стовпчиком у рядку є +назва файла. +.TP +\fBfile\fP +У цьому рядку містяться загальні відомості щодо файла \fB.xz\fP. Цей рядок +завжди виводять після рядка \fBname\fP. +.TP +\fBstream\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBstream\fP, скільки потоків у файлі \fB.xz\fP. +.TP +\fBblock\fP +Цей тип рядка використовують, лише якщо було вказано \fB\-\-verbose\fP. Буде +стільки рядків \fBblock\fP, скільки блоків у файлі \fB.xz\fP. Рядки \fBblock\fP буде +показано після усіх рядків \fBstream\fP; різні типи рядків не перемежовуються. +.TP +\fBsummary\fP +Цей тип рядків використовують, лише якщо \fB\-\-verbose\fP було вказано +двічі. Цей рядок буде виведено після усіх рядків \fBblock\fP. Подібно до рядка +\fBfile\fP, рядок \fBsummary\fP містить загальні відомості щодо файла \fB.xz\fP. +.TP +\fBtotals\fP +Цей рядок завжди є найостаннішим рядком у виведеному списку. У ньому буде +показано загальні кількості та розміри. +.PP +Стовпчики у рядках \fBфайла\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків у файлі +.IP 3. 4 +Загальна кількість блоків у потоках +.IP 4. 4 +Розмір стисненого файла +.IP 5. 4 +Розмір нестисненого файла +.IP 6. 4 +Коефіцієнт стискання, наприклад, \fB0.123\fP. Якщо коефіцієнт перевищує 9.999, +замість коефіцієнта буде показано дефіси (\fB\-\-\-\fP). +.IP 7. 4 +.\" TRANSLATORS: Don't translate the bold strings B, B, +.\" B, B, or B here. In robot mode, xz produces +.\" them in untranslated form for scripts to parse. +Список відокремлених комами назв перевірок цілісності. Наведені нижче рядки +використовують для відомих типів перевірок: \fBNone\fP, \fBCRC32\fP, \fBCRC64\fP і +\fBSHA\-256\fP. Для невідомих типів перевірок буде використано \fBUnknown\-\fP\fIN\fP, +де \fIN\fP є ідентифікатором перевірки у форматі десяткового числа (одна або +дві цифри). +.IP 8. 4 +Загальний розмір доповнення потоку у файлі +.RE +.PD +.PP +Стовпчики у рядках \fBstream\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку (перший потік має номер 1) +.IP 3. 4 +Кількість блоків у потоці +.IP 4. 4 +Зсув початку стисненого +.IP 5. 4 +Зсув початку нестисненого +.IP 6. 4 +Стиснений розмір (не включає доповнення потоку) +.IP 7. 4 +Нестиснутий розмір +.IP 8. 4 +Рівень стискання +.IP 9. 4 +Назва перевірки цілісності +.IP 10. 4 +Розмір доповнення потоку +.RE +.PD +.PP +Стовпчики у рядках \fBblock\fP: +.PD 0 +.RS +.IP 2. 4 +Номер потоку, що містить цей блок +.IP 3. 4 +Номер блоку відносно початку потоку (перший блок має номер 1) +.IP 4. 4 +Номер блоку відносно початку файла +.IP 5. 4 +Зсув початку стисненого відносно початку файла +.IP 6. 4 +Зсув початку нестисненого відносно початку файла +.IP 7. 4 +Загальний стиснений розмір блоку (включено з заголовками) +.IP 8. 4 +Нестиснутий розмір +.IP 9. 4 +Рівень стискання +.IP 10. 4 +Назва перевірки цілісності +.RE +.PD +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядків \fBblock\fP буде включено +додаткові стовпчики. Ці стовпчики не буде показано, якщо вказано одинарний +параметр \fB\-\-verbose\fP, оскільки отримання цих відомостей потребує багатьох +позиціювань, а ця процедура може бути повільною: +.PD 0 +.RS +.IP 11. 4 +Значення перевірки цілісності у шістнадцятковій формі +.IP 12. 4 +Розмір заголовка блоку +.IP 13. 4 +Прапорці блоку: \fBc\fP вказує, що наявний стиснений розмір, а \fBu\fP вказує, що +наявний нестиснений розмір. Якщо прапорець не встановлено, буде показано +(\fB\-\fP) замість підтримання фіксованого розміру рядка. У майбутньому +наприкінці рядка може бути додано нові прапорці. +.IP 14. 4 +Розмір справжніх стиснених даних у блоці (це включає заголовок блоку, +доповнення блоку та поля перевірок) +.IP 15. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього блоку за +допомогою цієї версії \fBxz\fP +.IP 16. 4 +Ланцюжок фільтрів. Зауважте, що більшість параметрів, які використано під +час стискання, не є наперед відомим, оскільки у заголовках \fB.xz\fP +зберігаються лише параметри, які потрібні для розпаковування. +.RE +.PD +.PP +Стовпчики у рядках \fBsummary\fP: +.PD 0 +.RS +.IP 2. 4 +Об'єм пам'яті (у байтах), який потрібен для розпаковування цього файла за +допомогою цієї версії \fBxz\fP +.IP 3. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 4. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +Стовпчики рядка \fBtotals\fP: +.PD 0 +.RS +.IP 2. 4 +Кількість потоків +.IP 3. 4 +Кількість блоків +.IP 4. 4 +Стиснутий розмір +.IP 5. 4 +Нестиснутий розмір +.IP 6. 4 +Середній коефіцієнт стискання +.IP 7. 4 +Список відокремлених комами назв перевірок цілісності, результати яких +наявні у файлах +.IP 8. 4 +Розмір доповнення потоку +.IP 9. 4 +Кількість файлів. Наявний тут для зберігання такого самого порядку +стовпчиків, що і у попередніх рядках \fBfile\fP. +.PD +.RE +.PP +Якщо \fB\-\-verbose\fP було вказано двічі, до рядка \fBtotals\fP буде включено +додаткові стовпчики: +.PD 0 +.RS +.IP 10. 4 +Максимальний об'єм пам'яті (у байтах), який потрібен для розпаковування +файлів за допомогою цієї версії \fBxz\fP +.IP 11. 4 +\fByes\fP або \fBno\fP вказує, якщо усі заголовки блоків містять одразу стиснений +розмір та розпакований розмір +.PP +\fIПочинаючи з\fP \fBxz\fP \fI5.1.2alpha:\fP +.IP 12. 4 +Мінімальна версія \fBxz\fP, яка потрібна для розпаковування файла +.RE +.PD +.PP +У майбутніх версіях може бути додано нові типи рядків і нові стовпчики до +наявних типів рядків, але наявні стовпчики мають лишитися незмінними. +. +.SS "Довідка з фільтрування" +\fBxz \-\-robot \-\-filters\-help\fP виведе список підтримуваних фільтрів у такому +форматі: +.PP +\fIфільтр\fP\fB:\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>,\fP\fIпараметр\fP\fB=<\fP\fIзначення\fP\fB>\fP... +.TP +\fIфільтр\fP +Назва фільтра +.TP +\fIпараметр\fP +Назва специфічного для фільтра параметра +.TP +\fIзначення\fP +Числові діапазони \fIvalue\fP слід вказати у форматі +\fB<\fP\fIмінімум\fP\fB\-\fP\fIмаксимум\fP\fB>\fP. Варіанти рядка \fIзначення\fP +показано у \fB< >\fP і відокремлено символом \fB|\fP. +.PP +Кожен фільтр буде виведено до окремого рядка. +. +.SS "Дані щодо обмеження пам'яті" +\fBxz \-\-robot \-\-info\-memory\fP виводить один рядок з декількома відокремленими +табуляціями стовпчиками: +.IP 1. 4 +Загальний об'єм фізичної пам'яті (RAM) у байтах. +.IP 2. 4 +Обмеження на використання пам'яті для стискання у байтах +(\fB\-\-memlimit\-compress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 3. 4 +Обмеження на використання пам'яті для розпакування у байтах +(\fB\-\-memlimit\-decompress\fP). Особливе значення \fB0\fP вказує на типові +налаштування, якими для однопотокового режиму є налаштування без обмеження +на використання пам'яті. +.IP 4. 4 +Починаючи з \fBxz\fP 5.3.4alpha: використання пам'яті для багатопотокового +розпаковування у байтах (\fB\-\-memlimit\-mt\-decompress\fP). Ніколи не дорівнює +нулеві, оскільки буде використано специфічне для системи типове значення, +яке показано у стовпчику 5, якщо обмеження не встановлено явним чином. Також +ніколи не перевищуватиме значення у стовпчику 3, навіть якщо було вказано +більше значення за допомогою \fB\-\-memlimit\-mt\-decompress\fP. +.IP 5. 4 +Починаючи з \fBxz\fP 5.3.4alpha: специфічне для системи типове обмеження на +використання пам'яті, яке використовують для обмеження кількості потоків при +стисканні з автоматичною кількістю потоків (\fB\-\-threads=0\fP) і без визначення +обмеження на використання пам'яті (\fB\-\-memlimit\-compress\fP). Це значення +також використовують як типове значення для \fB\-\-memlimit\-mt\-decompress\fP. +.IP 6. 4 +Починаючи з \fBxz\fP 5.3.4alpha: кількість доступних потоків обробки процесора. +.PP +У майбутньому у виведенні \fBxz \-\-robot \-\-info\-memory\fP може бути більше +стовпчиків, але у виведеному буде не більше за один рядок. +. +.SS Версія +\fBxz \-\-robot \-\-version\fP виведе назву версії \fBxz\fP і liblzma у такому +форматі: +.PP +.\" TRANSLATORS: Don't translate the uppercase XZ_VERSION or LIBLZMA_VERSION. +\fBXZ_VERSION=\fP\fIXYYYZZZS\fP +.br +\fBLIBLZMA_VERSION=\fP\fIXYYYZZZS\fP +.TP +\fIX\fP +Основна версія. +.TP +\fIYYY\fP +Проміжна версія. Непарні номери буде використано для стабільних +версій. Непарні номери є номерами тестових версій. +.TP +\fIZZZ\fP +Рівень латання для стабільних випусків або просто лічильник для випусків, +які перебувають у розробці. +.TP +\fIS\fP +Стабільність. 0 — alpha, 1 — beta, а 2 означає «стабільна версія». \fIS\fP має +завжди дорівнювати 2, якщо \fIYYY\fP є парним. +.PP +\fIXYYYZZZS\fP є тим самим в обох рядках, якщо \fBxz\fP і liblzma належать до +одного випуску XZ Utils. +.PP +Приклади: 4.999.9beta — це \fB49990091\fP, а 5.0.0 — це \fB50000002\fP. +. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.TP +\fB2\fP +Сталося щось варте попередження, але справжніх помилок не сталося. +.PP +Зауваження (не попередження або помилки), які виведено до стандартного +виведення помилок, не впливають на стан виходу. +. +.SH СЕРЕДОВИЩЕ +.\" TRANSLATORS: Don't translate the uppercase XZ_DEFAULTS or XZ_OPT. +.\" They are names of environment variables. +\fBxz\fP обробляє списки відокремлених пробілами параметрів зі змінних +середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP, перш ніж обробляти параметри з рядка +команди. Зауважте, що буде оброблено лише параметри зі змінних середовища; +усі непараметричні записи буде без повідомлень проігноровано. Обробку буде +виконано за допомогою функції \fBgetopt_long\fP(3), яку також використовують +для аргументів рядка команди. +.PP +\fBПопередження:\fP Встановлюючи ці змінні середовища, ви насправді змінюєте +програми та скрипти, які виконують \fBxz\fP. У більшості випадків без проблем +можна встановлювати обмеження на використання пам'яті, кількість потоків і +параметри стиснення за допомогою змінних середовища. Однак деякі параметри +можуть порушити роботу скриптів. Очевидним прикладом є \fB\-\-help\fP, який +змушує \fBxz\fP показувати текст довідки замість стискання або розпаковування +файла. Менш очевидними є приклади \fB\-\-quiet\fP і \fB\-\-verbose\fP. У багатьох +випадках усе працюватиме добре, якщо увімкнути індикатор поступу за +допомогою \fB\-\-verbose\fP, але у деяких ситуаціях додаткові повідомлення +створюють проблеми. Рівень докладності також впливає на поведінку \fB\-\-list\fP. +.TP +\fBXZ_DEFAULTS\fP +Специфічні для користувача або загальносистемні типові параметри. Зазвичай, +їх встановлюють у скрипті ініціалізації оболонки для типового вмикання +обмеження на використання пам'яті у \fBxz\fP або встановлення типової кількості +потоків обробки. Окрім скриптів ініціалізації оболонки і подібних особливих +випадків, не слід встановлювати або скасовувати встановлення значення +\fBXZ_DEFAULTS\fP у скриптах. +.TP +\fBXZ_OPT\fP +Цю змінну призначено для передавання параметрів до \fBxz\fP, якщо неможливо +встановити параметри безпосередньо у рядку команди \fBxz\fP. Це трапляється, +якщо \fBxz\fP запущено скриптом або інструментом, наприклад, GNU \fBtar\fP(1): +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=\-2v tar caf foo.tar.xz foo\fR +.fi +.RE +.RE +.IP "" +Скрипти можуть використовувати \fBXZ_OPT\fP, наприклад, для встановлення +специфічних типових параметрів стискання. Втім, рекомендуємо дозволити +користувачам перевизначати \fBXZ_OPT\fP, якщо це має якісь причини. Наприклад, +у скриптах \fBsh\fP(1) можна скористатися чимось таким: +.RS +.RS +.PP +.nf +\f(CRXZ_OPT=${XZ_OPT\-"\-7e"} +export XZ_OPT\fR +.fi +.RE +.RE +. +.SH "СУМІСНІСТЬ ІЗ LZMA UTILS" +Синтаксис рядка команди \fBxz\fP практично є надбудовою щодо \fBlzma\fP, \fBunlzma\fP +і \fBlzcat\fP з LZMA Utils 4.32.x. У більшості випадків можна замінити LZMA +Utils XZ Utils без порушення працездатності наявних скриптів. Втім, існують +певні несумісності, які іноді можуть спричиняти проблеми. +. +.SS "Рівні шаблонів стискання" +Нумерація у шаблонах рівнів стискання у \fBxz\fP не є тотожною до нумерації у +LZMA Utils. Найважливішою відмінністю є прив'язка розмірів словника до +різних шаблонів. Розмір словника грубо рівний використанню пам'яті у засобі +розпаковування. +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils +\-0;256 КіБ;н/д +\-1;1 МіБ;64 КіБ +\-2;2 МіБ;1 МіБ +\-3;4 МіБ;512 КіБ +\-4;4 МіБ;1 МіБ +\-5;8 МіБ;2 МіБ +\-6;8 МіБ;4 МіБ +\-7;16 МіБ;8 МіБ +\-8;32 МіБ;16 МіБ +\-9;64 МіБ;32 МіБ +.TE +.RE +.PP +Відмінності у розмірах словників також впливають на використання пам'яті +засобом стискання, але є і інші відмінності між LZMA Utils і XZ Utils, які +роблять різницю ще помітнішою: +.RS +.PP +.TS +tab(;); +c c c +c n n. +Рівень;xz;LZMA Utils 4.32.x +\-0;3 МіБ;н/д +\-1;9 МіБ;2 МіБ +\-2;17 МіБ;12 МіБ +\-3;32 МіБ;12 МіБ +\-4;48 МіБ;16 МіБ +\-5;94 МіБ;26 МіБ +\-6;94 МіБ;45 МіБ +\-7;186 МіБ;83 МіБ +\-8;370 МіБ;159 МіБ +\-9;674 МіБ;311 МіБ +.TE +.RE +.PP +Типовим рівнем стискання у LZMA Utils є \fB\-7\fP, а у XZ Utils — \fB\-6\fP, отже, +обидва комплекти програм типово використовують словник розміром у 8 МіБ. +. +.SS "Потокові і непотокові файл .lzma" +Розмір нестисненого файла може бути збережено у заголовку \fB.lzma\fP. LZMA +Utils зберігають дані при стисканні звичайних файлів. Альтернативним +підходом є позначення нестисненого розміру як невідомого і використання +позначки кінця вмісту для позначення місця, де засіб розпаковування має +зупинитися. У LZMA Utils цей спосіб використовують, якщо нестиснений розмір +є невідомим, що трапляється, наприклад, для конвеєрів обробки даних. +.PP +У \fBxz\fP передбачено підтримку розпаковування файлів \fB.lzma\fP з позначкою +кінця вмісту та без неї, але усі файли \fB.lzma\fP, які створено за допомогою +\fBxz\fP, використовують позначку кінця вмісту, а нестиснений розмір у +заголовку \fB.lzma\fP позначають як невідомий. Це може призвести до проблем у +деяких нетипових ситуаціях. Наприклад, розпакувальник \fB.lzma\fP у вбудованому +пристрої може працювати лише з файлами, для яких відомий нестиснений +розмір. Якщо ви зіткнулися з цією проблемою, вам слід скористатися LZMA +Utils або LZMA SDK для створення файлів \fB.lzma\fP із відомим розміром +нестиснених даних. +. +.SS "Непідтримувані файли .lzma" +У форматі \fB.lzma\fP можливі значення \fIlc\fP аж до 8 і значення \fIlp\fP аж до +4. LZMA Utils можуть розпаковувати файли із будь\-якими значеннями \fIlc\fP і +\fIlp\fP, але завжди створюють файли з \fBlc=3\fP і \fBlp=0\fP. Створення файлів з +іншими значеннями \fIlc\fP і \fIlp\fP є можливим за допомогою \fBxz\fP і LZMA SDK. +.PP +Реалізація фільтра LZMA1 у liblzma потребує, щоби сума \fIlc\fP і \fIlp\fP не +перевищувала 4. Отже, файли \fB.lzma\fP, у яких перевищено обмеження, не може +бути розпаковано за допомогою \fBxz\fP. +.PP +LZMA Utils створюють лише файли \fB.lzma\fP, які мають розмір словника у 2^\fIn\fP +(степінь 2), але приймають файли із будь\-яким розміром словника. liblzma +приймає лише файли \fB.lzma\fP, які мають розмір словника 2^\fIn\fP або 2^\fIn\fP + +2^(\fIn\fP\-1). Так зроблено для зменшення помилок при виявленні файлів +\&\fB.lzma\fP. +.PP +Ці обмеження не мають призводити до проблем на практиці, оскільки практично +усі файли \fB.lzma\fP було стиснено з використанням параметрів, які приймає +liblzma. +. +.SS "Кінцевий мотлох" +При розпаковуванні LZMA Utils без повідомлень ігнорують усі дані після +першого потоку \fB.lzma\fP. У більшості випадків це пов'язано із вадою у +програмі. Це також означає, що у LZMA Utils не передбачено підтримки +розпаковування з'єднаних файлів \fB.lzma\fP. +.PP +Якщо після першого потоку \fB.lzma\fP лишилися дані, \fBxz\fP вважатиме файл +пошкодженим, якщо не було використано \fB\-\-single\-stream\fP. Це може зашкодити +роботі скриптів, де зроблено припущення, що кінцеві зайві дані буде +проігноровано. +. +.SH ПРИМІТКИ +. +.SS "Стискання даних може бути різним" +Точні стиснені дані, які створено на основі того самого нестисненого файла +вхідних даних, можуть бути різними для різних версій XZ Utils, навіть якщо +використано однакові параметри стискання. Причиною цього є удосконалення у +кодувальнику (пришвидшення або краще стискання) без зміни формату +файлів. Виведені дані можуть бути різними навіть для різних збірок тієї +самої версії XZ Utils, якщо використано різні параметри збирання. +.PP +Написане вище означає, що після реалізації \fB\-\-rsyncable\fP файли\-результати +не обов'язково можна буде синхронізувати за допомогою rsyncable, якщо старий +і новий файли було стиснено за допомогою тієї самої версії xz. Цю проблему +можна усунути, якщо буде заморожено частину реалізації кодувальника, щоб +введені для rsync дані були стабільними між версіями xz. +. +.SS "Вбудовані розпакувальники .xz" +У вбудованих реалізаціях розпакувальника \fB.xz\fP, подібних до XZ Embedded, не +обов'язково передбачено підтримку файлів, які створено із типами +\fIперевірки\fP цілісності, відмінними від \fBnone\fP і \fBcrc32\fP. Оскільки типовим +є \fB\-\-check=crc64\fP, вам слід використовувати \fB\-\-check=none\fP або +\fB\-\-check=crc32\fP при створенні файлів для вбудованих систем. +.PP +Поза вбудованими системами, в усіх засобах розпаковування формату \fB.xz\fP +передбачено підтримку усіх типів \fIперевірок\fP або принаймні можливість +розпакувати файл без перевірки цілісності, якщо підтримки певної +\fIперевірки\fP не передбачено. +.PP +У XZ Embedded передбачено підтримку BCJ, але лише з типовим початковим +зсувом. +. +.SH ПРИКЛАДИ +. +.SS Основи +Стиснути файл \fIfoo\fP до \fIfoo.xz\fP за допомогою типового рівня стискання +(\fB\-6\fP) і вилучити \fIfoo\fP, якщо стискання відбулося успішно: +.RS +.PP +.nf +\f(CRxz foo\fR +.fi +.RE +.PP +Розпакувати \fIbar.xz\fP до \fIbar\fP і не вилучати \fIbar.xz\fP, навіть якщо +розпаковування відбулося успішно: +.RS +.PP +.nf +\f(CRxz \-dk bar.xz\fR +.fi +.RE +.PP +Створити \fIbaz.tar.xz\fP з використанням шаблона \fB\-4e\fP (\fB\-4 \-\-extreme\fP), +який є повільнішими за типовий \fB\-6\fP, але потребує менше пам'яті для +стискання та розпаковування (48\ МіБ та 5\ МіБ, відповідно): +.RS +.PP +.nf +\f(CRtar cf \- baz | xz \-4e > baz.tar.xz\fR +.fi +.RE +.PP +Суміш стиснених і нестиснених файлів можна розпакувати до стандартного +виведення за допомогою єдиної команди: +.RS +.PP +.nf +\f(CRxz \-dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt\fR +.fi +.RE +. +.SS "Паралельне стискання багатьох файлів" +У GNU і *BSD можна скористатися \fBfind\fP(1) і \fBxargs\fP(1) для паралельного +стискання багатьох файлів: +.RS +.PP +.nf +\f(CRfind . \-type f \e! \-name '*.xz' \-print0 \e + | xargs \-0r \-P4 \-n16 xz \-T1\fR +.fi +.RE +.PP +Параметр \fB\-P\fP \fBxargs\fP(1) встановлює кількість паралельних процесів +\fBxz\fP. Найкраще значення параметра \fB\-n\fP залежить від того, скільки файлів +має бути стиснено. Якщо файлів мало, значенням, ймовірно, має бути 1. Якщо +файлів десятки тисяч, може знадобитися значення 100 або навіть більше, щоб +зменшити кількість процесів \fBxz\fP, які врешті створить \fBxargs\fP(1). +.PP +Параметр \fB\-T1\fP для \fBxz\fP тут для примусового встановлення однопотокового +режиму, оскільки для керування рівнем паралелізації використано \fBxargs\fP(1). +. +.SS "Режим робота" +Обчислити скільки байтів було заощаджено загалом після стискання декількох +файлів: +.RS +.PP +.nf +\f(CRxz \-\-robot \-\-list *.xz | awk '/^totals/{print $5\-$4}'\fR +.fi +.RE +.PP +Скрипту можуть знадобитися дані щодо того, що використано достатньо нову +версію \fBxz\fP. У наведеному нижче скрипті \fBsh\fP(1) виконано перевірку того, +що номер версії засобу \fBxz\fP є принаймні рівним 5.0.0. Цей спосіб є сумісним +зі старими тестовими версіями, де не передбачено підтримки параметра +\fB\-\-robot\fP: +.RS +.PP +.nf +\f(CRif ! eval "$(xz \-\-robot \-\-version 2> /dev/null)" || + [ "$XZ_VERSION" \-lt 50000002 ]; then + echo "Your xz is too old." +fi +unset XZ_VERSION LIBLZMA_VERSION\fR +.fi +.RE +.PP +Встановити обмеження на використання пам'яті для розпаковування за допомогою +\fBXZ_OPT\fP, але якщо обмеження вже було встановлено, не збільшувати його: +.RS +.PP +.nf +\f(CRNEWLIM=$((123 << 20))\ \ # 123 MiB +OLDLIM=$(xz \-\-robot \-\-info\-memory | cut \-f3) +if [ $OLDLIM \-eq 0 \-o $OLDLIM \-gt $NEWLIM ]; then + XZ_OPT="$XZ_OPT \-\-memlimit\-decompress=$NEWLIM" + export XZ_OPT +fi\fR +.fi +.RE +. +.SS "Нетипові ланцюжки фільтрів засобу стискання" +Найпростішим використанням ланцюжка фільтрів є налаштовування шаблона +LZMA2. Це може бути корисним, оскільки у шаблонах використано лише +підмножину потенційно корисних комбінацій параметрів стискання. +.PP +При налаштовуванні шаблонів LZMA2 корисними є стовпчики CompCPU таблиць з +описів параметрів \fB\-0\fP ... \fB\-9\fP і \fB\-\-extreme\fP. Ось відповідні частини з +цих двох таблиць: +.RS +.PP +.TS +tab(;); +c c +n n. +Шаблон;CompCPU +\-0;0 +\-1;1 +\-2;2 +\-3;3 +\-4;4 +\-5;5 +\-6;6 +\-5e;7 +\-6e;8 +.TE +.RE +.PP +Якщо вам відомо, що певний файл потребує дещо більшого словника (наприклад, +32\ МіБ) для якісного стискання, але ви хочете стиснути його швидше за +команду \fBxz \-8\fP, можна внести зміни до шаблона із нижчим значенням CompCPU +(наприклад, 1) для використання більшого словника: +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=1,dict=32MiB foo.tar\fR +.fi +.RE +.PP +Для певних файлів наведена вище команда може працювати швидше за \fBxz \-6\fP і +стискати дані значно краще. Втім, слід наголосити, переваги більшого +словника з одночасним низьким значенням CompCPU проявляються лише для деяких +файлів. Найочевиднішим випадком, коли великий словник є корисним, є випадок, +коли архів містить дуже подібні файли розміром у принаймні декілька +мегабайтів. Розмір словника має бути значно більшим за будь\-який окремий +файл, щоб у LZMA2 було використано усі переваги подібностей між послідовними +файлами. +.PP +Якщо дуже високий рівень використання пам'яті у засобі стискання або +розпаковування не є проблемою, і файли, який стискають має об'єм у принаймні +декілька десятків мегабайтів, може бути корисним використання навіть +більшого за 64 МіБ словника, який використано у \fBxz \-9\fP: +.RS +.PP +.nf +\f(CRxz \-vv \-\-lzma2=dict=192MiB big_foo.tar\fR +.fi +.RE +.PP +Використання \fB\-vv\fP (\fB\-\-verbose \-\-verbose\fP), подібно до наведеного вище +прикладу, може бути корисним для перегляду вимог з боку засобів стискання та +розпаковування до пам'яті. Пам'ятайте, що використання словника, розмір +якого перевищує розмір файла, який стискають, є простоюю витратою пам'яті, +отже наведену вище команду не варто використовувати для малих файлів. +.PP +Іноді час стискання не має значення, але використання пам'яті засобом +розпаковування має бути низьким для того, щоб, наприклад, уможливити +розпаковування файла у вбудованій системі. У наведеній нижче команді +використано \fB\-6e\fP (\fB\-6 \-\-extreme\fP) як основу і встановлено розмір словника +лише у 64\ КіБ. Файл\-результат можна розпакувати за допомогою XZ Embedded +(ось чому використано \fB\-\-check=crc32\fP) з використанням лише 100\ КіБ +пам'яті. +.RS +.PP +.nf +\f(CRxz \-\-check=crc32 \-\-lzma2=preset=6e,dict=64KiB foo\fR +.fi +.RE +.PP +Якщо вам потрібно витиснути зі стискання максимальну кількість байтів, може +допомогти коригування кількості бітів контексту літералів (\fIlc\fP) та +кількість позиційних бітів (\fIpb\fP). Також може допомогти коригування +кількості бітів позиції літералів (\fIlp\fP), але, зазвичай, важливішими є +\fIlc\fP і \fIpb\fP. Наприклад, в архівах зі початковим кодом міститься +здебільшого текст US\-ASCII, щось подібне до наведеного нижче може дещо (на +щось близьке до 0,1\ %) зменшити файл, порівняно із \fBxz \-6e\fP (спробуйте +також без \fBlc=4\fP): +.RS +.PP +.nf +\f(CRxz \-\-lzma2=preset=6e,pb=0,lc=4 source_code.tar\fR +.fi +.RE +.PP +Використання іншого фільтра разом із LZMA2 може покращити стискання для +певних типів файлів. Наприклад, для стискання бібліотеки спільного +користування x86\-32 або x86\-64 з використанням фільтра BCJ x86 скористайтеся +такою командою: +.RS +.PP +.nf +\f(CRxz \-\-x86 \-\-lzma2 libfoo.so\fR +.fi +.RE +.PP +Зауважте, що порядок параметрів фільтрування має значення. Якщо \fB\-\-x86\fP +вказано після \fB\-\-lzma2\fP, \fBxz\fP повідомить про помилку, оскільки після LZMA2 +не може бути жодного фільтра, а також оскільки фільтр BCJ x86 не можна +використовувати як останній фільтр у ланцюжку. +.PP +Фільтр Delta разом із LZMA2 може дати добрі результати для растрових +зображень. Зазвичай, результати є кращими за формат PNG, у якого є декілька +більш досконалих фільтрів, ніж проста дельта, але там використовують для +стискання Deflate. +.PP +Зображення слід берегти у нестисненому форматі, наприклад, як нестиснений +TIFF. Параметр відстані фільтра Delta встановлюють так, щоб він збігався із +кількістю байтів на піксель у зображенні. Наприклад, для 24\-бітового +растрового зображення RGB слід вказати \fBdist=3\fP, а також добре передати +\fBpb=0\fP до LZMA2 для пристосовування до трибайтового вирівнювання: +.RS +.PP +.nf +\f(CRxz \-\-delta=dist=3 \-\-lzma2=pb=0 foo.tiff\fR +.fi +.RE +.PP +Якщо в один архів запаковано декілька зображень (наприклад, в архів +\&\fB.tar\fP), фільтр Delta також даватиме добрі результати, якщо у всіх +зображеннях однакова кількість байтів для кожного пікселя. +. +.SH "ДИВ. ТАКОЖ" +\fBxzdec\fP(1), \fBxzdiff\fP(1), \fBxzgrep\fP(1), \fBxzless\fP(1), \fBxzmore\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fB7z\fP(1) +.PP +XZ Utils: +.br +Вбудовуваний XZ: +.br +LZMA SDK: diff --git a/miniconda3/share/man/uk/man1/xzcmp.1 b/miniconda3/share/man/uk/man1/xzcmp.1 new file mode 100644 index 0000000000000000000000000000000000000000..0dd388c06a0fd2c32b4164b145f89739fe369a42 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzcmp.1 @@ -0,0 +1,56 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzcmp, xzdiff, lzcmp, lzdiff — порівняння стиснених файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzcmp\fP [\fIпараметр...\fP] \fIфайл1\fP [\fIфайл2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРІЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzcmp\fP і \fBxzdiff\fP порівнюють нестиснені дані двох файлів. Нестиснені дані +та параметри буде передано \fBcmp\fP(1) або \fBdiff\fP(1), якщо не вказано +\fB\-\-help\fP або \fB\-\-version\fP. +.PP +Якщо вказано одразу \fIфайл1\fP і \fIфайл2\fP, це можуть бути нестиснені файли або +файли у форматах, які може бути розпаковано за допомогою \fBxz\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1). Потрібні +команди розпаковування визначаються з суфіксів назв файлів \fIфайл1\fP і +\fIфайл2\fP. Файли із невідомими програмі суфіксами вважатимуться або +нестисненими або такими, що мають формат, дані у якому може розпаковувати +\fBxz\fP(1). +.PP +Якщо вказано лише одну назву файла, \fIфайл1\fP повинен мати суфікс +підтримуваного формату стискання, а назвою \fIфайл2\fP має бути назва \fIфайл1\fP +з вилученим суфіксом формату стискання. +.PP +Працездатність команд \fBlzcmp\fP і \fBlzdiff\fP забезпечено для зворотної +сумісності із LZMA Utils. Ці команди вважаються застарілими, їх буде +вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +Якщо станеться помилка розпаковування, станом виходу буде \fB2\fP. Інакше, +станом виходу буде \fBcmp\fP(1) або буде використано \fBdiff\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzdec.1 b/miniconda3/share/man/uk/man1/xzdec.1 new file mode 100644 index 0000000000000000000000000000000000000000..85a82215945dbd97edde051df4a2009126bc4b21 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzdec.1 @@ -0,0 +1,85 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Author: Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDEC 1 "8 квітня 2024 року" Tukaani "XZ Utils" +.SH НАЗВА +xzdec, lzmadec — невеличкі розпакувальники .xz і .lzma +.SH "КОРОТКИЙ ОПИС" +\fBxzdec\fP [\fIпараметр...\fP] [\fIфайл...\fP] +.br +\fBlzmadec\fP [\fIпараметр...\fP] [\fIфайл...\fP] +.SH ОПИС +\fBxzdec\fP є інструментом на основі liblzma, який призначено лише для +розпаковування файлів \fB.xz\fP (і лише файлів \fB.xz\fP). \fBxzdec\fP призначено для +того, щоб працювати як повноцінний замінник \fBxz\fP(1) у більшості типових +ситуацій, де скрипт було написано для використання \fBxz \-\-decompress \-\-stdout\fP (і, можливо, декількох інших типових параметрів), для +розпаковування файлів \fB.xz\fP. \fBlzmadec\fP є тотожним до \fBxzdec\fP, але у +\fBlzmadec\fP передбачено підтримку файлів \fB.lzma\fP, замість файлів \fB.xz\fP. +.PP +Щоб зменшити розмір виконуваного файла, у \fBxzdec\fP не передбачено підтримки +багатопотокової обробки та локалізації, а також читання параметрів зі +змінних середовища \fBXZ_DEFAULTS\fP і \fBXZ_OPT\fP. У \fBxzdec\fP не передбачено +підтримки показу проміжних даних щодо поступу: надсилання \fBSIGINFO\fP до +\fBxzdec\fP не призводить ні до яких наслідків, але надсилання \fBSIGUSR1\fP +перериває процес, замість показу даних щодо поступу. +.SH ПАРАМЕТРИ +.TP +\fB\-d\fP, \fB\-\-decompress\fP, \fB\-\-uncompress\fP +Буде проігноровано для сумісності з \fBxz\fP(1). У \fBxzdec\fP передбачено +підтримку лише розпаковування. +.TP +\fB\-k\fP, \fB\-\-keep\fP +Буде проігноровано. Призначено для сумісності з \fBxz\fP(1). \fBxzdec\fP ніколи не +створюватиме і ніколи не вилучатиме ці файли. +.TP +\fB\-c\fP, \fB\-\-stdout\fP, \fB\-\-to\-stdout\fP +Буде проігноровано. Для сумісності з \fBxz\fP(1). \fBxzdec\fP завжди записує +розпаковані дані до стандартного виведення. +.TP +\fB\-q\fP, \fB\-\-quiet\fP +Якщо цей параметр вказано один раз, нічого не станеться, оскільки \fBxzdec\fP +ніколи не показуватиме жодних попереджень або нотаток. Вкажіть параметр +двічі, щоб придушити повідомлення про помилки. +.TP +\fB\-Q\fP, \fB\-\-no\-warn\fP +Буде проігноровано для сумісності із \fBxz\fP(1). \fBxzdec\fP ніколи не +використовує стан виходу 2. +.TP +\fB\-h\fP, \fB\-\-help\fP +Вивести довідкове повідомлення і успішно завершити роботу. +.TP +\fB\-V\fP, \fB\-\-version\fP +Вивести номер версії \fBxzdec\fP та liblzma. +.SH "СТАН ВИХОДУ" +.TP +\fB0\fP +Усе добре. +.TP +\fB1\fP +Сталася помилка. +.PP +\fBxzdec\fP не має жодних повідомлень із попередженнями, на відміну від +\fBxz\fP(1), тому у \fBxzdec\fP стан виходу 2 не використовується. +.SH ПРИМІТКИ +Користуйтеся \fBxz\fP(1), замість \fBxzdec\fP або \fBlzmadec\fP, для щоденних +потреб. \fBxzdec\fP та \fBlzmadec\fP призначено лише для тих ситуацій, коли +важливо мати меншу програму для розпаковування, ніж \fBxz\fP(1). +.PP +\fBxzdec\fP і \fBlzmadec\fP не такі вже і малі програми. Їхній розмір можна +зменшити викиданням можливостей з liblzma під час збирання, але цього +зазвичай не роблять для виконуваних файлів, які поширюються у типових, не +вбудованих, дистрибутивах операційних систем. Якщо вам потрібний дуже мала +програма для розпаковування \fB.xz\fP, варто скористатися XZ Embedded. +.SH "ДИВ. ТАКОЖ" +\fBxz\fP(1) +.PP +Вбудовуваний XZ: diff --git a/miniconda3/share/man/uk/man1/xzdiff.1 b/miniconda3/share/man/uk/man1/xzdiff.1 new file mode 100644 index 0000000000000000000000000000000000000000..0dd388c06a0fd2c32b4164b145f89739fe369a42 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzdiff.1 @@ -0,0 +1,56 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zdiff.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZDIFF 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzcmp, xzdiff, lzcmp, lzdiff — порівняння стиснених файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzcmp\fP [\fIпараметр...\fP] \fIфайл1\fP [\fIфайл2\fP] +.br +\fBxzdiff\fP \&... +.br +\fBlzcmp\fP \&... (ЗАСТАРІЛО) +.br +\fBlzdiff\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzcmp\fP і \fBxzdiff\fP порівнюють нестиснені дані двох файлів. Нестиснені дані +та параметри буде передано \fBcmp\fP(1) або \fBdiff\fP(1), якщо не вказано +\fB\-\-help\fP або \fB\-\-version\fP. +.PP +Якщо вказано одразу \fIфайл1\fP і \fIфайл2\fP, це можуть бути нестиснені файли або +файли у форматах, які може бути розпаковано за допомогою \fBxz\fP(1), +\fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1). Потрібні +команди розпаковування визначаються з суфіксів назв файлів \fIфайл1\fP і +\fIфайл2\fP. Файли із невідомими програмі суфіксами вважатимуться або +нестисненими або такими, що мають формат, дані у якому може розпаковувати +\fBxz\fP(1). +.PP +Якщо вказано лише одну назву файла, \fIфайл1\fP повинен мати суфікс +підтримуваного формату стискання, а назвою \fIфайл2\fP має бути назва \fIфайл1\fP +з вилученим суфіксом формату стискання. +.PP +Працездатність команд \fBlzcmp\fP і \fBlzdiff\fP забезпечено для зворотної +сумісності із LZMA Utils. Ці команди вважаються застарілими, їх буде +вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +Якщо станеться помилка розпаковування, станом виходу буде \fB2\fP. Інакше, +станом виходу буде \fBcmp\fP(1) або буде використано \fBdiff\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBcmp\fP(1), \fBdiff\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), +\fBzstd\fP(1), \fBlz4\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzegrep.1 b/miniconda3/share/man/uk/man1/xzegrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzegrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzfgrep.1 b/miniconda3/share/man/uk/man1/xzfgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzfgrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzgrep.1 b/miniconda3/share/man/uk/man1/xzgrep.1 new file mode 100644 index 0000000000000000000000000000000000000000..e88272918dcf5fb875ee3a57c2fcfb1c33dab7ee --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzgrep.1 @@ -0,0 +1,96 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Lasse Collin +.\" Jia Tan +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zgrep.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZGREP 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzgrep — пошук взірців у ймовірно стиснених файлах +. +.SH "КОРОТКИЙ ОПИС" +\fBxzgrep\fP [\fIпараметр...\fP] [\fIсписок_взірців\fP] [\fIфайл...\fP] +.br +\fBxzegrep\fP \&... +.br +\fBxzfgrep\fP \&... +.br +\fBlzgrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzegrep\fP \&... (ЗАСТАРІЛО) +.br +\fBlzfgrep\fP \&... (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzgrep\fP викликає \fBgrep\fP(1) для розпакованих даних файлів. Формати +\fIфайлів\fP визначатимуться з суфіксів назв файлів. Будь\-який \fIфайл\fP із +суфіксом назви, підтримку якого передбачено у \fBxz\fP(1), \fBgzip\fP(1), +\fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1) або \fBlz4\fP(1), буде розпаковано; усі +інші файли вважатимуться нестисненими. +.PP +Якщо не вказано аргументу \fIфайли\fP або замість \fIфайл\fP вказано \fB\-\fP, дані +буде прочитано зі стандартного джерела вхідних даних. При читанні зі +стандартного джерела буде розпаковано лише файли, підтримку яких передбачено +у \fBxz\fP(1). Інші файли вважатимуться такими, що вже перебувають у +нестисненому форматі. +.PP +Передбачено підтримку більшості \fIпараметрів\fP \fBgrep\fP(1). Втім, підтримки +цих параметрів не передбачено: +.IP "" 4 +\fB\-r\fP, \fB\-\-recursive\fP +.IP "" 4 +\fB\-R\fP, \fB\-\-dereference\-recursive\fP +.IP "" 4 +\fB\-d\fP, \fB\-\-directories=\fP\fIдія\fP +.IP "" 4 +\fB\-Z\fP, \fB\-\-null\fP +.IP "" 4 +\fB\-z\fP, \fB\-\-null\-data\fP +.IP "" 4 +\fB\-\-include=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude=\fP\fIglob\fP +.IP "" 4 +\fB\-\-exclude\-from=\fP\fIфайл\fP +.IP "" 4 +\fB\-\-exclude\-dir=\fP\fIglob\fP +.PP +\fBxzegrep\fP є альтернативним записом \fBxzgrep \-E\fP. \fBxzfgrep\fP є +альтернативним записом \fBxzgrep \-F\fP. +.PP +Працездатність команд \fBlzgrep\fP, \fBlzegrep\fP і \fBlzfgrep\fP забезпечено для +зворотної сумісності із LZMA Utils. Ці команди вважаються застарілими, їх +буде вилучено у майбутній версії комплекту програм. +. +.SH "СТАН ВИХОДУ" +.TP +0 +В одному з файлів вхідних даних знайдено принаймні одну +відповідність. Помилок не сталося. +.TP +1 +У жодному з файлів вхідних даних не знайдено відповідника. Не сталося ніяких +помилок. +.TP +>1 +Сталася одна або декілька помилок. Невідомо, чи було знайдено відповідники +критерію пошуку. +. +.SH СЕРЕДОВИЩЕ +.TP +\fBGREP\fP +Якщо для змінної середовища \fBGREP\fP встановлено непорожнє значення, його +буде використано замість \fBgrep\fP(1), \fBgrep \-E\fP або \fBgrep \-F\fP. +. +.SH "ДИВ. ТАКОЖ" +\fBgrep\fP(1), \fBxz\fP(1), \fBgzip\fP(1), \fBbzip2\fP(1), \fBlzop\fP(1), \fBzstd\fP(1), +\fBlz4\fP(1), \fBzgrep\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzless.1 b/miniconda3/share/man/uk/man1/xzless.1 new file mode 100644 index 0000000000000000000000000000000000000000..c3b275d0dcadddd3e60054103f9c2a77a4eec341 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzless.1 @@ -0,0 +1,49 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is not based on gzip's zless.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZLESS 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzless, lzless — перегляд стиснених xz або lzma (текстових) файлів +.SH "КОРОТКИЙ ОПИС" +\fBxzless\fP [\fIфайл\fP...] +.br +\fBlzless\fP [\fIфайл\fP...] (ЗАСТАРІЛО) +.SH ОПИС +\fBxzless\fP є фільтром, який показує текст зі стиснених файлів у +терміналі. Файли, підтримку обробки яких передбачено у \fBxz\fP(1), буде +розпаковано; інші файли вважатимуться нестисненими. Якщо не вказано жодного +\fIфайла\fP, \fBxzless\fP читатиме дані зі стандартного джерела вхідних даних. +.PP +Для показу виведених даних \fBxzless\fP використовує \fBless\fP(1). На відміну від +\fBxzmore\fP, вибір програми для поділу на сторінки не можна змінити за +допомогою змінної середовища. Команди засновано на \fBmore\fP(1) і \fBvi\fP(1). За +допомогою команд можна просуватися назад і вперед даними та шукати дані. Щоб +дізнатися більше, ознайомтеся із підручником з \fBless\fP(1). +.PP +Команду \fBlzless\fP реалізовано для забезпечення зворотної сумісності з LZMA +Utils. Ця команда вважається застарілою, її буде вилучено у майбутній версії +комплекту програм. +.SH СЕРЕДОВИЩЕ +.TP +\fBLESSMETACHARS\fP +Список символів, які є особливими символами командної +оболонки. Встановлюється \fBxzless\fP, якщо його ще не встановлено у +середовищі. +.TP +\fBLESSOPEN\fP +Має значення рядка команди для виклику засобу розпаковування \fBxz\fP(1) для +обробки вхідних файлів \fBless\fP(1). +.SH "ДИВ. ТАКОЖ" +\fBless\fP(1), \fBxz\fP(1), \fBxzmore\fP(1), \fBzless\fP(1) diff --git a/miniconda3/share/man/uk/man1/xzmore.1 b/miniconda3/share/man/uk/man1/xzmore.1 new file mode 100644 index 0000000000000000000000000000000000000000..bf320be54129079b0f7310ac7f4d733a9f4d9945 --- /dev/null +++ b/miniconda3/share/man/uk/man1/xzmore.1 @@ -0,0 +1,51 @@ +.\" SPDX-License-Identifier: 0BSD +.\" +.\" Authors: Andrew Dudman +.\" Lasse Collin +.\" +.\" Ukrainian translation for xz-man. +.\" Yuri Chornoivan , 2019, 2022, 2023, 2024, 2025. +.\" +.\" (Note that this file is based on xzless.1 instead of gzip's zmore.1.) +.\" +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH XZMORE 1 "6 березня 2025 року" Tukaani "XZ Utils" +.SH НАЗВА +xzmore, lzmore — перегляд стиснених xz або lzma (текстових) файлів +. +.SH "КОРОТКИЙ ОПИС" +\fBxzmore\fP [\fIфайл\fP...] +.br +\fBlzmore\fP [\fIфайл\fP...] (ЗАСТАРІЛО) +. +.SH ОПИС +\fBxzmore\fP показує текст зі стиснених файлів у терміналі за допомогою +\fBmore\fP(1). Файли, підтримку яких передбачено у \fBxz\fP(1), буде розпаковано; +інші файли вважатимуться вже наданими у розпакованій формі. Якщо не вказано +аргументу \fIфайли\fP, \fBxzmore\fP читатиме дані зі стандартного джерела +даних. Див. підручник з \fBmore\fP(1), щоб дізнатися більше про клавіатурні +команди. +.PP +Зауважте, що гортання у зворотному напрямку може бути неможливим через +реалізацію \fBmore\fP(1). Причиною є те, що \fBxzmore\fP використовує канал для +передавання розпакованих даних \fBmore\fP(1). \fBxzless\fP(1) використовує +\fBless\fP(1), можливості якої є ширшими. +.PP +Команду \fBlzmore\fP реалізовано для забезпечення зворотної сумісності з LZMA +Utils. Ця команда вважається застарілою, її буде вилучено у майбутній версії +комплекту програм. +. +.SH СЕРЕДОВИЩЕ +.TP +.\" TRANSLATORS: Don't translate the uppercase PAGER. +.\" It is a name of an environment variable. +\fBPAGER\fP +Якщо встановлено значення \fBPAGER\fP, значення буде використано для засобу +поділу на сторінки, замість \fBmore\fP(1). +. +.SH "ДИВ. ТАКОЖ" +\fBmore\fP(1), \fBxz\fP(1), \fBxzless\fP(1), \fBzmore\fP(1) diff --git a/miniconda3/share/pkgconfig/applewmproto.pc b/miniconda3/share/pkgconfig/applewmproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..771f109a9fe61594f9e567ba180d907d9b1a90bb --- /dev/null +++ b/miniconda3/share/pkgconfig/applewmproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: AppleWMProto +Description: AppleWM extension headers +Version: 1.4.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/bigreqsproto.pc b/miniconda3/share/pkgconfig/bigreqsproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..a850a8497127341b530c5c3d752be5e77dca5c37 --- /dev/null +++ b/miniconda3/share/pkgconfig/bigreqsproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: BigReqsProto +Description: BigReqs extension headers +Version: 1.1.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/compositeproto.pc b/miniconda3/share/pkgconfig/compositeproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..f2c8164a5b55f6d0369c20d912a745d5aa6e53f6 --- /dev/null +++ b/miniconda3/share/pkgconfig/compositeproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: CompositeExt +Description: Composite extension headers +Version: 0.4.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/damageproto.pc b/miniconda3/share/pkgconfig/damageproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..76b9cf99e132940ad428b5c059d4ce1cbea8d5ea --- /dev/null +++ b/miniconda3/share/pkgconfig/damageproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: DamageProto +Description: Damage extension headers +Version: 1.2.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/dmxproto.pc b/miniconda3/share/pkgconfig/dmxproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..92a36d42819722a5a377fa1b74dfe3c6bd60315d --- /dev/null +++ b/miniconda3/share/pkgconfig/dmxproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: DMXProto +Description: DMX extension headers +Version: 2.3.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/dpmsproto.pc b/miniconda3/share/pkgconfig/dpmsproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..7c34032c75a91c40720684a1185603b02c3421c1 --- /dev/null +++ b/miniconda3/share/pkgconfig/dpmsproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: DPMSProto +Description: DPMS extension headers +Version: 1.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/dri2proto.pc b/miniconda3/share/pkgconfig/dri2proto.pc new file mode 100644 index 0000000000000000000000000000000000000000..114f5f473d20d7aa99b264a188534f24a5c07ae0 --- /dev/null +++ b/miniconda3/share/pkgconfig/dri2proto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: DRI2Proto +Description: DRI2 extension headers +Version: 2.8 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/dri3proto.pc b/miniconda3/share/pkgconfig/dri3proto.pc new file mode 100644 index 0000000000000000000000000000000000000000..3ca86a4040434fd359d672b4ad18334e94270694 --- /dev/null +++ b/miniconda3/share/pkgconfig/dri3proto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: DRI3Proto +Description: DRI3 extension headers +Version: 1.4 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/fixesproto.pc b/miniconda3/share/pkgconfig/fixesproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..d408e94ca199b81e6083966e4ffa4c5e1970e083 --- /dev/null +++ b/miniconda3/share/pkgconfig/fixesproto.pc @@ -0,0 +1,8 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: FixesProto +Description: X Fixes extension headers +Version: 6.1 +Cflags: -I${includedir} +Requires: xextproto >= 7.0.99.1 diff --git a/miniconda3/share/pkgconfig/fontsproto.pc b/miniconda3/share/pkgconfig/fontsproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..1b55bf889082e23f77441892d538eac680c8f39f --- /dev/null +++ b/miniconda3/share/pkgconfig/fontsproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: FontsProto +Description: Fonts extension headers +Version: 2.1.3 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/glproto.pc b/miniconda3/share/pkgconfig/glproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..521ef25ca05cf6c1b284118a97bdae2ebb1f0108 --- /dev/null +++ b/miniconda3/share/pkgconfig/glproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: GLProto +Description: GL extension headers +Version: 1.4.17 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/inputproto.pc b/miniconda3/share/pkgconfig/inputproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..0ecaffeea5192140caa22f2dbcb3e0304be49119 --- /dev/null +++ b/miniconda3/share/pkgconfig/inputproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: InputProto +Description: Input extension headers +Version: 2.3.99.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/kbproto.pc b/miniconda3/share/pkgconfig/kbproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..bda3815a74972cd701344cc8f023b141f14e86ac --- /dev/null +++ b/miniconda3/share/pkgconfig/kbproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: KBProto +Description: KB extension headers +Version: 1.0.7 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/nlohmann_json.pc b/miniconda3/share/pkgconfig/nlohmann_json.pc new file mode 100644 index 0000000000000000000000000000000000000000..ec42c2107e50926355074bdcbf041ab76e5896e3 --- /dev/null +++ b/miniconda3/share/pkgconfig/nlohmann_json.pc @@ -0,0 +1,4 @@ +Name: nlohmann_json +Description: JSON for Modern C++ +Version: 3.11.2 +Cflags: -I/mnt/bn/bohanzhainas1/jiashuo/miniconda3/include diff --git a/miniconda3/share/pkgconfig/presentproto.pc b/miniconda3/share/pkgconfig/presentproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..179ed5fb8d640ed755aca6e25250bda3efe59006 --- /dev/null +++ b/miniconda3/share/pkgconfig/presentproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: PresentProto +Description: Present extension headers +Version: 1.4 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/randrproto.pc b/miniconda3/share/pkgconfig/randrproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..2e5c3b6d46be6dc7dbb9c888d581eddeb628f6d3 --- /dev/null +++ b/miniconda3/share/pkgconfig/randrproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: RandrProto +Description: Randr extension headers +Version: 1.6.0 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/recordproto.pc b/miniconda3/share/pkgconfig/recordproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..9537d4a7e42951df6602975930289a46f99a68b7 --- /dev/null +++ b/miniconda3/share/pkgconfig/recordproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: RecordProto +Description: Record extension headers +Version: 1.14.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/renderproto.pc b/miniconda3/share/pkgconfig/renderproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..e382c25f10a65db268b36e1d334cabbfe9050d20 --- /dev/null +++ b/miniconda3/share/pkgconfig/renderproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: RenderProto +Description: Render extension headers +Version: 0.11.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/resourceproto.pc b/miniconda3/share/pkgconfig/resourceproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..9599aacbe787f9cfd341116dee151f09fb20d955 --- /dev/null +++ b/miniconda3/share/pkgconfig/resourceproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: ResourceProto +Description: Resource extension headers +Version: 1.2.0 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/scrnsaverproto.pc b/miniconda3/share/pkgconfig/scrnsaverproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..752a1a735856b7f19ddaf264fcce5f2abfbe5668 --- /dev/null +++ b/miniconda3/share/pkgconfig/scrnsaverproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: ScrnSaverProto +Description: ScrnSaver extension headers +Version: 1.2.3 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/videoproto.pc b/miniconda3/share/pkgconfig/videoproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..5147ef46f96ffdec3deb28c953700057c97a9a3a --- /dev/null +++ b/miniconda3/share/pkgconfig/videoproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: VideoProto +Description: Video extension headers +Version: 2.3.3 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xcmiscproto.pc b/miniconda3/share/pkgconfig/xcmiscproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..bf2fa7e82a829c236e475906486696010a6e7ab3 --- /dev/null +++ b/miniconda3/share/pkgconfig/xcmiscproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XCMiscProto +Description: XCMisc extension headers +Version: 1.2.2 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xextproto.pc b/miniconda3/share/pkgconfig/xextproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..e1970b5ee50a3f382755f3c86e6b997aa10d947e --- /dev/null +++ b/miniconda3/share/pkgconfig/xextproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XExtProto +Description: XExt extension headers +Version: 7.3.0 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xf86bigfontproto.pc b/miniconda3/share/pkgconfig/xf86bigfontproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..c18ab20790ef79bc0dfcbed85015db527af9ced4 --- /dev/null +++ b/miniconda3/share/pkgconfig/xf86bigfontproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XF86BigFontProto +Description: XF86BigFont extension headers +Version: 1.2.0 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xf86dgaproto.pc b/miniconda3/share/pkgconfig/xf86dgaproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..46277a3c4ca9331aee771b29ceb1ba27213b8cc4 --- /dev/null +++ b/miniconda3/share/pkgconfig/xf86dgaproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XF86DGAProto +Description: XF86DGA extension headers +Version: 2.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xf86driproto.pc b/miniconda3/share/pkgconfig/xf86driproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..2340c6d271f48324ffc56fd72bf6a487caaae65c --- /dev/null +++ b/miniconda3/share/pkgconfig/xf86driproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XF86DRIProto +Description: XF86DRI extension headers +Version: 2.1.1 +Cflags: -I${includedir}/X11/dri diff --git a/miniconda3/share/pkgconfig/xf86vidmodeproto.pc b/miniconda3/share/pkgconfig/xf86vidmodeproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..bd98607431928878d596f5025c6d4d8783e7e710 --- /dev/null +++ b/miniconda3/share/pkgconfig/xf86vidmodeproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XF86VidModeProto +Description: XF86VidMode extension headers +Version: 2.3.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xineramaproto.pc b/miniconda3/share/pkgconfig/xineramaproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..fe1eba77b314e3d5f350ff93487adba04aca5681 --- /dev/null +++ b/miniconda3/share/pkgconfig/xineramaproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XineramaProto +Description: Xinerama extension headers +Version: 1.2.1 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xproto.pc b/miniconda3/share/pkgconfig/xproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..500e841a76621f4d16e623b905c108c25a67defe --- /dev/null +++ b/miniconda3/share/pkgconfig/xproto.pc @@ -0,0 +1,8 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include +includex11dir=${prefix}/include/X11 + +Name: Xproto +Description: Xproto headers +Version: 7.0.33 +Cflags: -I${includedir} diff --git a/miniconda3/share/pkgconfig/xwaylandproto.pc b/miniconda3/share/pkgconfig/xwaylandproto.pc new file mode 100644 index 0000000000000000000000000000000000000000..4fa9f85ce32f23d52a8e5c1a9cae57ca2dcea3be --- /dev/null +++ b/miniconda3/share/pkgconfig/xwaylandproto.pc @@ -0,0 +1,7 @@ +prefix=/mnt/bn/bohanzhainas1/jiashuo/miniconda3 +includedir=${prefix}/include + +Name: XwaylandProto +Description: Xwayland extension headers +Version: 1.0 +Cflags: -I${includedir} diff --git a/miniconda3/share/tabset/std b/miniconda3/share/tabset/std new file mode 100644 index 0000000000000000000000000000000000000000..e93f737f0e35ff4d1880c62724852cc4ee17436d --- /dev/null +++ b/miniconda3/share/tabset/std @@ -0,0 +1 @@ + 3 1 1 1 1 1 1 1 1 1 1 1 1 1 diff --git a/miniconda3/share/tabset/stdcrt b/miniconda3/share/tabset/stdcrt new file mode 100644 index 0000000000000000000000000000000000000000..66ba12f64da5909b491a8fb1b269332ff444e5b2 --- /dev/null +++ b/miniconda3/share/tabset/stdcrt @@ -0,0 +1 @@ + 3 1 1 1 1 1 1 1 1 1 \ No newline at end of file diff --git a/miniconda3/share/tabset/vt100 b/miniconda3/share/tabset/vt100 new file mode 100644 index 0000000000000000000000000000000000000000..8828d19da748897d43f22b391baaa533ed1eff55 --- /dev/null +++ b/miniconda3/share/tabset/vt100 @@ -0,0 +1,3 @@ + + +H H H H H H H H H H H H H H H H diff --git a/miniconda3/share/tabset/vt300 b/miniconda3/share/tabset/vt300 new file mode 100644 index 0000000000000000000000000000000000000000..b1f9ce16d134a7432aac0a32ec20eb2ae06fd0fc --- /dev/null +++ b/miniconda3/share/tabset/vt300 @@ -0,0 +1,3 @@ + + +P2$t9/17/25/33/41/49/57/65/73/81/89/97/105/113/121/129\ diff --git a/miniconda3/share/terminfo/1/1178 b/miniconda3/share/terminfo/1/1178 new file mode 100644 index 0000000000000000000000000000000000000000..a78743db03a01ccafca832f167635bc03d601fbb Binary files /dev/null and b/miniconda3/share/terminfo/1/1178 differ diff --git a/miniconda3/share/terminfo/1/1730-lm b/miniconda3/share/terminfo/1/1730-lm new file mode 100644 index 0000000000000000000000000000000000000000..4aeeb984a5d9502380cb651ea6bbd72b7740ff6e Binary files /dev/null and b/miniconda3/share/terminfo/1/1730-lm differ diff --git a/miniconda3/share/terminfo/2/2621 b/miniconda3/share/terminfo/2/2621 new file mode 100644 index 0000000000000000000000000000000000000000..e01ee357fa29b1c99c377c4c60daddbba6065bb6 Binary files /dev/null and b/miniconda3/share/terminfo/2/2621 differ diff --git a/miniconda3/share/terminfo/2/2621-wl b/miniconda3/share/terminfo/2/2621-wl new file mode 100644 index 0000000000000000000000000000000000000000..e01ee357fa29b1c99c377c4c60daddbba6065bb6 Binary files /dev/null and b/miniconda3/share/terminfo/2/2621-wl differ diff --git a/miniconda3/share/terminfo/2/2621A b/miniconda3/share/terminfo/2/2621A new file mode 100644 index 0000000000000000000000000000000000000000..e01ee357fa29b1c99c377c4c60daddbba6065bb6 Binary files /dev/null and b/miniconda3/share/terminfo/2/2621A differ diff --git a/miniconda3/share/terminfo/2/2621a b/miniconda3/share/terminfo/2/2621a new file mode 100644 index 0000000000000000000000000000000000000000..e01ee357fa29b1c99c377c4c60daddbba6065bb6 Binary files /dev/null and b/miniconda3/share/terminfo/2/2621a differ diff --git a/miniconda3/share/terminfo/3/386at b/miniconda3/share/terminfo/3/386at new file mode 100644 index 0000000000000000000000000000000000000000..3da9542721b9b610a74e7fe73a11d6b912ed5056 Binary files /dev/null and b/miniconda3/share/terminfo/3/386at differ diff --git a/miniconda3/share/terminfo/3/3b1 b/miniconda3/share/terminfo/3/3b1 new file mode 100644 index 0000000000000000000000000000000000000000..b41843d6a40a7d583c1dab1a8ab7da28442fbab6 Binary files /dev/null and b/miniconda3/share/terminfo/3/3b1 differ diff --git a/miniconda3/share/terminfo/4/4025ex b/miniconda3/share/terminfo/4/4025ex new file mode 100644 index 0000000000000000000000000000000000000000..a7d999f1b46c75d41744c79347e4193d403d9e5a Binary files /dev/null and b/miniconda3/share/terminfo/4/4025ex differ diff --git a/miniconda3/share/terminfo/4/4027ex b/miniconda3/share/terminfo/4/4027ex new file mode 100644 index 0000000000000000000000000000000000000000..a7d999f1b46c75d41744c79347e4193d403d9e5a Binary files /dev/null and b/miniconda3/share/terminfo/4/4027ex differ diff --git a/miniconda3/share/terminfo/4/4410-w b/miniconda3/share/terminfo/4/4410-w new file mode 100644 index 0000000000000000000000000000000000000000..78d1777faa19ec7061c6003ddfc560cf29e7f831 Binary files /dev/null and b/miniconda3/share/terminfo/4/4410-w differ diff --git a/miniconda3/share/terminfo/5/5051 b/miniconda3/share/terminfo/5/5051 new file mode 100644 index 0000000000000000000000000000000000000000..ec3766c15e5dd99b01f87136841fbdd54fa56a37 Binary files /dev/null and b/miniconda3/share/terminfo/5/5051 differ diff --git a/miniconda3/share/terminfo/5/5410-w b/miniconda3/share/terminfo/5/5410-w new file mode 100644 index 0000000000000000000000000000000000000000..78d1777faa19ec7061c6003ddfc560cf29e7f831 Binary files /dev/null and b/miniconda3/share/terminfo/5/5410-w differ diff --git a/miniconda3/share/terminfo/5/5620 b/miniconda3/share/terminfo/5/5620 new file mode 100644 index 0000000000000000000000000000000000000000..1bb40715fdaeac6142fcc6281d95d8ec60469312 Binary files /dev/null and b/miniconda3/share/terminfo/5/5620 differ diff --git a/miniconda3/share/terminfo/5/5630-24 b/miniconda3/share/terminfo/5/5630-24 new file mode 100644 index 0000000000000000000000000000000000000000..a575613b553df8a2f715cec44f17ba087c5d0897 Binary files /dev/null and b/miniconda3/share/terminfo/5/5630-24 differ diff --git a/miniconda3/share/terminfo/5/5630DMD-24 b/miniconda3/share/terminfo/5/5630DMD-24 new file mode 100644 index 0000000000000000000000000000000000000000..a575613b553df8a2f715cec44f17ba087c5d0897 Binary files /dev/null and b/miniconda3/share/terminfo/5/5630DMD-24 differ diff --git a/miniconda3/share/terminfo/6/6053 b/miniconda3/share/terminfo/6/6053 new file mode 100644 index 0000000000000000000000000000000000000000..ee16edb36af37b6e6755ffa831c716483bbd3334 Binary files /dev/null and b/miniconda3/share/terminfo/6/6053 differ diff --git a/miniconda3/share/terminfo/6/6053-dg b/miniconda3/share/terminfo/6/6053-dg new file mode 100644 index 0000000000000000000000000000000000000000..ee16edb36af37b6e6755ffa831c716483bbd3334 Binary files /dev/null and b/miniconda3/share/terminfo/6/6053-dg differ diff --git a/miniconda3/share/terminfo/6/605x b/miniconda3/share/terminfo/6/605x new file mode 100644 index 0000000000000000000000000000000000000000..ee16edb36af37b6e6755ffa831c716483bbd3334 Binary files /dev/null and b/miniconda3/share/terminfo/6/605x differ diff --git a/miniconda3/share/terminfo/6/605x-dg b/miniconda3/share/terminfo/6/605x-dg new file mode 100644 index 0000000000000000000000000000000000000000..ee16edb36af37b6e6755ffa831c716483bbd3334 Binary files /dev/null and b/miniconda3/share/terminfo/6/605x-dg differ diff --git a/miniconda3/share/terminfo/6/630-lm b/miniconda3/share/terminfo/6/630-lm new file mode 100644 index 0000000000000000000000000000000000000000..4aeeb984a5d9502380cb651ea6bbd72b7740ff6e Binary files /dev/null and b/miniconda3/share/terminfo/6/630-lm differ diff --git a/miniconda3/share/terminfo/6/630MTG-24 b/miniconda3/share/terminfo/6/630MTG-24 new file mode 100644 index 0000000000000000000000000000000000000000..a575613b553df8a2f715cec44f17ba087c5d0897 Binary files /dev/null and b/miniconda3/share/terminfo/6/630MTG-24 differ diff --git a/miniconda3/share/terminfo/7/730MTG-24 b/miniconda3/share/terminfo/7/730MTG-24 new file mode 100644 index 0000000000000000000000000000000000000000..cf1e9a2042de51f038be78dd9ad9ef486dab2122 Binary files /dev/null and b/miniconda3/share/terminfo/7/730MTG-24 differ diff --git a/miniconda3/share/terminfo/7/730MTG-41 b/miniconda3/share/terminfo/7/730MTG-41 new file mode 100644 index 0000000000000000000000000000000000000000..085e285669cbaf42ba0e8d939f8649162e6c1d8f Binary files /dev/null and b/miniconda3/share/terminfo/7/730MTG-41 differ diff --git a/miniconda3/share/terminfo/7/730MTG-41r b/miniconda3/share/terminfo/7/730MTG-41r new file mode 100644 index 0000000000000000000000000000000000000000..1a675a03d7a8b1ab98d6b9937f2f3234bbb72fb9 Binary files /dev/null and b/miniconda3/share/terminfo/7/730MTG-41r differ diff --git a/miniconda3/share/terminfo/7/730MTGr b/miniconda3/share/terminfo/7/730MTGr new file mode 100644 index 0000000000000000000000000000000000000000..12751e4437395a60ef6b8c186e30b89dc8d9846e Binary files /dev/null and b/miniconda3/share/terminfo/7/730MTGr differ diff --git a/miniconda3/share/terminfo/7/730MTGr-24 b/miniconda3/share/terminfo/7/730MTGr-24 new file mode 100644 index 0000000000000000000000000000000000000000..1bb2632dac7d51d4a79057fa74ecc6a7b339b1fa Binary files /dev/null and b/miniconda3/share/terminfo/7/730MTGr-24 differ diff --git a/miniconda3/share/terminfo/8/8510 b/miniconda3/share/terminfo/8/8510 new file mode 100644 index 0000000000000000000000000000000000000000..2874d511c91ced0214a77389dce5eb056d1482a7 Binary files /dev/null and b/miniconda3/share/terminfo/8/8510 differ diff --git a/miniconda3/share/terminfo/9/955-hb b/miniconda3/share/terminfo/9/955-hb new file mode 100644 index 0000000000000000000000000000000000000000..dfe4c1f6f7da435fd0c9ab1ae62496452cb5702e Binary files /dev/null and b/miniconda3/share/terminfo/9/955-hb differ diff --git a/miniconda3/share/terminfo/9/955-w b/miniconda3/share/terminfo/9/955-w new file mode 100644 index 0000000000000000000000000000000000000000..437f5ce55ad2072f1879c3c01210ab1be65e80af Binary files /dev/null and b/miniconda3/share/terminfo/9/955-w differ diff --git a/miniconda3/share/terminfo/9/9term b/miniconda3/share/terminfo/9/9term new file mode 100644 index 0000000000000000000000000000000000000000..10f55953380f66f3e384da86de7f3aea852ddb00 Binary files /dev/null and b/miniconda3/share/terminfo/9/9term differ diff --git a/miniconda3/share/terminfo/A/Apple_Terminal b/miniconda3/share/terminfo/A/Apple_Terminal new file mode 100644 index 0000000000000000000000000000000000000000..f10555ae5ef425315e1951b34c9f18e1666276d1 Binary files /dev/null and b/miniconda3/share/terminfo/A/Apple_Terminal differ diff --git a/miniconda3/share/terminfo/E/Eterm b/miniconda3/share/terminfo/E/Eterm new file mode 100644 index 0000000000000000000000000000000000000000..a08d16a269e4afe6a0d5106c5dd438cc6f558059 Binary files /dev/null and b/miniconda3/share/terminfo/E/Eterm differ diff --git a/miniconda3/share/terminfo/E/Eterm-256color b/miniconda3/share/terminfo/E/Eterm-256color new file mode 100644 index 0000000000000000000000000000000000000000..03d6af0e4a6bfd1832c9429ae53f1ecbbc66b3d4 Binary files /dev/null and b/miniconda3/share/terminfo/E/Eterm-256color differ diff --git a/miniconda3/share/terminfo/E/Eterm-88color b/miniconda3/share/terminfo/E/Eterm-88color new file mode 100644 index 0000000000000000000000000000000000000000..68826517302a232c1d938d721c88fa30f187446e Binary files /dev/null and b/miniconda3/share/terminfo/E/Eterm-88color differ diff --git a/miniconda3/share/terminfo/E/Eterm-color b/miniconda3/share/terminfo/E/Eterm-color new file mode 100644 index 0000000000000000000000000000000000000000..a08d16a269e4afe6a0d5106c5dd438cc6f558059 Binary files /dev/null and b/miniconda3/share/terminfo/E/Eterm-color differ diff --git a/miniconda3/share/terminfo/L/LFT-PC850 b/miniconda3/share/terminfo/L/LFT-PC850 new file mode 100644 index 0000000000000000000000000000000000000000..20c5b42c213f1e8bcf90dd645d60f68d292a7db6 Binary files /dev/null and b/miniconda3/share/terminfo/L/LFT-PC850 differ diff --git a/miniconda3/share/terminfo/M/MtxOrb b/miniconda3/share/terminfo/M/MtxOrb new file mode 100644 index 0000000000000000000000000000000000000000..535ea37bb9661fd01e42eafae0b47423f6ae1045 Binary files /dev/null and b/miniconda3/share/terminfo/M/MtxOrb differ diff --git a/miniconda3/share/terminfo/M/MtxOrb162 b/miniconda3/share/terminfo/M/MtxOrb162 new file mode 100644 index 0000000000000000000000000000000000000000..e009b47da51b1249a96b066b7bdbfbcb083884ac Binary files /dev/null and b/miniconda3/share/terminfo/M/MtxOrb162 differ diff --git a/miniconda3/share/terminfo/M/MtxOrb204 b/miniconda3/share/terminfo/M/MtxOrb204 new file mode 100644 index 0000000000000000000000000000000000000000..62e49b646ac739325c5f0c397e55df201669a4f7 Binary files /dev/null and b/miniconda3/share/terminfo/M/MtxOrb204 differ diff --git a/miniconda3/share/terminfo/N/NCR260VT300WPP b/miniconda3/share/terminfo/N/NCR260VT300WPP new file mode 100644 index 0000000000000000000000000000000000000000..c41956f610e038284a461d760acf9c04813682f0 Binary files /dev/null and b/miniconda3/share/terminfo/N/NCR260VT300WPP differ diff --git a/miniconda3/share/terminfo/N/NCRVT100WPP b/miniconda3/share/terminfo/N/NCRVT100WPP new file mode 100644 index 0000000000000000000000000000000000000000..d5cdb64003254e9fc7ddca5352e6587e38b56e3f Binary files /dev/null and b/miniconda3/share/terminfo/N/NCRVT100WPP differ diff --git a/miniconda3/share/terminfo/P/P12 b/miniconda3/share/terminfo/P/P12 new file mode 100644 index 0000000000000000000000000000000000000000..12de25677be37fc5fee85d23eda474b8cb642755 Binary files /dev/null and b/miniconda3/share/terminfo/P/P12 differ diff --git a/miniconda3/share/terminfo/P/P12-M b/miniconda3/share/terminfo/P/P12-M new file mode 100644 index 0000000000000000000000000000000000000000..c4dd32141f0efc92e1692a94f55bacf68d0db902 Binary files /dev/null and b/miniconda3/share/terminfo/P/P12-M differ diff --git a/miniconda3/share/terminfo/P/P12-M-W b/miniconda3/share/terminfo/P/P12-M-W new file mode 100644 index 0000000000000000000000000000000000000000..7a52b60953882f736415e566f6ce9e89185adb14 Binary files /dev/null and b/miniconda3/share/terminfo/P/P12-M-W differ diff --git a/miniconda3/share/terminfo/P/P12-W b/miniconda3/share/terminfo/P/P12-W new file mode 100644 index 0000000000000000000000000000000000000000..2fe870dbc535c37e247b6f7213e7d89ec4e3879e Binary files /dev/null and b/miniconda3/share/terminfo/P/P12-W differ diff --git a/miniconda3/share/terminfo/P/P14 b/miniconda3/share/terminfo/P/P14 new file mode 100644 index 0000000000000000000000000000000000000000..485f1bc722fddca07abc271ac66fa3bc4cb6b0d4 Binary files /dev/null and b/miniconda3/share/terminfo/P/P14 differ diff --git a/miniconda3/share/terminfo/P/P14-M b/miniconda3/share/terminfo/P/P14-M new file mode 100644 index 0000000000000000000000000000000000000000..39dd310720abf005cd3c3561b386b426fbb3a3a4 Binary files /dev/null and b/miniconda3/share/terminfo/P/P14-M differ diff --git a/miniconda3/share/terminfo/P/P14-M-W b/miniconda3/share/terminfo/P/P14-M-W new file mode 100644 index 0000000000000000000000000000000000000000..5b6475de6eef814393a5f5a8fc3d368625b276f7 Binary files /dev/null and b/miniconda3/share/terminfo/P/P14-M-W differ diff --git a/miniconda3/share/terminfo/P/P14-W b/miniconda3/share/terminfo/P/P14-W new file mode 100644 index 0000000000000000000000000000000000000000..1d7df53b710aff295e42eeca63d45879279a70fe Binary files /dev/null and b/miniconda3/share/terminfo/P/P14-W differ diff --git a/miniconda3/share/terminfo/P/P4 b/miniconda3/share/terminfo/P/P4 new file mode 100644 index 0000000000000000000000000000000000000000..1d53e488c16eac6171ad331aeba03638332c7940 Binary files /dev/null and b/miniconda3/share/terminfo/P/P4 differ diff --git a/miniconda3/share/terminfo/P/P5 b/miniconda3/share/terminfo/P/P5 new file mode 100644 index 0000000000000000000000000000000000000000..f1848d045a59b0bd9a0bffdad259f03cbc407ffa Binary files /dev/null and b/miniconda3/share/terminfo/P/P5 differ diff --git a/miniconda3/share/terminfo/P/P7 b/miniconda3/share/terminfo/P/P7 new file mode 100644 index 0000000000000000000000000000000000000000..539b4ff6570496b03f33a1c661ff661137089364 Binary files /dev/null and b/miniconda3/share/terminfo/P/P7 differ diff --git a/miniconda3/share/terminfo/P/P8 b/miniconda3/share/terminfo/P/P8 new file mode 100644 index 0000000000000000000000000000000000000000..12fd9e6abc9789d25991acfcd58a0d0e89650205 Binary files /dev/null and b/miniconda3/share/terminfo/P/P8 differ diff --git a/miniconda3/share/terminfo/P/P8-W b/miniconda3/share/terminfo/P/P8-W new file mode 100644 index 0000000000000000000000000000000000000000..8f254d3604fcd521d7b155ab6a90e2717ba6b1c8 Binary files /dev/null and b/miniconda3/share/terminfo/P/P8-W differ diff --git a/miniconda3/share/terminfo/P/P9 b/miniconda3/share/terminfo/P/P9 new file mode 100644 index 0000000000000000000000000000000000000000..2a55145e92a53431c3b4802e6a6b298cfa5be038 Binary files /dev/null and b/miniconda3/share/terminfo/P/P9 differ diff --git a/miniconda3/share/terminfo/P/P9-8 b/miniconda3/share/terminfo/P/P9-8 new file mode 100644 index 0000000000000000000000000000000000000000..8191a9bd8dc3adefd3fecabeac8265090521e448 Binary files /dev/null and b/miniconda3/share/terminfo/P/P9-8 differ diff --git a/miniconda3/share/terminfo/P/P9-8-W b/miniconda3/share/terminfo/P/P9-8-W new file mode 100644 index 0000000000000000000000000000000000000000..93e3da9586201fa24c3c49dce55ead4037655fd6 Binary files /dev/null and b/miniconda3/share/terminfo/P/P9-8-W differ diff --git a/miniconda3/share/terminfo/P/P9-W b/miniconda3/share/terminfo/P/P9-W new file mode 100644 index 0000000000000000000000000000000000000000..44029ba7f9d33ae39f2d11a5ddbb8d53e8d6874f Binary files /dev/null and b/miniconda3/share/terminfo/P/P9-W differ diff --git a/miniconda3/share/terminfo/Q/Q306-8-pc b/miniconda3/share/terminfo/Q/Q306-8-pc new file mode 100644 index 0000000000000000000000000000000000000000..8fd3b2ea3655a0e71320b6bf6618a1a2b2723f94 Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q306-8-pc differ diff --git a/miniconda3/share/terminfo/Q/Q310-vip-H b/miniconda3/share/terminfo/Q/Q310-vip-H new file mode 100644 index 0000000000000000000000000000000000000000..8cf4e9272f2b878d88ac11c4453ce62b09578ea6 Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q310-vip-H differ diff --git a/miniconda3/share/terminfo/Q/Q310-vip-H-am b/miniconda3/share/terminfo/Q/Q310-vip-H-am new file mode 100644 index 0000000000000000000000000000000000000000..8cf4e9272f2b878d88ac11c4453ce62b09578ea6 Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q310-vip-H-am differ diff --git a/miniconda3/share/terminfo/Q/Q310-vip-Hw b/miniconda3/share/terminfo/Q/Q310-vip-Hw new file mode 100644 index 0000000000000000000000000000000000000000..4b09f0385f67ca84185f8974fa83bfa4cb02dcb3 Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q310-vip-Hw differ diff --git a/miniconda3/share/terminfo/Q/Q310-vip-w b/miniconda3/share/terminfo/Q/Q310-vip-w new file mode 100644 index 0000000000000000000000000000000000000000..b710a2ad61c382cef881615866da3db06abb6f4b Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q310-vip-w differ diff --git a/miniconda3/share/terminfo/Q/Q310-vip-w-am b/miniconda3/share/terminfo/Q/Q310-vip-w-am new file mode 100644 index 0000000000000000000000000000000000000000..b710a2ad61c382cef881615866da3db06abb6f4b Binary files /dev/null and b/miniconda3/share/terminfo/Q/Q310-vip-w-am differ diff --git a/miniconda3/share/terminfo/X/X-hpterm b/miniconda3/share/terminfo/X/X-hpterm new file mode 100644 index 0000000000000000000000000000000000000000..99dd05ad4aa8d132bbf463f405a3df26e72a10a0 Binary files /dev/null and b/miniconda3/share/terminfo/X/X-hpterm differ diff --git a/miniconda3/share/terminfo/X/X-hpterm-color2 b/miniconda3/share/terminfo/X/X-hpterm-color2 new file mode 100644 index 0000000000000000000000000000000000000000..79ff77206d01fe41715a867dd9ec035f97d85827 Binary files /dev/null and b/miniconda3/share/terminfo/X/X-hpterm-color2 differ diff --git a/miniconda3/share/terminfo/a/a210 b/miniconda3/share/terminfo/a/a210 new file mode 100644 index 0000000000000000000000000000000000000000..5eeb4f674d1240b7066bb8463eee032b42b0e9f8 Binary files /dev/null and b/miniconda3/share/terminfo/a/a210 differ diff --git a/miniconda3/share/terminfo/a/a80 b/miniconda3/share/terminfo/a/a80 new file mode 100644 index 0000000000000000000000000000000000000000..1265d5eddbf8c0390c3e954a7e2d7f4d57d86da8 Binary files /dev/null and b/miniconda3/share/terminfo/a/a80 differ diff --git a/miniconda3/share/terminfo/a/a980 b/miniconda3/share/terminfo/a/a980 new file mode 100644 index 0000000000000000000000000000000000000000..90c5c1570e10abf22e4e9650d4afb0dc60b6940d Binary files /dev/null and b/miniconda3/share/terminfo/a/a980 differ diff --git a/miniconda3/share/terminfo/a/aa4080 b/miniconda3/share/terminfo/a/aa4080 new file mode 100644 index 0000000000000000000000000000000000000000..078a29061d455389dacddfb3d694feb5021dc640 Binary files /dev/null and b/miniconda3/share/terminfo/a/aa4080 differ diff --git a/miniconda3/share/terminfo/a/aaa b/miniconda3/share/terminfo/a/aaa new file mode 100644 index 0000000000000000000000000000000000000000..4057ed848a461b5b9233660999ec00878cae1887 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa differ diff --git a/miniconda3/share/terminfo/a/aaa+dec b/miniconda3/share/terminfo/a/aaa+dec new file mode 100644 index 0000000000000000000000000000000000000000..0316cdf46fced10a66c95bac5ca54b4b47f9ec46 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa+dec differ diff --git a/miniconda3/share/terminfo/a/aaa+rv b/miniconda3/share/terminfo/a/aaa+rv new file mode 100644 index 0000000000000000000000000000000000000000..02cef13943d58eaed2857c0c846d68d3c67b490f Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa+rv differ diff --git a/miniconda3/share/terminfo/a/aaa+unk b/miniconda3/share/terminfo/a/aaa+unk new file mode 100644 index 0000000000000000000000000000000000000000..ba98f3abcd7ba27e2c216d00a0a28323534e9277 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa+unk differ diff --git a/miniconda3/share/terminfo/a/aaa-18 b/miniconda3/share/terminfo/a/aaa-18 new file mode 100644 index 0000000000000000000000000000000000000000..d07b65c1277bb67c2eb4792e58b576110d488e28 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-18 differ diff --git a/miniconda3/share/terminfo/a/aaa-18-rv b/miniconda3/share/terminfo/a/aaa-18-rv new file mode 100644 index 0000000000000000000000000000000000000000..99fd2859d7593daa69ec8476b1e94ef3517d3ced Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-18-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-20 b/miniconda3/share/terminfo/a/aaa-20 new file mode 100644 index 0000000000000000000000000000000000000000..c3f1590c48028fba01b9cde3f44491b4da3b91b9 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-20 differ diff --git a/miniconda3/share/terminfo/a/aaa-22 b/miniconda3/share/terminfo/a/aaa-22 new file mode 100644 index 0000000000000000000000000000000000000000..1030af8527de5b589bd3183bde1eb9d8da2d368d Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-22 differ diff --git a/miniconda3/share/terminfo/a/aaa-24 b/miniconda3/share/terminfo/a/aaa-24 new file mode 100644 index 0000000000000000000000000000000000000000..d9eddaf1f329524c3468773d0ddd14923f5756ce Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-24 differ diff --git a/miniconda3/share/terminfo/a/aaa-24-rv b/miniconda3/share/terminfo/a/aaa-24-rv new file mode 100644 index 0000000000000000000000000000000000000000..bb2536488f0fc68f0533d11da88a305dfd18814f Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-24-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-26 b/miniconda3/share/terminfo/a/aaa-26 new file mode 100644 index 0000000000000000000000000000000000000000..d73e48a0b5c2b50014d430aaf16fafe153f20c93 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-26 differ diff --git a/miniconda3/share/terminfo/a/aaa-28 b/miniconda3/share/terminfo/a/aaa-28 new file mode 100644 index 0000000000000000000000000000000000000000..f916a5c28d219d97d34ee39095d14786dba0f301 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-28 differ diff --git a/miniconda3/share/terminfo/a/aaa-30 b/miniconda3/share/terminfo/a/aaa-30 new file mode 100644 index 0000000000000000000000000000000000000000..4057ed848a461b5b9233660999ec00878cae1887 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30 differ diff --git a/miniconda3/share/terminfo/a/aaa-30-ctxt b/miniconda3/share/terminfo/a/aaa-30-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..282c36211ff30eb04bd039b6aacdefbe3de7e749 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-30-rv b/miniconda3/share/terminfo/a/aaa-30-rv new file mode 100644 index 0000000000000000000000000000000000000000..505f50f9c6ecc281233df14b4034b75901004acb Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-30-rv-ctxt b/miniconda3/share/terminfo/a/aaa-30-rv-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..fb8f018f418f862c0d8aa524e2806d7b08594339 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-rv-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-30-s b/miniconda3/share/terminfo/a/aaa-30-s new file mode 100644 index 0000000000000000000000000000000000000000..0a11df5c28513f47df258b9904ff61d28f96ad2c Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-s differ diff --git a/miniconda3/share/terminfo/a/aaa-30-s-ctxt b/miniconda3/share/terminfo/a/aaa-30-s-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..a9eae4b3261e05c97e2daeebd25591a737557853 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-s-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-30-s-rv b/miniconda3/share/terminfo/a/aaa-30-s-rv new file mode 100644 index 0000000000000000000000000000000000000000..d677272a516cc1336eaeb294a902145217e57275 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-s-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-30-s-rv-ct b/miniconda3/share/terminfo/a/aaa-30-s-rv-ct new file mode 100644 index 0000000000000000000000000000000000000000..c9314e25018d1bb94b19f189b4ad40d84ae4f25f Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-30-s-rv-ct differ diff --git a/miniconda3/share/terminfo/a/aaa-36 b/miniconda3/share/terminfo/a/aaa-36 new file mode 100644 index 0000000000000000000000000000000000000000..a25ea527a3a2a6217a2a2267ec20562bcf1e758b Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-36 differ diff --git a/miniconda3/share/terminfo/a/aaa-36-rv b/miniconda3/share/terminfo/a/aaa-36-rv new file mode 100644 index 0000000000000000000000000000000000000000..448866686a7818fbd0725ef3e9614ebbeeb77a63 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-36-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-40 b/miniconda3/share/terminfo/a/aaa-40 new file mode 100644 index 0000000000000000000000000000000000000000..c76c952e9e9dbd3dfbf9c7eab91a6f481b856992 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-40 differ diff --git a/miniconda3/share/terminfo/a/aaa-40-rv b/miniconda3/share/terminfo/a/aaa-40-rv new file mode 100644 index 0000000000000000000000000000000000000000..ee6046b72a920a60676b8d239bc34892106ba1d4 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-40-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-48 b/miniconda3/share/terminfo/a/aaa-48 new file mode 100644 index 0000000000000000000000000000000000000000..0fa30bcc7da9a0f8c89b70b14e6716e8780231ea Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-48 differ diff --git a/miniconda3/share/terminfo/a/aaa-48-rv b/miniconda3/share/terminfo/a/aaa-48-rv new file mode 100644 index 0000000000000000000000000000000000000000..ab26f86d6e297379d345da8e6bd513c371810616 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-48-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-60 b/miniconda3/share/terminfo/a/aaa-60 new file mode 100644 index 0000000000000000000000000000000000000000..827c6ead7b7d2bafcfbe402c385d7a1d900586d8 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-60 differ diff --git a/miniconda3/share/terminfo/a/aaa-60-dec-rv b/miniconda3/share/terminfo/a/aaa-60-dec-rv new file mode 100644 index 0000000000000000000000000000000000000000..31f764f3aa75e2f22c0b587b6c346c6ef5b0a988 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-60-dec-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-60-rv b/miniconda3/share/terminfo/a/aaa-60-rv new file mode 100644 index 0000000000000000000000000000000000000000..836944567ba4dfb923b48712966d43c410868a37 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-60-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-60-s b/miniconda3/share/terminfo/a/aaa-60-s new file mode 100644 index 0000000000000000000000000000000000000000..d0877a6e994c4e1e152187e3bc583f562f025878 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-60-s differ diff --git a/miniconda3/share/terminfo/a/aaa-60-s-rv b/miniconda3/share/terminfo/a/aaa-60-s-rv new file mode 100644 index 0000000000000000000000000000000000000000..41b6c222ebd2efd3269883fe3224e5e4c6fa0841 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-60-s-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-ctxt b/miniconda3/share/terminfo/a/aaa-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..282c36211ff30eb04bd039b6aacdefbe3de7e749 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-db b/miniconda3/share/terminfo/a/aaa-db new file mode 100644 index 0000000000000000000000000000000000000000..524ad36e9e389e2bca2d979c3494d456ab07f2c7 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-db differ diff --git a/miniconda3/share/terminfo/a/aaa-rv b/miniconda3/share/terminfo/a/aaa-rv new file mode 100644 index 0000000000000000000000000000000000000000..505f50f9c6ecc281233df14b4034b75901004acb Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-rv-ctxt b/miniconda3/share/terminfo/a/aaa-rv-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..fb8f018f418f862c0d8aa524e2806d7b08594339 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-rv-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-rv-unk b/miniconda3/share/terminfo/a/aaa-rv-unk new file mode 100644 index 0000000000000000000000000000000000000000..388a0cb4c8ed8c3fe9d9aabea678584de9f7c30a Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-rv-unk differ diff --git a/miniconda3/share/terminfo/a/aaa-s b/miniconda3/share/terminfo/a/aaa-s new file mode 100644 index 0000000000000000000000000000000000000000..0a11df5c28513f47df258b9904ff61d28f96ad2c Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-s differ diff --git a/miniconda3/share/terminfo/a/aaa-s-ctxt b/miniconda3/share/terminfo/a/aaa-s-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..a9eae4b3261e05c97e2daeebd25591a737557853 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-s-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-s-rv b/miniconda3/share/terminfo/a/aaa-s-rv new file mode 100644 index 0000000000000000000000000000000000000000..d677272a516cc1336eaeb294a902145217e57275 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-s-rv differ diff --git a/miniconda3/share/terminfo/a/aaa-s-rv-ctxt b/miniconda3/share/terminfo/a/aaa-s-rv-ctxt new file mode 100644 index 0000000000000000000000000000000000000000..c9314e25018d1bb94b19f189b4ad40d84ae4f25f Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-s-rv-ctxt differ diff --git a/miniconda3/share/terminfo/a/aaa-unk b/miniconda3/share/terminfo/a/aaa-unk new file mode 100644 index 0000000000000000000000000000000000000000..ba98f3abcd7ba27e2c216d00a0a28323534e9277 Binary files /dev/null and b/miniconda3/share/terminfo/a/aaa-unk differ diff --git a/miniconda3/share/terminfo/a/aas1901 b/miniconda3/share/terminfo/a/aas1901 new file mode 100644 index 0000000000000000000000000000000000000000..6dcde9d7155779a99fb1d3755d39a87c034c74d0 Binary files /dev/null and b/miniconda3/share/terminfo/a/aas1901 differ diff --git a/miniconda3/share/terminfo/a/abm80 b/miniconda3/share/terminfo/a/abm80 new file mode 100644 index 0000000000000000000000000000000000000000..8cbee81177aafb14080a447921ad390f2a135e5c Binary files /dev/null and b/miniconda3/share/terminfo/a/abm80 differ diff --git a/miniconda3/share/terminfo/a/abm85 b/miniconda3/share/terminfo/a/abm85 new file mode 100644 index 0000000000000000000000000000000000000000..6831ca2d9bba96bc085e21565a2ccd88d018cf58 Binary files /dev/null and b/miniconda3/share/terminfo/a/abm85 differ diff --git a/miniconda3/share/terminfo/a/abm85e b/miniconda3/share/terminfo/a/abm85e new file mode 100644 index 0000000000000000000000000000000000000000..f3cbf98c883939fc8eb918e65763d4c75ef57ac1 Binary files /dev/null and b/miniconda3/share/terminfo/a/abm85e differ diff --git a/miniconda3/share/terminfo/a/abm85h b/miniconda3/share/terminfo/a/abm85h new file mode 100644 index 0000000000000000000000000000000000000000..871701b792d187ac31afa7e4c8b5a00014cb026c Binary files /dev/null and b/miniconda3/share/terminfo/a/abm85h differ diff --git a/miniconda3/share/terminfo/a/abm85h-old b/miniconda3/share/terminfo/a/abm85h-old new file mode 100644 index 0000000000000000000000000000000000000000..a5a9d4335dc9bebdd4dbf90a13424df3de3f2348 Binary files /dev/null and b/miniconda3/share/terminfo/a/abm85h-old differ diff --git a/miniconda3/share/terminfo/a/absolute b/miniconda3/share/terminfo/a/absolute new file mode 100644 index 0000000000000000000000000000000000000000..d587f9274de05cd297a89c7410fbc662a30e49aa Binary files /dev/null and b/miniconda3/share/terminfo/a/absolute differ diff --git a/miniconda3/share/terminfo/a/act4 b/miniconda3/share/terminfo/a/act4 new file mode 100644 index 0000000000000000000000000000000000000000..b24bd133a271eed05f4a8c8ceab2a9c462bdc8f3 Binary files /dev/null and b/miniconda3/share/terminfo/a/act4 differ diff --git a/miniconda3/share/terminfo/a/act5 b/miniconda3/share/terminfo/a/act5 new file mode 100644 index 0000000000000000000000000000000000000000..66b296fabe0dca9da3239ba8e70b102a05dbba73 Binary files /dev/null and b/miniconda3/share/terminfo/a/act5 differ diff --git a/miniconda3/share/terminfo/a/addrinfo b/miniconda3/share/terminfo/a/addrinfo new file mode 100644 index 0000000000000000000000000000000000000000..33ab39cfa9ddf2d459bce3dfc7123941594c354c Binary files /dev/null and b/miniconda3/share/terminfo/a/addrinfo differ diff --git a/miniconda3/share/terminfo/a/adds200 b/miniconda3/share/terminfo/a/adds200 new file mode 100644 index 0000000000000000000000000000000000000000..07a979a17eaf7266c59be87b8546752a56505739 Binary files /dev/null and b/miniconda3/share/terminfo/a/adds200 differ diff --git a/miniconda3/share/terminfo/a/adds980 b/miniconda3/share/terminfo/a/adds980 new file mode 100644 index 0000000000000000000000000000000000000000..90c5c1570e10abf22e4e9650d4afb0dc60b6940d Binary files /dev/null and b/miniconda3/share/terminfo/a/adds980 differ diff --git a/miniconda3/share/terminfo/a/addsviewpoint b/miniconda3/share/terminfo/a/addsviewpoint new file mode 100644 index 0000000000000000000000000000000000000000..0efc7fba5f2d83c54e8f3e6c90b2c7ec85fa96f9 Binary files /dev/null and b/miniconda3/share/terminfo/a/addsviewpoint differ diff --git a/miniconda3/share/terminfo/a/addsvp60 b/miniconda3/share/terminfo/a/addsvp60 new file mode 100644 index 0000000000000000000000000000000000000000..3c28adffab491960f3d4811c3467e035adbd887e Binary files /dev/null and b/miniconda3/share/terminfo/a/addsvp60 differ diff --git a/miniconda3/share/terminfo/a/adm+sgr b/miniconda3/share/terminfo/a/adm+sgr new file mode 100644 index 0000000000000000000000000000000000000000..afbc99edc591a8ef453b49b0f6dda5b0ac491aa3 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm+sgr differ diff --git a/miniconda3/share/terminfo/a/adm1 b/miniconda3/share/terminfo/a/adm1 new file mode 100644 index 0000000000000000000000000000000000000000..6c4f65d9ec6e6eb71da6f04837a5128a408484f8 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm1 differ diff --git a/miniconda3/share/terminfo/a/adm11 b/miniconda3/share/terminfo/a/adm11 new file mode 100644 index 0000000000000000000000000000000000000000..d464b5b70b01257fda15396ad42a06bbd65c7c7d Binary files /dev/null and b/miniconda3/share/terminfo/a/adm11 differ diff --git a/miniconda3/share/terminfo/a/adm1178 b/miniconda3/share/terminfo/a/adm1178 new file mode 100644 index 0000000000000000000000000000000000000000..a78743db03a01ccafca832f167635bc03d601fbb Binary files /dev/null and b/miniconda3/share/terminfo/a/adm1178 differ diff --git a/miniconda3/share/terminfo/a/adm12 b/miniconda3/share/terminfo/a/adm12 new file mode 100644 index 0000000000000000000000000000000000000000..b0f05904614b2966ffba9b69dd10962e15ae4faa Binary files /dev/null and b/miniconda3/share/terminfo/a/adm12 differ diff --git a/miniconda3/share/terminfo/a/adm1a b/miniconda3/share/terminfo/a/adm1a new file mode 100644 index 0000000000000000000000000000000000000000..6c4f65d9ec6e6eb71da6f04837a5128a408484f8 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm1a differ diff --git a/miniconda3/share/terminfo/a/adm2 b/miniconda3/share/terminfo/a/adm2 new file mode 100644 index 0000000000000000000000000000000000000000..0a17e87d6551bbb8580aad3583a00a995bc4579a Binary files /dev/null and b/miniconda3/share/terminfo/a/adm2 differ diff --git a/miniconda3/share/terminfo/a/adm20 b/miniconda3/share/terminfo/a/adm20 new file mode 100644 index 0000000000000000000000000000000000000000..a6e7ba432dde5751a0175107041ffb2fd5472041 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm20 differ diff --git a/miniconda3/share/terminfo/a/adm21 b/miniconda3/share/terminfo/a/adm21 new file mode 100644 index 0000000000000000000000000000000000000000..28bf9df3bab93e22d8d6d930857f920d5c3f04a8 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm21 differ diff --git a/miniconda3/share/terminfo/a/adm22 b/miniconda3/share/terminfo/a/adm22 new file mode 100644 index 0000000000000000000000000000000000000000..550cfd47b9b67ff85be63dc7fb976c3f88f94be5 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm22 differ diff --git a/miniconda3/share/terminfo/a/adm3 b/miniconda3/share/terminfo/a/adm3 new file mode 100644 index 0000000000000000000000000000000000000000..428cd6e184de904c2ba76ffcc0796278f28a4e47 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm3 differ diff --git a/miniconda3/share/terminfo/a/adm31 b/miniconda3/share/terminfo/a/adm31 new file mode 100644 index 0000000000000000000000000000000000000000..c757bd29aec6cd065dbf196eb349158ef373d45a Binary files /dev/null and b/miniconda3/share/terminfo/a/adm31 differ diff --git a/miniconda3/share/terminfo/a/adm31-old b/miniconda3/share/terminfo/a/adm31-old new file mode 100644 index 0000000000000000000000000000000000000000..fb6d9e6b4155010d0478e894ce2d3be30cd3eca8 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm31-old differ diff --git a/miniconda3/share/terminfo/a/adm36 b/miniconda3/share/terminfo/a/adm36 new file mode 100644 index 0000000000000000000000000000000000000000..01dc27308c81134758f5f515cce0a29488b2bebc Binary files /dev/null and b/miniconda3/share/terminfo/a/adm36 differ diff --git a/miniconda3/share/terminfo/a/adm3a b/miniconda3/share/terminfo/a/adm3a new file mode 100644 index 0000000000000000000000000000000000000000..a19b9889dcb2290401c3f2802d4616a5bb76481d Binary files /dev/null and b/miniconda3/share/terminfo/a/adm3a differ diff --git a/miniconda3/share/terminfo/a/adm3a+ b/miniconda3/share/terminfo/a/adm3a+ new file mode 100644 index 0000000000000000000000000000000000000000..4a74c19ba58c426a95b42539587dee7f211f0254 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm3a+ differ diff --git a/miniconda3/share/terminfo/a/adm42 b/miniconda3/share/terminfo/a/adm42 new file mode 100644 index 0000000000000000000000000000000000000000..95d9e9a9dd76619af17bc9067f1b2c1800bf7fa7 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm42 differ diff --git a/miniconda3/share/terminfo/a/adm42-ns b/miniconda3/share/terminfo/a/adm42-ns new file mode 100644 index 0000000000000000000000000000000000000000..d23b411bf42d53f6ea414a046eabafded2eacb98 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm42-ns differ diff --git a/miniconda3/share/terminfo/a/adm5 b/miniconda3/share/terminfo/a/adm5 new file mode 100644 index 0000000000000000000000000000000000000000..aebdc514ef6a57daaef2ab8ec1b82dd9b80c05a4 Binary files /dev/null and b/miniconda3/share/terminfo/a/adm5 differ diff --git a/miniconda3/share/terminfo/a/aepro b/miniconda3/share/terminfo/a/aepro new file mode 100644 index 0000000000000000000000000000000000000000..d8b036ccbb216dec745ae7d7610db44b583c09b2 Binary files /dev/null and b/miniconda3/share/terminfo/a/aepro differ diff --git a/miniconda3/share/terminfo/a/aixterm b/miniconda3/share/terminfo/a/aixterm new file mode 100644 index 0000000000000000000000000000000000000000..1211a1d789182764ceaaa33284f6b4de637dcc5d Binary files /dev/null and b/miniconda3/share/terminfo/a/aixterm differ diff --git a/miniconda3/share/terminfo/a/aixterm+sl b/miniconda3/share/terminfo/a/aixterm+sl new file mode 100644 index 0000000000000000000000000000000000000000..276c9c369f23661e803fb93bdcf943a32bc2c4a0 Binary files /dev/null and b/miniconda3/share/terminfo/a/aixterm+sl differ diff --git a/miniconda3/share/terminfo/a/aixterm-16color b/miniconda3/share/terminfo/a/aixterm-16color new file mode 100644 index 0000000000000000000000000000000000000000..37f0254a333d0353c71e3eb7bb2858ac70b33f11 Binary files /dev/null and b/miniconda3/share/terminfo/a/aixterm-16color differ diff --git a/miniconda3/share/terminfo/a/aixterm-m b/miniconda3/share/terminfo/a/aixterm-m new file mode 100644 index 0000000000000000000000000000000000000000..3bc46d72c636e016f80cc7b2988bcd312e285798 Binary files /dev/null and b/miniconda3/share/terminfo/a/aixterm-m differ diff --git a/miniconda3/share/terminfo/a/aixterm-m-old b/miniconda3/share/terminfo/a/aixterm-m-old new file mode 100644 index 0000000000000000000000000000000000000000..5b47369e480a4567433cb1bb9a957b31a18f4e0b Binary files /dev/null and b/miniconda3/share/terminfo/a/aixterm-m-old differ diff --git a/miniconda3/share/terminfo/a/aj b/miniconda3/share/terminfo/a/aj new file mode 100644 index 0000000000000000000000000000000000000000..cccfdb431d04529d2ece2f9b8f482ff3f0fbea31 Binary files /dev/null and b/miniconda3/share/terminfo/a/aj differ diff --git a/miniconda3/share/terminfo/a/aj510 b/miniconda3/share/terminfo/a/aj510 new file mode 100644 index 0000000000000000000000000000000000000000..7185b9243ee1985ff27c1121871a3b50333d1e07 Binary files /dev/null and b/miniconda3/share/terminfo/a/aj510 differ diff --git a/miniconda3/share/terminfo/a/aj830 b/miniconda3/share/terminfo/a/aj830 new file mode 100644 index 0000000000000000000000000000000000000000..cccfdb431d04529d2ece2f9b8f482ff3f0fbea31 Binary files /dev/null and b/miniconda3/share/terminfo/a/aj830 differ diff --git a/miniconda3/share/terminfo/a/aj832 b/miniconda3/share/terminfo/a/aj832 new file mode 100644 index 0000000000000000000000000000000000000000..cccfdb431d04529d2ece2f9b8f482ff3f0fbea31 Binary files /dev/null and b/miniconda3/share/terminfo/a/aj832 differ diff --git a/miniconda3/share/terminfo/a/alacritty b/miniconda3/share/terminfo/a/alacritty new file mode 100644 index 0000000000000000000000000000000000000000..36bdf195043044b9bb9974227aea66bc0d2142d7 Binary files /dev/null and b/miniconda3/share/terminfo/a/alacritty differ diff --git a/miniconda3/share/terminfo/a/alacritty+common b/miniconda3/share/terminfo/a/alacritty+common new file mode 100644 index 0000000000000000000000000000000000000000..3e527295e26ee0cce4f3458ad4cf939258349649 Binary files /dev/null and b/miniconda3/share/terminfo/a/alacritty+common differ diff --git a/miniconda3/share/terminfo/a/alacritty-direct b/miniconda3/share/terminfo/a/alacritty-direct new file mode 100644 index 0000000000000000000000000000000000000000..e984c951084df2f9315fb5afd521347564f70945 Binary files /dev/null and b/miniconda3/share/terminfo/a/alacritty-direct differ diff --git a/miniconda3/share/terminfo/a/alt2 b/miniconda3/share/terminfo/a/alt2 new file mode 100644 index 0000000000000000000000000000000000000000..b4e9a798fef37ffc439bec485f9e95069da3377f Binary files /dev/null and b/miniconda3/share/terminfo/a/alt2 differ diff --git a/miniconda3/share/terminfo/a/alt3 b/miniconda3/share/terminfo/a/alt3 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/alt3 differ diff --git a/miniconda3/share/terminfo/a/alt4 b/miniconda3/share/terminfo/a/alt4 new file mode 100644 index 0000000000000000000000000000000000000000..a6344d429f35df0c72ca771753611418e6c568c6 Binary files /dev/null and b/miniconda3/share/terminfo/a/alt4 differ diff --git a/miniconda3/share/terminfo/a/alt5 b/miniconda3/share/terminfo/a/alt5 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/alt5 differ diff --git a/miniconda3/share/terminfo/a/alt7 b/miniconda3/share/terminfo/a/alt7 new file mode 100644 index 0000000000000000000000000000000000000000..c6457f54b925ba4bef8006fe56c4d46ab3f85ff3 Binary files /dev/null and b/miniconda3/share/terminfo/a/alt7 differ diff --git a/miniconda3/share/terminfo/a/alt7pc b/miniconda3/share/terminfo/a/alt7pc new file mode 100644 index 0000000000000000000000000000000000000000..b8f9c5cb1a6e7645b743b9e662c986e40971d470 Binary files /dev/null and b/miniconda3/share/terminfo/a/alt7pc differ diff --git a/miniconda3/share/terminfo/a/alto-h19 b/miniconda3/share/terminfo/a/alto-h19 new file mode 100644 index 0000000000000000000000000000000000000000..9dee8171e7d85285229356520f79d7fe6df1aa63 Binary files /dev/null and b/miniconda3/share/terminfo/a/alto-h19 differ diff --git a/miniconda3/share/terminfo/a/alto-heath b/miniconda3/share/terminfo/a/alto-heath new file mode 100644 index 0000000000000000000000000000000000000000..9dee8171e7d85285229356520f79d7fe6df1aa63 Binary files /dev/null and b/miniconda3/share/terminfo/a/alto-heath differ diff --git a/miniconda3/share/terminfo/a/altoh19 b/miniconda3/share/terminfo/a/altoh19 new file mode 100644 index 0000000000000000000000000000000000000000..9dee8171e7d85285229356520f79d7fe6df1aa63 Binary files /dev/null and b/miniconda3/share/terminfo/a/altoh19 differ diff --git a/miniconda3/share/terminfo/a/altoheath b/miniconda3/share/terminfo/a/altoheath new file mode 100644 index 0000000000000000000000000000000000000000..9dee8171e7d85285229356520f79d7fe6df1aa63 Binary files /dev/null and b/miniconda3/share/terminfo/a/altoheath differ diff --git a/miniconda3/share/terminfo/a/altos-2 b/miniconda3/share/terminfo/a/altos-2 new file mode 100644 index 0000000000000000000000000000000000000000..b4e9a798fef37ffc439bec485f9e95069da3377f Binary files /dev/null and b/miniconda3/share/terminfo/a/altos-2 differ diff --git a/miniconda3/share/terminfo/a/altos-3 b/miniconda3/share/terminfo/a/altos-3 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos-3 differ diff --git a/miniconda3/share/terminfo/a/altos-4 b/miniconda3/share/terminfo/a/altos-4 new file mode 100644 index 0000000000000000000000000000000000000000..a6344d429f35df0c72ca771753611418e6c568c6 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos-4 differ diff --git a/miniconda3/share/terminfo/a/altos-5 b/miniconda3/share/terminfo/a/altos-5 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos-5 differ diff --git a/miniconda3/share/terminfo/a/altos2 b/miniconda3/share/terminfo/a/altos2 new file mode 100644 index 0000000000000000000000000000000000000000..b4e9a798fef37ffc439bec485f9e95069da3377f Binary files /dev/null and b/miniconda3/share/terminfo/a/altos2 differ diff --git a/miniconda3/share/terminfo/a/altos3 b/miniconda3/share/terminfo/a/altos3 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos3 differ diff --git a/miniconda3/share/terminfo/a/altos4 b/miniconda3/share/terminfo/a/altos4 new file mode 100644 index 0000000000000000000000000000000000000000..a6344d429f35df0c72ca771753611418e6c568c6 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos4 differ diff --git a/miniconda3/share/terminfo/a/altos5 b/miniconda3/share/terminfo/a/altos5 new file mode 100644 index 0000000000000000000000000000000000000000..31097b7970b952f1eca8c48b7052d217074f7912 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos5 differ diff --git a/miniconda3/share/terminfo/a/altos7 b/miniconda3/share/terminfo/a/altos7 new file mode 100644 index 0000000000000000000000000000000000000000..c6457f54b925ba4bef8006fe56c4d46ab3f85ff3 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos7 differ diff --git a/miniconda3/share/terminfo/a/altos7pc b/miniconda3/share/terminfo/a/altos7pc new file mode 100644 index 0000000000000000000000000000000000000000..b8f9c5cb1a6e7645b743b9e662c986e40971d470 Binary files /dev/null and b/miniconda3/share/terminfo/a/altos7pc differ diff --git a/miniconda3/share/terminfo/a/ambas b/miniconda3/share/terminfo/a/ambas new file mode 100644 index 0000000000000000000000000000000000000000..4057ed848a461b5b9233660999ec00878cae1887 Binary files /dev/null and b/miniconda3/share/terminfo/a/ambas differ diff --git a/miniconda3/share/terminfo/a/ambassador b/miniconda3/share/terminfo/a/ambassador new file mode 100644 index 0000000000000000000000000000000000000000..4057ed848a461b5b9233660999ec00878cae1887 Binary files /dev/null and b/miniconda3/share/terminfo/a/ambassador differ diff --git a/miniconda3/share/terminfo/a/amiga b/miniconda3/share/terminfo/a/amiga new file mode 100644 index 0000000000000000000000000000000000000000..6233d1c811f3ae593fc779fa7a5c45effb585845 Binary files /dev/null and b/miniconda3/share/terminfo/a/amiga differ diff --git a/miniconda3/share/terminfo/a/amiga-8bit b/miniconda3/share/terminfo/a/amiga-8bit new file mode 100644 index 0000000000000000000000000000000000000000..5faf7577e3f762fd4ee4c81ed8c99a724fea0147 Binary files /dev/null and b/miniconda3/share/terminfo/a/amiga-8bit differ diff --git a/miniconda3/share/terminfo/a/amiga-h b/miniconda3/share/terminfo/a/amiga-h new file mode 100644 index 0000000000000000000000000000000000000000..96688795b8950e1caed5e1ec2720eede5978efe0 Binary files /dev/null and b/miniconda3/share/terminfo/a/amiga-h differ diff --git a/miniconda3/share/terminfo/a/amiga-vnc b/miniconda3/share/terminfo/a/amiga-vnc new file mode 100644 index 0000000000000000000000000000000000000000..e1ebe0cdac524e868965b081019d1ae67f082b6b Binary files /dev/null and b/miniconda3/share/terminfo/a/amiga-vnc differ diff --git a/miniconda3/share/terminfo/a/amp219 b/miniconda3/share/terminfo/a/amp219 new file mode 100644 index 0000000000000000000000000000000000000000..39f23d67e5a7a5cc36945eba5a8a7288473ec90e Binary files /dev/null and b/miniconda3/share/terminfo/a/amp219 differ diff --git a/miniconda3/share/terminfo/a/amp219w b/miniconda3/share/terminfo/a/amp219w new file mode 100644 index 0000000000000000000000000000000000000000..d45bd6492d098763bf9b0933fb324af697f4344f Binary files /dev/null and b/miniconda3/share/terminfo/a/amp219w differ diff --git a/miniconda3/share/terminfo/a/ampex-219 b/miniconda3/share/terminfo/a/ampex-219 new file mode 100644 index 0000000000000000000000000000000000000000..39f23d67e5a7a5cc36945eba5a8a7288473ec90e Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex-219 differ diff --git a/miniconda3/share/terminfo/a/ampex-219w b/miniconda3/share/terminfo/a/ampex-219w new file mode 100644 index 0000000000000000000000000000000000000000..d45bd6492d098763bf9b0933fb324af697f4344f Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex-219w differ diff --git a/miniconda3/share/terminfo/a/ampex-232 b/miniconda3/share/terminfo/a/ampex-232 new file mode 100644 index 0000000000000000000000000000000000000000..698c33d51674d2d50a8e815ffa36b08ece95646a Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex-232 differ diff --git a/miniconda3/share/terminfo/a/ampex175 b/miniconda3/share/terminfo/a/ampex175 new file mode 100644 index 0000000000000000000000000000000000000000..837bc26b4bd1b154cd72eee3937d43d80144a2a3 Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex175 differ diff --git a/miniconda3/share/terminfo/a/ampex175-b b/miniconda3/share/terminfo/a/ampex175-b new file mode 100644 index 0000000000000000000000000000000000000000..d9488187166a52ed7718c4154bfa39a695af6831 Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex175-b differ diff --git a/miniconda3/share/terminfo/a/ampex210 b/miniconda3/share/terminfo/a/ampex210 new file mode 100644 index 0000000000000000000000000000000000000000..5eeb4f674d1240b7066bb8463eee032b42b0e9f8 Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex210 differ diff --git a/miniconda3/share/terminfo/a/ampex219 b/miniconda3/share/terminfo/a/ampex219 new file mode 100644 index 0000000000000000000000000000000000000000..39f23d67e5a7a5cc36945eba5a8a7288473ec90e Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex219 differ diff --git a/miniconda3/share/terminfo/a/ampex219w b/miniconda3/share/terminfo/a/ampex219w new file mode 100644 index 0000000000000000000000000000000000000000..d45bd6492d098763bf9b0933fb324af697f4344f Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex219w differ diff --git a/miniconda3/share/terminfo/a/ampex232 b/miniconda3/share/terminfo/a/ampex232 new file mode 100644 index 0000000000000000000000000000000000000000..698c33d51674d2d50a8e815ffa36b08ece95646a Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex232 differ diff --git a/miniconda3/share/terminfo/a/ampex232w b/miniconda3/share/terminfo/a/ampex232w new file mode 100644 index 0000000000000000000000000000000000000000..2efbbde5e4ec6be67441a54b7f787f6d2aebe7b1 Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex232w differ diff --git a/miniconda3/share/terminfo/a/ampex80 b/miniconda3/share/terminfo/a/ampex80 new file mode 100644 index 0000000000000000000000000000000000000000..1265d5eddbf8c0390c3e954a7e2d7f4d57d86da8 Binary files /dev/null and b/miniconda3/share/terminfo/a/ampex80 differ diff --git a/miniconda3/share/terminfo/a/annarbor4080 b/miniconda3/share/terminfo/a/annarbor4080 new file mode 100644 index 0000000000000000000000000000000000000000..078a29061d455389dacddfb3d694feb5021dc640 Binary files /dev/null and b/miniconda3/share/terminfo/a/annarbor4080 differ diff --git a/miniconda3/share/terminfo/a/ansi b/miniconda3/share/terminfo/a/ansi new file mode 100644 index 0000000000000000000000000000000000000000..6de79787ad2d3fd89a05b113e11d98c012f4314a Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi differ diff --git a/miniconda3/share/terminfo/a/ansi+apparrows b/miniconda3/share/terminfo/a/ansi+apparrows new file mode 100644 index 0000000000000000000000000000000000000000..40c089a9a4a13e07a4ff440f42936f3591a9b096 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+apparrows differ diff --git a/miniconda3/share/terminfo/a/ansi+arrows b/miniconda3/share/terminfo/a/ansi+arrows new file mode 100644 index 0000000000000000000000000000000000000000..7f4085104eb945a5e26ccab04c45bb94c9e57126 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+arrows differ diff --git a/miniconda3/share/terminfo/a/ansi+cpr b/miniconda3/share/terminfo/a/ansi+cpr new file mode 100644 index 0000000000000000000000000000000000000000..afa048db9238bbda717ec904ee7994ff49655e08 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+cpr differ diff --git a/miniconda3/share/terminfo/a/ansi+csr b/miniconda3/share/terminfo/a/ansi+csr new file mode 100644 index 0000000000000000000000000000000000000000..b33d2e04dc9e7d37cd535f99fc9fd2358c875d71 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+csr differ diff --git a/miniconda3/share/terminfo/a/ansi+cup b/miniconda3/share/terminfo/a/ansi+cup new file mode 100644 index 0000000000000000000000000000000000000000..d1b653d113820c21832154ecabe96bf28b67eca4 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+cup differ diff --git a/miniconda3/share/terminfo/a/ansi+enq b/miniconda3/share/terminfo/a/ansi+enq new file mode 100644 index 0000000000000000000000000000000000000000..8103d305a1d6dcdcf363d2b37f95c755ecc8bb72 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+enq differ diff --git a/miniconda3/share/terminfo/a/ansi+erase b/miniconda3/share/terminfo/a/ansi+erase new file mode 100644 index 0000000000000000000000000000000000000000..39c766a551e565ea94210ed616be52ad66dd8f1d Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+erase differ diff --git a/miniconda3/share/terminfo/a/ansi+idc b/miniconda3/share/terminfo/a/ansi+idc new file mode 100644 index 0000000000000000000000000000000000000000..90fc17df010c64bc4650053d2820b6aaf525be1e Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+idc differ diff --git a/miniconda3/share/terminfo/a/ansi+idc1 b/miniconda3/share/terminfo/a/ansi+idc1 new file mode 100644 index 0000000000000000000000000000000000000000..686205119b036191164f90d935e579defc197575 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+idc1 differ diff --git a/miniconda3/share/terminfo/a/ansi+idl b/miniconda3/share/terminfo/a/ansi+idl new file mode 100644 index 0000000000000000000000000000000000000000..335f7970852f2cf2b0de7b6ed28a9af084128c84 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+idl differ diff --git a/miniconda3/share/terminfo/a/ansi+idl1 b/miniconda3/share/terminfo/a/ansi+idl1 new file mode 100644 index 0000000000000000000000000000000000000000..f743208cb7cffc3b9dc0ed37cb914b3b020b451e Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+idl1 differ diff --git a/miniconda3/share/terminfo/a/ansi+inittabs b/miniconda3/share/terminfo/a/ansi+inittabs new file mode 100644 index 0000000000000000000000000000000000000000..4b14396e43a22bb3f26d2bb66aa5204752cb6a12 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+inittabs differ diff --git a/miniconda3/share/terminfo/a/ansi+local b/miniconda3/share/terminfo/a/ansi+local new file mode 100644 index 0000000000000000000000000000000000000000..4a3abd05396b36888f567d96df096378aff62803 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+local differ diff --git a/miniconda3/share/terminfo/a/ansi+local1 b/miniconda3/share/terminfo/a/ansi+local1 new file mode 100644 index 0000000000000000000000000000000000000000..5ec73b88a7f6fd3addbf1c1dbc1ee8d1d85b8577 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+local1 differ diff --git a/miniconda3/share/terminfo/a/ansi+pp b/miniconda3/share/terminfo/a/ansi+pp new file mode 100644 index 0000000000000000000000000000000000000000..7ab68b197e64e7805070f28bfcae489881a5609a Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+pp differ diff --git a/miniconda3/share/terminfo/a/ansi+rca b/miniconda3/share/terminfo/a/ansi+rca new file mode 100644 index 0000000000000000000000000000000000000000..13d52d4785eaabc1017f9373d4df460ac0d84306 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+rca differ diff --git a/miniconda3/share/terminfo/a/ansi+rca2 b/miniconda3/share/terminfo/a/ansi+rca2 new file mode 100644 index 0000000000000000000000000000000000000000..2c1175943106ff4d0471189ff55b926c534bb8e0 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+rca2 differ diff --git a/miniconda3/share/terminfo/a/ansi+rep b/miniconda3/share/terminfo/a/ansi+rep new file mode 100644 index 0000000000000000000000000000000000000000..4f9ac6dcd7dd31bcfb90f7543c2a5d9d633aad0b Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+rep differ diff --git a/miniconda3/share/terminfo/a/ansi+sgr b/miniconda3/share/terminfo/a/ansi+sgr new file mode 100644 index 0000000000000000000000000000000000000000..2d93102417c5cc39fc9e2b2c7ef7e41ae293235e Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+sgr differ diff --git a/miniconda3/share/terminfo/a/ansi+sgrbold b/miniconda3/share/terminfo/a/ansi+sgrbold new file mode 100644 index 0000000000000000000000000000000000000000..0a10f6a658b07e79965af3a8c75e4635b97482fb Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+sgrbold differ diff --git a/miniconda3/share/terminfo/a/ansi+sgrdim b/miniconda3/share/terminfo/a/ansi+sgrdim new file mode 100644 index 0000000000000000000000000000000000000000..29b7a517bf3ce441fc144f3092dbdf6f9892eb25 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+sgrdim differ diff --git a/miniconda3/share/terminfo/a/ansi+sgrso b/miniconda3/share/terminfo/a/ansi+sgrso new file mode 100644 index 0000000000000000000000000000000000000000..a6bc57f275fe83d9ad05ab73e0977c96fd084d96 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+sgrso differ diff --git a/miniconda3/share/terminfo/a/ansi+sgrul b/miniconda3/share/terminfo/a/ansi+sgrul new file mode 100644 index 0000000000000000000000000000000000000000..d07663a5b3212a09760848bff83539bfc7819211 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+sgrul differ diff --git a/miniconda3/share/terminfo/a/ansi+tabs b/miniconda3/share/terminfo/a/ansi+tabs new file mode 100644 index 0000000000000000000000000000000000000000..6ecec5c0565b983bdf58cfdeff0fa7edc49914be Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi+tabs differ diff --git a/miniconda3/share/terminfo/a/ansi-color-2-emx b/miniconda3/share/terminfo/a/ansi-color-2-emx new file mode 100644 index 0000000000000000000000000000000000000000..4eab4da7191a5531bff9d34cbdd112ae0a0ef2a6 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-color-2-emx differ diff --git a/miniconda3/share/terminfo/a/ansi-color-3-emx b/miniconda3/share/terminfo/a/ansi-color-3-emx new file mode 100644 index 0000000000000000000000000000000000000000..f3e0cdb7861f66912c553c22558e31ebe12cf1cb Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-color-3-emx differ diff --git a/miniconda3/share/terminfo/a/ansi-emx b/miniconda3/share/terminfo/a/ansi-emx new file mode 100644 index 0000000000000000000000000000000000000000..837380764870f95940191fe6add38e1cec3ef6be Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-emx differ diff --git a/miniconda3/share/terminfo/a/ansi-generic b/miniconda3/share/terminfo/a/ansi-generic new file mode 100644 index 0000000000000000000000000000000000000000..1b72658c62e9f6fcfd200c26d6f57e65ed5716b0 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-generic differ diff --git a/miniconda3/share/terminfo/a/ansi-m b/miniconda3/share/terminfo/a/ansi-m new file mode 100644 index 0000000000000000000000000000000000000000..df6fd79849a834696a53669e1eaa5393185371c3 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-m differ diff --git a/miniconda3/share/terminfo/a/ansi-mini b/miniconda3/share/terminfo/a/ansi-mini new file mode 100644 index 0000000000000000000000000000000000000000..3f85d4be28abaecf90491badbddd18e337273d2b Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-mini differ diff --git a/miniconda3/share/terminfo/a/ansi-mono b/miniconda3/share/terminfo/a/ansi-mono new file mode 100644 index 0000000000000000000000000000000000000000..df6fd79849a834696a53669e1eaa5393185371c3 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-mono differ diff --git a/miniconda3/share/terminfo/a/ansi-mr b/miniconda3/share/terminfo/a/ansi-mr new file mode 100644 index 0000000000000000000000000000000000000000..92ab01a574db69a42d2a4bda12b197e90c9576ea Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-mr differ diff --git a/miniconda3/share/terminfo/a/ansi-mtabs b/miniconda3/share/terminfo/a/ansi-mtabs new file mode 100644 index 0000000000000000000000000000000000000000..052de5e9e066b54f8446a73c7cbb41facbd487c9 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-mtabs differ diff --git a/miniconda3/share/terminfo/a/ansi-nt b/miniconda3/share/terminfo/a/ansi-nt new file mode 100644 index 0000000000000000000000000000000000000000..b6bc8b8f576d8726fc0ec20ecccc67988fe960a6 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi-nt differ diff --git a/miniconda3/share/terminfo/a/ansi.sys b/miniconda3/share/terminfo/a/ansi.sys new file mode 100644 index 0000000000000000000000000000000000000000..3a2e620d3a6361ae7e26e92479a9daf73918d0a7 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi.sys differ diff --git a/miniconda3/share/terminfo/a/ansi.sys-old b/miniconda3/share/terminfo/a/ansi.sys-old new file mode 100644 index 0000000000000000000000000000000000000000..3d0297122a97589c66601950207ece9d0c09bad8 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi.sys-old differ diff --git a/miniconda3/share/terminfo/a/ansi.sysk b/miniconda3/share/terminfo/a/ansi.sysk new file mode 100644 index 0000000000000000000000000000000000000000..55c1aa7b9d3e1f65c644bbaf4a99f765fc991456 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi.sysk differ diff --git a/miniconda3/share/terminfo/a/ansi43m b/miniconda3/share/terminfo/a/ansi43m new file mode 100644 index 0000000000000000000000000000000000000000..be5691893bf0209fcf2a2b12f960a6d341708385 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi43m differ diff --git a/miniconda3/share/terminfo/a/ansi77 b/miniconda3/share/terminfo/a/ansi77 new file mode 100644 index 0000000000000000000000000000000000000000..b7c11b18531c53e262ffdd38c2e73217d9857b28 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi77 differ diff --git a/miniconda3/share/terminfo/a/ansi80x25 b/miniconda3/share/terminfo/a/ansi80x25 new file mode 100644 index 0000000000000000000000000000000000000000..4043099f37cef6decd107ceae59ad5c134b69d18 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x25 differ diff --git a/miniconda3/share/terminfo/a/ansi80x25-mono b/miniconda3/share/terminfo/a/ansi80x25-mono new file mode 100644 index 0000000000000000000000000000000000000000..4baf2844bbcc390b10590d0a73c56eff73ea8271 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x25-mono differ diff --git a/miniconda3/share/terminfo/a/ansi80x25-raw b/miniconda3/share/terminfo/a/ansi80x25-raw new file mode 100644 index 0000000000000000000000000000000000000000..e3621f7c22fb8c7e28d708217db550269bb9d068 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x25-raw differ diff --git a/miniconda3/share/terminfo/a/ansi80x30 b/miniconda3/share/terminfo/a/ansi80x30 new file mode 100644 index 0000000000000000000000000000000000000000..44227ab461635ccc77441250767efd41ac97885b Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x30 differ diff --git a/miniconda3/share/terminfo/a/ansi80x30-mono b/miniconda3/share/terminfo/a/ansi80x30-mono new file mode 100644 index 0000000000000000000000000000000000000000..35630cc4345110a5c33ecfa847929174028fabc7 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x30-mono differ diff --git a/miniconda3/share/terminfo/a/ansi80x43 b/miniconda3/share/terminfo/a/ansi80x43 new file mode 100644 index 0000000000000000000000000000000000000000..e0d6ec3e63b03994b8183fb8315691d6f92e77cb Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x43 differ diff --git a/miniconda3/share/terminfo/a/ansi80x43-mono b/miniconda3/share/terminfo/a/ansi80x43-mono new file mode 100644 index 0000000000000000000000000000000000000000..009a1934564b2cb5367f54c50a87e2b0f7175a34 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x43-mono differ diff --git a/miniconda3/share/terminfo/a/ansi80x50 b/miniconda3/share/terminfo/a/ansi80x50 new file mode 100644 index 0000000000000000000000000000000000000000..60c9bd0f233a4d972ca2c9d5fdce164f475e9423 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x50 differ diff --git a/miniconda3/share/terminfo/a/ansi80x50-mono b/miniconda3/share/terminfo/a/ansi80x50-mono new file mode 100644 index 0000000000000000000000000000000000000000..9e0dc6b68d697c568266c4e038869ba388fc7fc9 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x50-mono differ diff --git a/miniconda3/share/terminfo/a/ansi80x60 b/miniconda3/share/terminfo/a/ansi80x60 new file mode 100644 index 0000000000000000000000000000000000000000..7449cff5ee9d7d4e2b59219fa25486de98713bd7 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x60 differ diff --git a/miniconda3/share/terminfo/a/ansi80x60-mono b/miniconda3/share/terminfo/a/ansi80x60-mono new file mode 100644 index 0000000000000000000000000000000000000000..3f2f4c5d24e9b13351710bb9405564520ae519eb Binary files /dev/null and b/miniconda3/share/terminfo/a/ansi80x60-mono differ diff --git a/miniconda3/share/terminfo/a/ansil b/miniconda3/share/terminfo/a/ansil new file mode 100644 index 0000000000000000000000000000000000000000..60c9bd0f233a4d972ca2c9d5fdce164f475e9423 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansil differ diff --git a/miniconda3/share/terminfo/a/ansil-mono b/miniconda3/share/terminfo/a/ansil-mono new file mode 100644 index 0000000000000000000000000000000000000000..9e0dc6b68d697c568266c4e038869ba388fc7fc9 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansil-mono differ diff --git a/miniconda3/share/terminfo/a/ansis b/miniconda3/share/terminfo/a/ansis new file mode 100644 index 0000000000000000000000000000000000000000..4043099f37cef6decd107ceae59ad5c134b69d18 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansis differ diff --git a/miniconda3/share/terminfo/a/ansis-mono b/miniconda3/share/terminfo/a/ansis-mono new file mode 100644 index 0000000000000000000000000000000000000000..4baf2844bbcc390b10590d0a73c56eff73ea8271 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansis-mono differ diff --git a/miniconda3/share/terminfo/a/ansisysk b/miniconda3/share/terminfo/a/ansisysk new file mode 100644 index 0000000000000000000000000000000000000000..55c1aa7b9d3e1f65c644bbaf4a99f765fc991456 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansisysk differ diff --git a/miniconda3/share/terminfo/a/ansiterm b/miniconda3/share/terminfo/a/ansiterm new file mode 100644 index 0000000000000000000000000000000000000000..1b72658c62e9f6fcfd200c26d6f57e65ed5716b0 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansiterm differ diff --git a/miniconda3/share/terminfo/a/ansiw b/miniconda3/share/terminfo/a/ansiw new file mode 100644 index 0000000000000000000000000000000000000000..e3621f7c22fb8c7e28d708217db550269bb9d068 Binary files /dev/null and b/miniconda3/share/terminfo/a/ansiw differ diff --git a/miniconda3/share/terminfo/a/ap-vm80 b/miniconda3/share/terminfo/a/ap-vm80 new file mode 100644 index 0000000000000000000000000000000000000000..b06370a5289c95d5b2bc65c5a8095b19e37480a0 Binary files /dev/null and b/miniconda3/share/terminfo/a/ap-vm80 differ diff --git a/miniconda3/share/terminfo/a/apl b/miniconda3/share/terminfo/a/apl new file mode 100644 index 0000000000000000000000000000000000000000..679a5744156214ad39b0705bd622bc2f998884cd Binary files /dev/null and b/miniconda3/share/terminfo/a/apl differ diff --git a/miniconda3/share/terminfo/a/apollo b/miniconda3/share/terminfo/a/apollo new file mode 100644 index 0000000000000000000000000000000000000000..73bb4cbd91a6b394530ddc9da19e828dedca510c Binary files /dev/null and b/miniconda3/share/terminfo/a/apollo differ diff --git a/miniconda3/share/terminfo/a/apollo+vt132 b/miniconda3/share/terminfo/a/apollo+vt132 new file mode 100644 index 0000000000000000000000000000000000000000..d75f5f62bcf2a97b118b9cd5218233d112a9f6b3 Binary files /dev/null and b/miniconda3/share/terminfo/a/apollo+vt132 differ diff --git a/miniconda3/share/terminfo/a/apollo_15P b/miniconda3/share/terminfo/a/apollo_15P new file mode 100644 index 0000000000000000000000000000000000000000..3acdf2131cd669c2ced29fa4ba0809a8301ae623 Binary files /dev/null and b/miniconda3/share/terminfo/a/apollo_15P differ