Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
archive_clear_error(3), archive_compression(3), archive_compression_name(3), archive_copy_error(3), archive_errno(3), archive_error_string(3), archive_file_count(3), archive_filter_code(3), archive_filter_count(3), archive_filter_name(3), archive_format(3), archive_format_name(3), archive_position(3), archive_set_error(3)
libarchive utility functions
archive_read_support_filter_all(3), archive_read_support_filter_bzip2(3), archive_read_support_filter_compress(3), archive_read_support_filter_gzip(3), archive_read_support_filter_lz4(3), archive_read_support_filter_lzma(3), archive_read_support_filter_none(3), archive_read_support_filter_rpm(3), archive_read_support_filter_uu(3), archive_read_support_filter_xz(3), archive_read_support_filter_zstd(3), archive_read_support_filter_program(3), archive_read_support_filter_program_signature(3)
functions for reading streaming archives
archive_write_add_filter_b64encode(3), archive_write_add_filter_by_name(3), archive_write_add_filter_bzip2(3), archive_write_add_filter_compress(3), archive_write_add_filter_grzip(3), archive_write_add_filter_gzip(3), archive_write_add_filter_lrzip(3), archive_write_add_filter_lz4(3), archive_write_add_filter_lzip(3), archive_write_add_filter_lzma(3), archive_write_add_filter_lzop(3), archive_write_add_filter_none(3), archive_write_add_filter_program(3), archive_write_add_filter_uuencode(3), archive_write_add_filter_xz(3), archive_write_add_filter_zstd(3)
functions enabling output filters
bzip2(1), bunzip2(1)
a block-sorting file compressor, v1.0.8 bzcat - decompresses files to stdout bzip2recover - recovers data from damaged bzip2 files
compress(1), uncompress(1)
compress and expand data
elf32_getchdr(3), elf64_getchdr(3), gelf_getchdr(3)
retrieve the compression header of a section
geom_uzip(4)
GEOM based compressed disk images and partitions
gzexe(1)
create auto-decompressing executables
gzip(1), gunzip(1), zcat(1)
compression/decompression tool using Lempel-Ziv coding (LZ77)
mkuzip(8)
compress disk image for use with geom_uzip(4) class
ng_deflate(4)
Deflate PPP compression (RFC 1979) netgraph node type
ng_mppc(4)
Microsoft MPPC/MPPE compression and encryption netgraph node type
ng_pred1(4)
Predictor-1 PPP compression (RFC 1978) netgraph node type
ng_vjc(4)
Van Jacobson compression netgraph node type
xz(1), unxz(1), xzcat(1), lzma(1), unlzma(1), lzcat(1)
Compress or decompress .xz and .lzma files
xzdec(1), lzmadec(1)
Small .xz and .lzma decompressors
zcmp(1), zdiff(1)
compare compressed files
zgrep(1), zegrep(1), zfgrep(1), bzgrep(1), bzegrep(1), bzfgrep(1), lzgrep(1), lzegrep(1), lzfgrep(1), xzgrep(1), xzegrep(1), xzfgrep(1), zstdgrep(1), zstdegrep(1), zstdfgrep(1)
grep compressed files
zlib(3)
compression/decompression library
zmore(1), zless(1)
view compressed files
znew(1)
convert compressed files to gzipped files
zopen(3)
open a gzip compressed stream
zstd(1)
zstd, zstdmt, unzstd, zstdcat - Compress or decompress .zst files
CMS_compress(3)
create a CMS CompressedData structure
CMS_uncompress(3)
uncompress a CMS CompressedData structure
COMP_CTX_new(3), COMP_CTX_get_method(3), COMP_CTX_get_type(3), COMP_get_type(3), COMP_get_name(3), COMP_CTX_free(3), COMP_compress_block(3), COMP_expand_block(3), COMP_zlib(3), COMP_zlib_oneshot(3), COMP_brotli(3), COMP_brotli_oneshot(3), COMP_zstd(3), COMP_zstd_oneshot(3), BIO_f_zlib(3), BIO_f_brotli(3), BIO_f_zstd(3)
Compression support
EC_POINT_set_Jprojective_coordinates_GFp(3), EC_POINT_point2buf(3), EC_POINT_new(3), EC_POINT_free(3), EC_POINT_clear_free(3), EC_POINT_copy(3), EC_POINT_dup(3), EC_POINT_method_of(3), EC_POINT_set_to_infinity(3), EC_POINT_get_Jprojective_coordinates_GFp(3), EC_POINT_set_affine_coordinates(3), EC_POINT_get_affine_coordinates(3), EC_POINT_set_compressed_coordinates(3), EC_POINT_set_affine_coordinates_GFp(3), EC_POINT_get_affine_coordinates_GFp(3), EC_POINT_set_compressed_coordinates_GFp(3), EC_POINT_set_affine_coordinates_GF2m(3), EC_POINT_get_affine_coordinates_GF2m(3), EC_POINT_set_compressed_coordinates_GF2m(3), EC_POINT_point2oct(3), EC_POINT_oct2point(3), EC_POINT_point2bn(3), EC_POINT_bn2point(3), EC_POINT_point2hex(3), EC_POINT_hex2point(3)
Functions for creating, destroying and manipulating EC_POINT objects
SSL_COMP_add_compression_method(3), SSL_COMP_get_compression_methods(3), SSL_COMP_get0_name(3), SSL_COMP_get_id(3), SSL_COMP_free_compression_methods(3)
handle SSL/TLS integrated compression methods
SSL_CTX_set1_cert_comp_preference(3), SSL_set1_cert_comp_preference(3), SSL_CTX_compress_certs(3), SSL_compress_certs(3), SSL_CTX_get1_compressed_cert(3), SSL_get1_compressed_cert(3), SSL_CTX_set1_compressed_cert(3), SSL_set1_compressed_cert(3)
Certificate compression functions
SSL_CTX_set_client_hello_cb(3), SSL_client_hello_cb_fn(3), SSL_client_hello_isv2(3), SSL_client_hello_get0_legacy_version(3), SSL_client_hello_get0_random(3), SSL_client_hello_get0_session_id(3), SSL_client_hello_get0_ciphers(3), SSL_client_hello_get0_compression_methods(3), SSL_client_hello_get1_extensions_present(3), SSL_client_hello_get_extension_order(3), SSL_client_hello_get0_ext(3)
callback functions for early server-side ClientHello processing
SSL_SESSION_get_compress_id(3)
get details about the compression associated with a session
CMS_compress(3)
create a CMS CompressedData structure
CMS_compress(3ossl)
create a CMS CompressedData structure
CMS_uncompress(3)
uncompress a CMS CompressedData structure
CMS_uncompress(3ossl)
uncompress a CMS CompressedData structure
COMP_CTX_new(3ossl), COMP_CTX_get_method(3ossl), COMP_CTX_get_type(3ossl), COMP_get_type(3ossl), COMP_get_name(3ossl), COMP_CTX_free(3ossl), COMP_compress_block(3ossl), COMP_expand_block(3ossl), COMP_zlib(3ossl), COMP_zlib_oneshot(3ossl), COMP_brotli(3ossl), COMP_brotli_oneshot(3ossl), COMP_zstd(3ossl), COMP_zstd_oneshot(3ossl), BIO_f_zlib(3ossl), BIO_f_brotli(3ossl), BIO_f_zstd(3ossl)
Compression support
CURLOPT_ACCEPT_ENCODING(3)
automatic decompression of HTTP downloads
CURLOPT_SSH_COMPRESSION(3)
enable SSH compression
Dpkg::Compression(3perl)
simple database of available compression methods
Dpkg::Compression::FileHandle(3perl)
object dealing transparently with file compression
Dpkg::Compression::Process(3perl)
run compression/decompression processes
EC_POINT_set_Jprojective_coordinates_GFp(3), EC_POINT_point2buf(3), EC_POINT_new(3), EC_POINT_free(3), EC_POINT_clear_free(3), EC_POINT_copy(3), EC_POINT_dup(3), EC_POINT_method_of(3), EC_POINT_set_to_infinity(3), EC_POINT_get_Jprojective_coordinates_GFp(3), EC_POINT_set_affine_coordinates(3), EC_POINT_get_affine_coordinates(3), EC_POINT_set_compressed_coordinates(3), EC_POINT_set_affine_coordinates_GFp(3), EC_POINT_get_affine_coordinates_GFp(3), EC_POINT_set_compressed_coordinates_GFp(3), EC_POINT_set_affine_coordinates_GF2m(3), EC_POINT_get_affine_coordinates_GF2m(3), EC_POINT_set_compressed_coordinates_GF2m(3), EC_POINT_point2oct(3), EC_POINT_oct2point(3), EC_POINT_point2bn(3), EC_POINT_bn2point(3), EC_POINT_point2hex(3), EC_POINT_hex2point(3)
Functions for creating, destroying and manipulating EC_POINT objects
EC_POINT_set_Jprojective_coordinates_GFp(3ossl), EC_POINT_point2buf(3ossl), EC_POINT_new(3ossl), EC_POINT_free(3ossl), EC_POINT_clear_free(3ossl), EC_POINT_copy(3ossl), EC_POINT_dup(3ossl), EC_POINT_method_of(3ossl), EC_POINT_set_to_infinity(3ossl), EC_POINT_get_Jprojective_coordinates_GFp(3ossl), EC_POINT_set_affine_coordinates(3ossl), EC_POINT_get_affine_coordinates(3ossl), EC_POINT_set_compressed_coordinates(3ossl), EC_POINT_set_affine_coordinates_GFp(3ossl), EC_POINT_get_affine_coordinates_GFp(3ossl), EC_POINT_set_compressed_coordinates_GFp(3ossl), EC_POINT_set_affine_coordinates_GF2m(3ossl), EC_POINT_get_affine_coordinates_GF2m(3ossl), EC_POINT_set_compressed_coordinates_GF2m(3ossl), EC_POINT_point2oct(3ossl), EC_POINT_oct2point(3ossl), EC_POINT_point2bn(3ossl), EC_POINT_bn2point(3ossl), EC_POINT_point2hex(3ossl), EC_POINT_hex2point(3ossl)
Functions for creating, destroying and manipulating EC_POINT objects
LZSS_PACK_DATA(3)
Opaque structure for handling LZSS compression. Allegro game programming library
LZSS_UNPACK_DATA(3)
Opaque structure for handling LZSS decompression. Allegro game programming library
SSL_COMP_add_compression_method(3), SSL_COMP_get_compression_methods(3), SSL_COMP_get0_name(3), SSL_COMP_get_id(3), SSL_COMP_free_compression_methods(3)
handle SSL/TLS integrated compression methods
SSL_COMP_add_compression_method(3ossl), SSL_COMP_get_compression_methods(3ossl), SSL_COMP_get0_name(3ossl), SSL_COMP_get_id(3ossl), SSL_COMP_free_compression_methods(3ossl)
handle SSL/TLS integrated compression methods
SSL_CTX_set1_cert_comp_preference(3ossl), SSL_set1_cert_comp_preference(3ossl), SSL_CTX_compress_certs(3ossl), SSL_compress_certs(3ossl), SSL_CTX_get1_compressed_cert(3ossl), SSL_get1_compressed_cert(3ossl), SSL_CTX_set1_compressed_cert(3ossl), SSL_set1_compressed_cert(3ossl)
Certificate compression functions
SSL_CTX_set_client_hello_cb(3), SSL_client_hello_cb_fn(3), SSL_client_hello_isv2(3), SSL_client_hello_get0_legacy_version(3), SSL_client_hello_get0_random(3), SSL_client_hello_get0_session_id(3), SSL_client_hello_get0_ciphers(3), SSL_client_hello_get0_compression_methods(3), SSL_client_hello_get1_extensions_present(3), SSL_client_hello_get0_ext(3)
callback functions for early server-side ClientHello processing
SSL_CTX_set_client_hello_cb(3ossl), SSL_client_hello_cb_fn(3ossl), SSL_client_hello_isv2(3ossl), SSL_client_hello_get0_legacy_version(3ossl), SSL_client_hello_get0_random(3ossl), SSL_client_hello_get0_session_id(3ossl), SSL_client_hello_get0_ciphers(3ossl), SSL_client_hello_get0_compression_methods(3ossl), SSL_client_hello_get1_extensions_present(3ossl), SSL_client_hello_get_extension_order(3ossl), SSL_client_hello_get0_ext(3ossl)
callback functions for early server-side ClientHello processing
SSL_SESSION_get_compress_id(3)
get details about the compression associated with a session
SSL_SESSION_get_compress_id(3ossl)
get details about the compression associated with a session
TIFFWriteEncodedStrip(3tiff)
compress and write a strip of data to an open TIFF file
TIFFWriteEncodedTile(3tiff)
compress and write a tile of data to an open TIFF file
Tcl_ZlibAdler32.tcl86(3), Tcl_ZlibAdler32(3), Tcl_ZlibCRC32(3), Tcl_ZlibDeflate(3), Tcl_ZlibInflate(3), Tcl_ZlibStreamChecksum(3), Tcl_ZlibStreamClose(3), Tcl_ZlibStreamEof(3), Tcl_ZlibStreamGet(3), Tcl_ZlibStreamGetCommandName(3), Tcl_ZlibStreamInit(3), Tcl_ZlibStreamPut(3)
compression and decompression functions
Tcl_ZlibAdler32.tcl90(3), Tcl_ZlibAdler32(3), Tcl_ZlibCRC32(3), Tcl_ZlibDeflate(3), Tcl_ZlibInflate(3), Tcl_ZlibStreamChecksum(3), Tcl_ZlibStreamClose(3), Tcl_ZlibStreamEof(3), Tcl_ZlibStreamGet(3), Tcl_ZlibStreamGetCommandName(3), Tcl_ZlibStreamInit(3), Tcl_ZlibStreamPut(3)
compression and decompression functions
abcde(1)
Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, AAC, WavPack, Monkey's Audio (ape), MPP/MP+(Musepack), True Audio (tta), MP2 format and/or AIFF (Audio Interchange File Format)
advdef(1)
AdvanceCOMP Deflate Compression Utility
advmng(1)
AdvanceCOMP MNG Compression Utility
advpng(1)
AdvanceCOMP PNG Compression Utility
advzip(1)
AdvanceCOMP ZIP Compression Utility
afInitCompression(3)
initialize compression for a track in an audio file setup
affcopy(1)
reorder and recompress AFF files
amigadepacker(1)
Tool for depacking some compressed Amiga formats
archive_read_filter(3), archive_read_support_filter_all(3), archive_read_support_filter_bzip2(3), archive_read_support_filter_compress(3), archive_read_support_filter_gzip(3), archive_read_support_filter_lz4(3), archive_read_support_filter_lzma(3), archive_read_support_filter_none(3), archive_read_support_filter_rpm(3), archive_read_support_filter_uu(3), archive_read_support_filter_xz(3), archive_read_support_filter_zstd(3), archive_read_support_filter_program(3), archive_read_support_filter_program_signature(3)
functions for reading streaming archives
archive_util(3), archive_clear_error(3), archive_compression(3), archive_compression_name(3), archive_copy_error(3), archive_errno(3), archive_error_string(3), archive_file_count(3), archive_filter_code(3), archive_filter_count(3), archive_filter_name(3), archive_format(3), archive_format_name(3), archive_position(3), archive_set_error(3)
libarchive utility functions
archive_write_filter(3), archive_write_add_filter_b64encode(3), archive_write_add_filter_by_name(3), archive_write_add_filter_bzip2(3), archive_write_add_filter_compress(3), archive_write_add_filter_grzip(3), archive_write_add_filter_gzip(3), archive_write_add_filter_lrzip(3), archive_write_add_filter_lz4(3), archive_write_add_filter_lzip(3), archive_write_add_filter_lzma(3), archive_write_add_filter_lzop(3), archive_write_add_filter_none(3), archive_write_add_filter_program(3), archive_write_add_filter_uuencode(3), archive_write_add_filter_xz(3), archive_write_add_filter_zstd(3)
functions enabling output filters
aria_pack(1)
generate compressed, read-only Aria tables
asndhuff(1)
decompress compressed ASN.1 (CASN) files
barman-cloud-backup(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ { { -z | --gzip } | { -j | --bzip2 } | --snappy } ] [ { -h | --host } HOST ] [ { -p | --port } PORT ] [ { -U | --user } USER ] [ { -d | --dbname } DBNAME ] [ { -n | --name } BACKUP_NAME ] [ { -J | --jobs } JOBS ] [ { -S | --max-archive-size } MAX_ARCHIVE_SIZE ] [ --immediate-checkpoint ] [ --min-chunk-size MIN_CHUNK_SIZE ] [ --max-bandwidth MAX_BANDWIDTH ] [ --snapshot-instance SNAPSHOT_INSTANCE ] [ --snapshot-disk NAME [ --snapshot-disk NAME ... ] ] [ --snapshot-zone GCP_ZONE ] [ -snapshot-gcp-project GCP_PROJECT ] [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { -e | --encryption } { AES256 | aws:kms } ] [ --sse-kms-key-id SSE_KMS_KEY_ID ] [ --aws-region AWS_REGION ] [ --aws-await-snapshots-timeout AWS_AWAIT_SNAPSHOTS_TIMEOUT ] [ --aws-snapshot-lock-mode { compliance | governance } ] [ --aws-snapshot-lock-duration DAYS ] [ --aws-snapshot-lock-cool-off-period HOURS ] [ --aws-snapshot-lock-expiration-date DATETIME ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --encryption-scope ENCRYPTION_SCOPE ] [ --azure-subscription-id AZURE_SUBSCRIPTION_ID ] [ --azure-resource-group AZURE_RESOURCE_GROUP ] [ --gcp-project GCP_PROJECT ] [ --kms-key-name KMS_KEY_NAME ] [ --gcp-zone GCP_ZONE ] DESTINATION_URL SERVER_NAME Description The barman-cloud-backup script is used to create a local backup of a Postgres server and transfer it to a supported cloud provider, bypassing the Barman server. It can also be utilized as a hook script for copying Barman backups from the Barman server to one of the supported clouds (post_backup_retry_script). This script requires read access to PGDATA and tablespaces, typically run as the postgres user. When used on a Barman server, it requires read access to the directory where Barman backups are stored. If --snapshot- arguments are used and snapshots are supported by the selected cloud provider, the backup will be performed using snapshots of the specified disks (--snapshot-disk). The backup label and metadata will also be uploaded to the cloud. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 The cloud upload may fail if any file larger than the configured --max-archive-size is present in the data directory or tablespaces. However, Postgres files up to 1GB are always allowed, regardless of the --max-archive-size setting. Parameters 0.0 SERVER_NAME Name of the server to be backed up. DESTINATION_URL URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -z / --gzip gzip-compress the backup while uploading to the cloud (should not be used with python < 3.2). -j / --bzip2 bzip2-compress the backup while uploading to the cloud (should not be used with python < 3.3). --snappy snappy-compress the backup while uploading to the cloud (requires optional python-snappy library). -h / --host Host or Unix socket for Postgres connection (default: libpq settings). -p / --port Port for Postgres connection (default: libpq settings). -U / --user User name for Postgres connection (default: libpq settings). -d / --dbname Database name or conninfo string for Postgres connection (default: (dqpostgres(dq). -n / --name A name which can be used to reference this backup in commands such as barman-cloud-restore and barman-cloud-backup-delete. -J / --jobs Number of subprocesses to upload data to cloud storage (default: 2). -S / --max-archive-size Maximum size of an archive when uploading to cloud storage (default: 100GB). --immediate-checkpoint Forces the initial checkpoint to be done as quickly as possible. --min-chunk-size Minimum size of an individual chunk when uploading to cloud storage (default: 5MB for aws-s3, 64KB for azure-blob-storage, not applicable for google-cloud-storage). --max-bandwidth The maximum amount of data to be uploaded per second when backing up to object storages (default: 0 - no limit). --snapshot-instance Instance where the disks to be backed up as snapshots are attached. --snapshot-disk Name of a disk from which snapshots should be taken. --tag Tag to be added to all uploaded files in cloud storage, and/or to snapshots created, if snapshots are used. --tags Tags to be added to all uploaded files in cloud storage, and/or to snapshots created, if snapshots are used. NOTE: 0.0 3.5 If you are using --tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --tags is deprecated. Use --tag instead. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). -e / --encryption The encryption algorithm used when storing the uploaded data in S3. Allowed options: 7.0 (bu 2 AES256. (bu 2 aws:kms. --sse-kms-key-id The AWS KMS key ID that should be used for encrypting the uploaded data in S3. Can be specified using the key ID on its own or using the full ARN for the key. Only allowed if -e / --encryption is set to aws:kms. --aws-region The name of the AWS region containing the EC2 VM and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. --aws-await-snapshots-timeout The length of time in seconds to wait for snapshots to be created in AWS before timing out (default: 3600 seconds). --aws-snapshot-lock-mode The lock mode for the snapshot. This is only valid if --snapshot-instance and --snapshot-disk are set. Allowed options: 7.0 (bu 2 compliance. (bu 2 governance. --aws-snapshot-lock-duration The lock duration is the period of time (in days) for which the snapshot is to remain locked, ranging from 1 to 36,500. Set either the lock duration or the expiration date (not both). --aws-snapshot-lock-cool-off-period The cooling-off period is an optional period of time (in hours) that you can specify when you lock a snapshot in compliance mode, ranging from 1 to 72. --aws-snapshot-lock-expiration-date The lock duration is determined by an expiration date in the future. It must be at least 1 day after the snapshot creation date and time, using the format YYYY-MM-DDTHH:MM:SS.sssZ. Set either the lock duration or the expiration date (not both). Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default. --encryption-scope The name of an encryption scope defined in the Azure Blob Storage service which is to be used to encrypt the data in Azure. --azure-subscription-id The ID of the Azure subscription which owns the instance and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. --azure-resource-group The name of the Azure resource group to which the compute instance and disks defined by the --snapshot-instance and --snapshot-disk arguments belong. Extra options for GCP cloud provider 0.0 --gcp-project GCP project under which disk snapshots should be stored. --snapshot-gcp-project (deprecated) GCP project under which disk snapshots should be stored - replaced by --gcp-project. --kms-key-name The name of the GCP KMS key which should be used for encrypting the uploaded data in GCS. --gcp-zone Zone of the disks from which snapshots should be taken. --snapshot-zone (deprecated) Zone of the disks from which snapshots should be taken - replaced by --gcp-zone
barman-cloud-wal-archive(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-wal-archive [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ { { -z | --gzip } | { -j | --bzip2 } | --xz | --snappy | --zstd | --lz4 } ] [ --compression-level COMPRESSION_LEVEL ] [ --tag KEY,VALUE [ --tag KEY,VALUE ... ] ] [ --history-tag KEY,VALUE [ --history-tag KEY,VALUE ... ] ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { -e | --encryption } ENCRYPTION ] [ --sse-kms-key-id SSE_KMS_KEY_ID ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --encryption-scope ENCRYPTION_SCOPE ] [ --max-block-size MAX_BLOCK_SIZE ] [ --max-concurrency MAX_CONCURRENCY ] [ --max-single-put-size MAX_SINGLE_PUT_SIZE ] [ --kms-key-name KMS_KEY_NAME ] DESTINATION_URL SERVER_NAME [ WAL_PATH ] Description The barman-cloud-wal-archive command is designed to be used in the archive_command of a Postgres server to directly ship WAL files to cloud storage. NOTE: 0.0 3.5 If you are using Python 2 or unsupported versions of Python 3, avoid using the compression options --gzip or --bzip2. The script cannot restore gzip-compressed WALs on Python < 3.2 or bzip2-compressed WALs on Python < 3.3. This script enables the direct transfer of WAL files to cloud storage, bypassing the Barman server. Additionally, it can be utilized as a hook script for WAL archiving (pre_archive_retry_script). NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 SERVER_NAME Name of the server that will have the WALs archived. DESTINATION_URL URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. WAL_PATH The value of the (aq%p(aq keyword (according to archive_command). -V / --version Show version and exit. --help show this help message and exit. -v / --verbose Increase output verbosity (e.g., -vv is more than -v). -q / --quiet Decrease output verbosity (e.g., -qq is less than -q). -t / --test Test cloud connectivity and exit. --cloud-provider The cloud provider to use as a storage backend. Allowed options are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -z / --gzip gzip-compress the WAL while uploading to the cloud. -j / --bzip2 bzip2-compress the WAL while uploading to the cloud. --xz xz-compress the WAL while uploading to the cloud. --snappy snappy-compress the WAL while uploading to the cloud (requires the python-snappy Python library to be installed). --zstd zstd-compress the WAL while uploading to the cloud (requires the zstandard Python library to be installed). --lz4 lz4-compress the WAL while uploading to the cloud (requires the lz4 Python library to be installed). --compression-level A compression level to be used by the selected compression algorithm. Valid values are integers within the supported range of the chosen algorithm or one of the predefined labels: low, medium, and high. The range of each algorithm as well as what level each predefined label maps to can be found in %compression_level. --tag Tag to be added to archived WAL files in cloud storage. --tags Tag to be added to archived WAL files in cloud storage. NOTE: 0.0 3.5 If you are using --tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --tags is deprecated. Use --tag instead. 0.0 --history-tag Tag to be added to archived history files in cloud storage. --history-tags Tags to be added to archived history files in cloud storage. NOTE: 0.0 3.5 If you are using --history-tags before positional arguments, you must insert -- after it to indicate the end of optional arguments. This tells the parser to treat everything after -- as positional arguments. Without the --, Barman may misinterpret positional arguments as values for the last option. Deprecated since version 3.15: --history-tags is deprecated. Use --history-tag instead. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. -P / --aws-profile Profile name (e.g. INI section in AWS credentials file). --profile (deprecated) Profile name (e.g. INI section in AWS credentials file)
replaced by --aws-profile. --read-timeout The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). -e / --encryption The encryption algorithm used when storing the uploaded data in S3. Allowed options: 7.0 (bu 2 AES256. (bu 2 aws:kms. --sse-kms-key-id The AWS KMS key ID that should be used for encrypting the uploaded data in S3. Can be specified using the key ID on its own or using the full ARN for the key. Only allowed if -e / --encryption is set to aws:kms. Extra options for the Azure cloud provider 0.0 --azure-credential / --credential Optionally specify the type of credential to use when authenticating with Azure. If omitted then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. If no credentials can be found in the environment then the default Azure authentication flow will also be used for Azure Blob Storage. Allowed options are: 7.0 (bu 2 azure-cli. (bu 2 managed-identity. (bu 2 default. --encryption-scope The name of an encryption scope defined in the Azure Blob Storage service which is to be used to encrypt the data in Azure. --max-block-size The chunk size to be used when uploading an object via the concurrent chunk method (default: 4MB). --max-concurrency The maximum number of chunks to be uploaded concurrently (default: 1). --max-single-put-size Maximum size for which the Azure client will upload an object in a single request (default: 64MB). If this is set lower than the Postgres WAL segment size after any applied compression then the concurrent chunk upload method for WAL archiving will be used. Extra options for GCP cloud provider 0.0 --kms-key-name The name of the GCP KMS key which should be used for encrypting the uploaded data in GCS
bbftp(1)
transfer files using compression and parallel streams
bgzip(1)
Block compression/decompression utility EX in +$1 nf ft CR . EE ft fi in
blind-compress(1)
Compress a video for network transmission
blind-decompress(1)
Decompress a video compressed by blind-compress(1)
borg-compression(1)
Details regarding compression
brotli(1), brotli(1) -- brotli(1), unbrotli(1)
compress or decompress files
bz2(n)
Data compression "bz2"
bz3grep(1)
print lines matching a pattern in bzip3-compressed files
bz3less(1)
view bzip3-compressed files
bz3more(1)
view bzip3-compressed files
bz3most(1)
view bzip3-compressed files
bzgrep(1), bzfgrep(1), bzegrep(1)
search possibly bzip2 compressed files for a regular expression
bzip(1), bunzip(1)
a block-sorting file compressor, v0.21
bzip2(1), bunzip2(1)
a block-sorting file compressor, v1.0.8 bzcat - decompresses files to stdout bzip2recover - recovers data from damaged bzip2 files
bzip3(1)
an efficient statistical file compressor and spiritual successor to bzip2
bzmore(1), bzless(1)
file perusal filter for crt viewing of bzip2 compressed text
bzz(1)
DjVu general purpose compression utility
cckd(4)
Hercules Compressed CKD DASD image file
cjpeg(1)
compress an image file to a JPEG file
cjxl(1)
compress images to JPEG XL
compface(1), uncompface(1)
compress and expand 48x48x1 face image files
compface(3), uncompface(3)
compress and expand 48x48x1 face image files
cpicomp(1)
compress a CPI codepage by converting it to DRFONT format
cpidcomp(1)
compress a CPI codepage by converting it to DRFONT format
create_lzss_pack_data(3)
Creates an LZSS structure for compression. Allegro game programming library
create_lzss_unpack_data(3)
Creates an LZSS structure for decompression. Allegro game programming library
cwebp(1)
compress an image file to a WebP file
dact(1)
compress or expand a file or stream
dcmdjpeg(1)
Decode JPEG-compressed DICOM file
dcmdjpls(1)
Decode JPEG-LS compressed DICOM file
dcmdrle(1)
Decode RLE-compressed DICOM file
ddr_lzo(1)
Data de/compression plugin for dd_rescue
decode.h(3)
API for Brotli decompression
dictzip(1), dictunzip(1)
compress (or expand) files, allowing random access
djpeg(1)
decompress a JPEG file to an image file
djxl(1)
decompress JPEG XL images
dnsjit.input.zpcap(3)
Read input from a PCAP file that is compressed
dwebp(1)
decompress a WebP file to an image file
dxpc(1)
Differential X Protocol Compressor
encode.h(3)
API for Brotli compression
euler2d(6)
two dimensional incompressible inviscid fluid flow
fax2ps(1)
convert a TIFF facsimile to compressed PostScript™
fsck.cramfs(8)
fsck compressed ROM file system
gdal-vsi(1)
Entry point for GDAL Virtual System Interface (VSI) commands Added in version 3.11. The subcommands of gdal vsi allow manipulation of files located on the %GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl,
gl_compileboxmask(3)
compress a masked bitmap
glocatedb(5), locatedb(5)
front-compressed file name database
gnutls_compress_certificate_get_selected_method(3)
API function
gnutls_compress_certificate_set_methods(3)
API function
gnutls_compression_get(3)
API function
gnutls_compression_get_id(3)
API function
gnutls_compression_get_name(3)
API function
gnutls_compression_list(3)
API function
gnutls_priority_compression_list(3)
API function
gsm(3), gsm_create(3)
gsm_destroy, gsm_encode, gsm_decode GSM 06.10 lossy sound compression
gzexe(1)
compress executable files in place
gzip(1), gunzip(1), zcat(1)
compress or expand files
humanzip(1), humanunzip(1)
(un)compress text files in a human readable way
hunzip(1)
compress and encrypt dictionary files
hunzip(1)
decompress and decrypt hzip files to the standard output
hwloc-compress-dir(1)
Compress a directory of XML topologies
icepatch2calc(1)
IcePatch2 tool to compress files and calculate checksums
igzip(1)
compress or decompress files similar to gzip
jpegoptim(1)
utility to optimize/compress JPEG/JFIF files
khttp_body(3), khttp_body_compress(3)
close the HTTP header sequence for kcgi
knet_get_compress_list(3)
Get a list of support compression types
knet_handle_compress(3)
Set up packet compression
knet_handle_get_stats(3)
Get statistics for compression & crypto
lbrate(1)
extract/decompress CP/M LBR archives
ldns_rr(3), ldns_rr_class(3), ldns_rr_type(3), ldns_rr_compress(3), ldns_rr_list(3)
types representing dns resource records
ldns_rr_uncompressed_size(3)
calculates the uncompressed size of an RR
lhasa(1), lha(1)
compression tool for .lzh archive files
libewf(3), libewf.h(3)
Library to access the Expert Witness Compression Format (EWF) format
home | help