home | help
fuser(1)
list IDs of all processes that have one or more files open
vm_page_dontneed(9)
indicate that a page is not needed anymore
ypmatch(1)
print the values of one or more keys in a NIS database
zmore(1), zless(1)
view compressed files
PEM_X509_INFO_read_ex(3), PEM_X509_INFO_read(3), PEM_X509_INFO_read_bio_ex(3), PEM_X509_INFO_read_bio(3)
read PEM-encoded data structures into one or more X509_INFO objects
SSL_poll(3), SSL_POLL_EVENT_NONE(3), SSL_POLL_EVENT_F(3), SSL_POLL_EVENT_EL(3), SSL_POLL_EVENT_EC(3), SSL_POLL_EVENT_ECD(3), SSL_POLL_EVENT_ER(3), SSL_POLL_EVENT_EW(3), SSL_POLL_EVENT_R(3), SSL_POLL_EVENT_W(3), SSL_POLL_EVENT_IC(3), SSL_POLL_EVENT_ISB(3), SSL_POLL_EVENT_ISU(3), SSL_POLL_EVENT_OSB(3), SSL_POLL_EVENT_OSU(3), SSL_POLL_EVENT_RW(3), SSL_POLL_EVENT_RE(3), SSL_POLL_EVENT_WE(3), SSL_POLL_EVENT_RWE(3), SSL_POLL_EVENT_E(3), SSL_POLL_EVENT_IS(3), SSL_POLL_EVENT_ISE(3), SSL_POLL_EVENT_I(3), SSL_POLL_EVENT_OS(3), SSL_POLL_EVENT_OSE(3), SSL_POLL_FLAG_NO_HANDLE_EVENTS(3)
determine or await readiness conditions for one or more pollable objects
/cowthink(1)
configurable speaking/thinking cow (and a bit more)
44bsd-more(1), more(1)
file perusal filter for crt viewing
DC_PLUG_read(2), DC_PLUG_consume(2), DC_PLUG_write(2), DC_PLUG_write_more(2), DC_PLUG_commit(2), DC_PLUG_rollback(2)
DC_PLUG read/write functions
MoreLabels(3o)
Extra labeled libraries
MoreLabels.Hashtbl(3o)
no description
MoreLabels.Hashtbl.HashedType(3o)
The input signature of the functor MoreLabels.Hashtbl.Make
MoreLabels.Hashtbl.Make(3o)
Functor building an implementation of the hashtable structure
MoreLabels.Hashtbl.MakeSeeded(3o)
Functor building an implementation of the hashtable structure
MoreLabels.Hashtbl.S(3o)
The output signature of the functor MoreLabels.Hashtbl.Make
MoreLabels.Hashtbl.SeededHashedType(3o)
The input signature of the functor MoreLabels.Hashtbl.MakeSeeded
MoreLabels.Hashtbl.SeededS(3o)
The output signature of the functor MoreLabels.Hashtbl.MakeSeeded
MoreLabels.Map(3o)
no description
MoreLabels.Map.Make(3o)
Functor building an implementation of the map structure given a totally ordered type
MoreLabels.Map.OrderedType(3o)
Input signature of the functor MoreLabels.Map.Make
MoreLabels.Map.S(3o)
Output signature of the functor MoreLabels.Map.Make
MoreLabels.Set(3o)
no description
MoreLabels.Set.Make(3o)
Functor building an implementation of the set structure given a totally ordered type
MoreLabels.Set.OrderedType(3o)
Input signature of the functor MoreLabels.Set.Make
MoreLabels.Set.S(3o)
Output signature of the functor MoreLabels.Set.Make
PEM_X509_INFO_read_ex(3ossl), PEM_X509_INFO_read(3ossl), PEM_X509_INFO_read_bio_ex(3ossl), PEM_X509_INFO_read_bio(3ossl)
read PEM-encoded data structures into one or more X509_INFO objects
SSL_poll(3ossl), SSL_POLL_EVENT_NONE(3ossl), SSL_POLL_EVENT_F(3ossl), SSL_POLL_EVENT_EL(3ossl), SSL_POLL_EVENT_EC(3ossl), SSL_POLL_EVENT_ECD(3ossl), SSL_POLL_EVENT_ER(3ossl), SSL_POLL_EVENT_EW(3ossl), SSL_POLL_EVENT_R(3ossl), SSL_POLL_EVENT_W(3ossl), SSL_POLL_EVENT_IC(3ossl), SSL_POLL_EVENT_ISB(3ossl), SSL_POLL_EVENT_ISU(3ossl), SSL_POLL_EVENT_OSB(3ossl), SSL_POLL_EVENT_OSU(3ossl), SSL_POLL_EVENT_RW(3ossl), SSL_POLL_EVENT_RE(3ossl), SSL_POLL_EVENT_WE(3ossl), SSL_POLL_EVENT_RWE(3ossl), SSL_POLL_EVENT_E(3ossl), SSL_POLL_EVENT_IS(3ossl), SSL_POLL_EVENT_ISE(3ossl), SSL_POLL_EVENT_I(3ossl), SSL_POLL_EVENT_OS(3ossl), SSL_POLL_EVENT_OSE(3ossl), SSL_POLL_FLAG_NO_HANDLE_EVENTS(3ossl)
determine or await readiness conditions for one or more pollable objects
Stdlib.MoreLabels(3o)
no description
Tspi_TPM_Quote2(3)
retreive a signed set of PCR values with a more complete view than Tspi_TPM_Quote
XkbCopyKeyTypes(3)
Copy more than one XkbKeyTypeRec structure
XkbGetControlsChanges(3)
Updates a local copy of a keyboard description with the changes previously noted by one or more calls to XkbNoteControlsChanges
XkbGetIndicatorMap(3)
Gets the map for one or more indicators, using a mask to specify the indicators
XkbGetKeyModifierMap(3)
Update the modifier map for one or more of the keys in a keyboard description
XkbGetKeyboard(3)
Retrieves one or more components of a keyboard device description
XkbListComponents(3)
List of components for one or more component types
XkbSelectEvents(3)
Selects and / or deselects for delivery of one or more Xkb events and has them delivered under all conditions
XkbSetIndicatorMap(3)
Downloads the changes to the server based on modifications to a local copy of the keyboard description which will update the maps for one or more indicators
XmAddToPostFromList(3)
a RowColumn function that makes a menu accessible from more than one widget "XmAddToPostFromList" "RowColumn functions" "XmAddToPostFromList"
affstats(1)
print specific statistics about one or more AFF files
alsa-seq-server(8)
daemon that converts one or more raw MIDI device(s) into an ALSA sequencer server
appjail-image(1)
Create, list, remove, update images and much more
avahi-resolve(1)
Resolve one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon
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 | --lz4 } ] [ { -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 ] [ --addressing-style { auto | virtual | path } ] [ { -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). --lz4 lz4-compress the backup while uploading to the cloud (requires optional lz4 Python 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. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -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-backup-delete(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-delete [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -r | --retention-policy } RETENTION_POLICY ] [ { -m | --minimum-redundancy } MINIMUM_REDUNDANCY ] [ { -b | --backup-id } BACKUP_ID] [ --dry-run ] [ --check-object-lock ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [--batch-size DELETE_BATCH_SIZE] SOURCE_URL SERVER_NAME Description The barman-cloud-backup-delete script is used to delete one or more backups created with the barman-cloud-backup command from cloud storage and to remove the associated WAL files. Backups can be specified for deletion either by their backup ID (as obtained from barman-cloud-backup-list) or by a retention policy. Retention policies mirror those used by the Barman server, deleting all backups that are not required to meet the specified policy. When a backup is deleted, any unused WAL files associated with that backup are also removed. WALs are considered unused if: 0.0 (bu 2 The WALs predate the begin_wal value of the oldest remaining backup. (bu 2 The WALs are not required by any archival backups stored in the cloud. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 Each backup deletion involves three separate requests to the cloud provider: one for the backup files, one for the backup.info file, and one for the associated WALs. Deleting by retention policy may result in a high volume of delete requests if a large number of backups are accumulated in cloud storage. IMPORTANT: 0.0 3.5 Starting with AWS boto3 1.36, the behavior of Data Integrity Protection checks has changed. Some methods used by Barman no longer require the Content-MD5 header. This means that S3-compatible storage providers that have not updated their server-side code may fail when used with newer boto3 versions. For example, MinIO addressed this change shortly after the boto3 1.36 announcement. If you are using MinIO, you must upgrade to the latest release (or at least RELEASE.2025-02-03T21-03-04Z or newer) to ensure compatibility and avoid failures. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be deleted. SOURCE_URL URL of the cloud source, 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 are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. -b / --backup-id ID of the backup to be deleted. You can use a shortcut instead of the backup ID. -m / --minimum-redundancy The minimum number of backups that should always be available. -r / --retention-policy If specified, delete all backups eligible for deletion according to the supplied retention policy. Syntax: REDUNDANCY value | RECOVERY WINDOW OF value { DAYS | WEEKS | MONTHS } --batch-size The maximum number of objects to be deleted in a single request to the cloud provider. If unset then the maximum allowed batch size for the specified cloud provider will be used (1000 for aws-s3, 256 for azure-blob-storage and 100 for google-cloud-storage). --dry-run Find the objects which need to be deleted but do not delete them. Extra options for the AWS cloud provider 0.0 --check-object-lock Check whether backup files are protected by S3 Object Lock before attempting deletion. Enable this when your S3 bucket has Object Lock configured and you want to ensure deletion operations respect object-level retention policies. If any base backup file is locked (either by an active retention period or legal hold), the deletion is aborted with an error. For performance reasons, lock checks are only performed for base backup files, since once the base backup is removed, the corresponding WAL files are no longer useful. Note that this check requires one request per file to check the lock status, which may increase deletion time for backups with many files. This feature is only available for AWS S3-compatible object stores and it also requires the s3:GetObjectRetention and s3:GetObjectLegalHold IAM permissions. --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -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). 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
barman-cloud-backup-keep(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-keep [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ { { -r | --release } | { -s | --status } | --target { full | standalone } } ] SOURCE_URL SERVER_NAME BACKUP_ID Description Use this script to designate backups in cloud storage as archival backups, ensuring their indefinite retention regardless of retention policies. This script allows you to mark backups previously created with barman-cloud-backup as archival backups. Once flagged as archival, these backups are preserved indefinitely and are not subject to standard retention policies. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. IMPORTANT: 0.0 3.5 Starting with AWS boto3 1.36, the behavior of Data Integrity Protection checks has changed. Some methods used by Barman no longer require the Content-MD5 header. This means that S3-compatible storage providers that have not updated their server-side code may fail when used with newer boto3 versions. For example, MinIO addressed this change shortly after the boto3 1.36 announcement. If you are using MinIO, you must upgrade to the latest release (or at least RELEASE.2025-02-03T21-03-04Z or newer) to ensure compatibility and avoid failures when releasing a keep annotation. Parameters 0.0 SERVER_NAME Name of the server that holds the backup to be kept. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. BACKUP_ID The ID of the backup to be kept. You can use a shortcut instead of the backup ID. -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. -r / --release If specified, the command will remove the keep annotation and the backup will be eligible for deletion. -s / --status Print the keep status of the backup. --target Specify the recovery target for this backup. Allowed options are: 7.0 (bu 2 full (bu 2 standalone 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). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). 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
barman-cloud-backup-list(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-list [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --format FORMAT ] SOURCE_URL SERVER_NAME Description This script lists backups stored in the cloud that were created using the barman-cloud-backup command. 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 holds the backup to be listed. SOURCE_URL URL of the cloud source, 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 are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --format Output format (console or json). Default console. 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). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). 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
barman-cloud-backup-show(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-backup-show [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --format FORMAT ] SOURCE_URL SERVER_NAME BACKUP_ID Description This script displays detailed information about a specific backup created with the barman-cloud-backup command. The output is similar to the barman show-backup from the %barman show-backup command reference, but it has fewer information. NOTE: 0.0 3.5 For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. Parameters 0.0 BACKUP_ID The ID of the backup. You can use a shortcut instead of the backup ID. SERVER_NAME Name of the server that holds the backup to be displayed. SOURCE_URL URL of the cloud source, 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 are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --format Output format (console or json). Default console. 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). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). 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
barman-cloud-check-wal-archive(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-check-wal-archive [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ --addressing-style { auto | virtual | path } ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --timeline TIMELINE ] DESTINATION_URL SERVER_NAME Description Verify that the WAL archive destination for a server is suitable for use with a new Postgres cluster. By default, the check will succeed if the WAL archive is empty or if the target bucket is not found. Any other conditions will result in a failure. NOTE: 0.0 3.5 The barman-cloud-check-wal-archive command performs an initial HeadBucket call to verify whether the target bucket already exists in the S3 storage. If the bucket does not exist, the command will attempt to automatically create it. This is the only Barman command that performs these operations (bucket existence check and automatic creation). 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 needs to be checked. 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 are: 7.0 (bu 2 aws-s3. (bu 2 azure-blob-storage. (bu 2 google-cloud-storage. --timeline The earliest timeline whose WALs should cause the check to fail. 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). --addressing-style The S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require a specific addressing style. Allowed options: 7.0 (bu 2 auto (default): Uses the addressing style determined by the boto3 library. (bu 2 virtual: Uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (s3.amazonaws.com/bucket-name). 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
barman-cloud-restore(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-restore [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE ] [ --snapshot-recovery-zone GCP_ZONE ] [ --aws-region AWS_REGION ] [ --gcp-zone GCP_ZONE ] [ --azure-resource-group AZURE_RESOURCE_GROUP ] [ --tablespace NAME:LOCATION [ --tablespace NAME:LOCATION ... ] ] [ --target-lsn LSN ] [ --target-time TIMESTAMP ] [ --target-tli TLI ] SOURCE_URL SERVER_NAME BACKUP_ID RECOVERY_DESTINATION Description Use this script to restore a backup directly from cloud storage that was created with the barman-cloud-backup command. Additionally, this script can prepare for recovery from a snapshot backup by verifying that attached disks were cloned from the correct snapshots and by downloading the backup label from object storage. This command does not automatically prepare Postgres for recovery. You must manually manage any %PITR options, custom restore_command values, signal files, or required WAL files to ensure Postgres starts, either manually or using external tools. 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 holds the backup to be restored. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. BACKUP_ID The ID of the backup to be restored. You can use a shortcut instead of the backup ID. Besides that, you can use auto to have Barman automatically find the most suitable backup for the restore operation. RECOVERY_DESTINATION The path to a directory for recovery. -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. --snapshot-recovery-instance Instance where the disks recovered from the snapshots are attached. --tablespace Tablespace relocation rule. --target-lsn The recovery target lsn, e.g., 3/64000000. --target-time The recovery target timestamp with or without timezone, in the format %Y-%m-%d %H:%M:%S. --target-tli The recovery target timeline. Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -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). --aws-region The name of the AWS region containing the EC2 VM and storage volumes defined by the --snapshot-instance and --snapshot-disk arguments. 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. --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-zone Zone of the disks from which snapshots should be taken. --snapshot-recovery-zone (deprecated) Zone containing the instance and disks for the snapshot recovery - 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 ] [ --addressing-style { auto | virtual | path } ] [ { -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. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -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
barman-cloud-wal-restore(1) - Barman-cloud Commands Synopsis 0.0 3.5 barman-cloud-wal-restore [ { -V | --version } ] [ --help ] [ { { -v | --verbose } | { -q | --quiet } } ] [ { -t | --test } ] [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ] [ --endpoint-url ENDPOINT_URL ] [ --addressing-style { auto | virtual | path } ] [ { -P | --aws-profile } AWS_PROFILE ] [ --profile AWS_PROFILE ] [ --read-timeout READ_TIMEOUT ] [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ] [ --no-partial ] SOURCE_URL SERVER_NAME WAL_NAME WAL_DEST Description The barman-cloud-wal-restore script functions as the restore_command for retrieving WAL files from cloud storage and placing them directly into a Postgres standby server, bypassing the Barman server. This script is used to download WAL files that were previously archived with the barman-cloud-wal-archive command. Disable automatic download of .partial files by calling --no-partial option. IMPORTANT: 0.0 3.5 On the target Postgres node, when pg_wal and the spool directory are on the same filesystem, files are moved via renaming, which is faster than copying and deleting. This speeds up serving WAL files significantly. If the directories are on different filesystems, the process still involves copying and deleting, so there(aqs no performance gain in that case. 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 WALs restored. SOURCE_URL URL of the cloud source, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. WAL_NAME The value of the (aq%f(aq keyword (according to restore_command). WAL_DEST The value of the (aq%p(aq keyword (according to restore_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. --no-partial Do not download partial WAL files Extra options for the AWS cloud provider 0.0 --endpoint-url Override default S3 endpoint URL with the given one. --addressing-style The addressing style to use for S3 requests. This is useful when connecting to S3-compatible services that require a specific addressing style. Allowed options are: 7.0 (bu 2 auto (default): Uses the addressing style determined by the underlying library. (bu 2 virtual: Uses virtual-hosted style addressing (e.g., bucket-name.s3.amazonaws.com). (bu 2 path: Uses path-style addressing (e.g., s3.amazonaws.com/bucket-name). -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). 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
bastille-list(8), bastille list(8)
List jails, releases, templates and more
bastille-setup(8), bastille setup(8)
Auto-configure network, firewall, storage and more
beetsconfig(5)
beets configuration file Beets has an extensive configuration system that lets you customize nearly every aspect of its operation. To configure beets, you create a file called config.yaml. The location of the file depends on your platform (type beet config -p to see the path on your system): 0.0 (bu 2 On Unix-like OSes, write ~/.config/beets/config.yaml. (bu 2 On Windows, use %APPDATA%ebeetseconfig.yaml. This is usually in a directory like C:eUserseYoueAppDataeRoaming. (bu 2 On OS X, you can use either the Unix location or ~/Library/Application Support/beets/config.yaml. You can launch your text editor to create or update your configuration by typing beet config -e. (See the %config command for details.) It is also possible to customize the location of the configuration file and even use multiple layers of configuration. See %Configuration Location, below. The config file uses X'tty: link https://yaml.org/'%YAMLX'tty: link' syntax. You can use the full power of YAML, but most configuration options are simple key/value pairs. This means your config file will look like this: 0.0 3.5 C option: value another_option: foo bigger_option: key: value foo: bar P In YAML, you will need to use spaces (not tabs!) to indent some lines. If you have questions about more sophisticated syntax, take a look at the X'tty: link https://yaml.org/'%YAMLX'tty: link' documentation. The rest of this page enumerates the dizzying litany of configuration options available in beets. You might also want to see an %example. 0.0 (bu 2 %Global Options 2.0 (bu 2 %library (bu 2 %directory (bu 2 %plugins (bu 2 %include (bu 2 %pluginpath (bu 2 %ignore (bu 2 %ignore_hidden (bu 2 %replace (bu 2 %path_sep_replace (bu 2 %asciify_paths (bu 2 %art_filename (bu 2 %threaded (bu 2 %format_item (bu 2 %format_album (bu 2 %sort_item (bu 2 %sort_album (bu 2 %sort_case_insensitive (bu 2 %original_date (bu 2 %overwrite_null (bu 2 %artist_credit (bu 2 %per_disc_numbering (bu 2 %aunique (bu 2 %sunique (bu 2 %terminal_encoding (bu 2 %clutter (bu 2 %max_filename_length (bu 2 %id3v23 (bu 2 %va_name (bu 2 %UI Options 2.0 (bu 2 %color (bu 2 %colors (bu 2 %terminal_width (bu 2 %length_diff_thresh (bu 2 %import (bu 2 %Importer Options 2.0 (bu 2 %write (bu 2 %copy (bu 2 %move (bu 2 %link (bu 2 %hardlink (bu 2 %reflink (bu 2 %resume (bu 2 %incremental (bu 2 %incremental_skip_later (bu 2 %from_scratch (bu 2 %quiet (bu 2 %quiet_fallback (bu 2 %none_rec_action (bu 2 %timid (bu 2 %log (bu 2 %default_action (bu 2 %languages (bu 2 %ignored_alias_types (bu 2 %detail (bu 2 %group_albums (bu 2 %autotag (bu 2 %duplicate_keys (bu 2 %duplicate_action (bu 2 %duplicate_verbose_prompt (bu 2 %bell (bu 2 %set_fields (bu 2 %singleton_album_disambig (bu 2 %Autotagger Matching Options 2.0 (bu 2 %max_rec (bu 2 %preferred (bu 2 %ignored (bu 2 %required (bu 2 %ignored_media (bu 2 %ignore_data_tracks (bu 2 %ignore_video_tracks (bu 2 %Path Format Configuration (bu 2 %Configuration Location 2.0 (bu 2 %Environment Variable (bu 2 %Command-Line Option (bu 2 %Default Location (bu 2 %Example
bmore(1)
browse through a binary file
buildah-manifest-rm(1)
Removes one or more manifest lists
buildah-rm(1)
Removes one or more working containers
buildah-rmi(1)
Removes one or more images
bz3more(1)
view bzip3-compressed files
bzmore(1), bzless(1)
file perusal filter for crt viewing of bzip2 compressed text
cdbkup(1)
Backup a filesystem to one or more CD-R(W)s
cdcat(1)
Copy data from one or more CD-ROMs to STDOUT
cdrstr(1)
Restore a backed up filesystem from one or more CD-R(W)s
cdsplit(1)
Copy the output of any shell command onto one or more CD-R(W)s
cgi_url_escape_more(3), cgi_url_escape_more (3)
url escape a string
cless(1)
opposite of more
clubak(1)
format output from clush/pdsh-like output and more
convert(1)
convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more
copydatabase(1)
Perform a document-by-document copy of one or more Xapian databases
cpg_join(3)
Joins one or more groups in the CPG library
cvsd(8)
chroot wrapper to run (oqcvs pserver(cq more securely
dcm2mnc(1)
convert sets of DICOM files to one or more MINC format files
destroy.tk86(n), destroy(n)
Destroy one or more windows
digestion.pl(1)
A perl script to create a digest over one or more fields in a tab delimited list
dust(1), Dust(1)
Like du but more intuitive
easytag(1)
tag editor for MP3, Ogg Vorbis files and more
eza_colors-explanation(5)
[em] more details on customizing eza colors
fi_poll(3)
Polling and wait set operations fi_poll_open / fi_close Open/close a polling set fi_poll_add / fi_poll_del Add/remove a completion queue or counter to/from a poll set. fi_poll Poll for progress and events across multiple completion queues and counters. fi_wait_open / fi_close Open/close a wait set fi_wait Waits for one or more wait objects in a set to be signaled. fi_trywait Indicate when it is safe to block on wait objects using native OS calls. fi_control Control wait set operation or attributes
five-or-more(6), Five or More(6)
GNOME port of the once-popular Colour Lines game
fnts2fon(1)
Construct a Windows .FON file from one or more .FNT files
foreach.tcl86(n), foreach(n)
Iterate over all elements in one or more lists
foreach.tcl90(n), foreach(n)
Iterate over all elements in one or more lists
ftimes-dbm-find(1)
Find one or more keys in a Berkeley database
ftimes-dbm-reap(1)
Extract unresolved keys from one or more files
funnel(1)
split one pipe stream to one or more files or programs
getkey(1)
fetch one or more keys from an OpenPGP keyserver
getmail(1)
retrieve messages from one or more POP3, IMAP4, or SDPS mailboxes and deliver to a maildir, mboxrd-format mbox file, or external MDA
getmail_fetch(1)
retrieve messages from one or more POP3 or POP3-over-SSL mailboxes and deliver to a maildir, mboxrd-format mbox file, or external MDA
gfx_mode_select_filter(3)
Even more extended version of the graphics mode selection dialog. Allegro game programming library
gh-browse(1)
Open repositories, issues, pull requests, and more in the browser
git-merge(1)
Join two or more development histories together
glab-stack-amend(1)
Save more changes to a stacked diff. (EXPERIMENTAL)
gps2udp(1)
feed the take from gpsd to one or more aggregation sites
hashdig-find(1), hashdig-find.pl(1)
Find one or more hashes in a HashDig database
hashdig-harvest(1), hashdig-harvest.pl(1)
Harvest hashes from a one or more input files
hipdig(1), hipdig.pl(1)
Dig for hosts, IPs, passwords, and more
identify(1)
describes the format and characteristics of one or more image files
jose-jwe-enc(1)
Encrypts plaintext using one or more JWK/password
jose-jws-sig(1)
Signs a payload using one or more JWKs
krb5_principal_intro(3)
The principal handing functions. A Kerberos principal is a email address looking string that contains two parts separated by . The second part is the kerberos realm the principal belongs to and the first is a list of 0 or more components. For example lha@SU.SE host/hummel.it.su.se@SU.SE host/admin@H5L.ORG See the library functions here: Heimdal Kerberos 5 principal functions
lartg(3)
lartg: generate plane rotation, more accurate than BLAS rot
lartgp(3)
lartgp: generate plane rotation, more accurate than BLAS rot
leaf(1)
Lightweight Editor of Ascii(and more) Files
less(1)
opposite of more
home | help