neulab/tldr huggingface dataset:
MaxDiskWriteTask The task ID where the maxdiskwrite occurred.
MaxPages  Maximum number of page faults of all tasks in job.
MaxPagesNode The node on which the maxpages occurred.
MaxPagesTask The task ID where the maxpages occurred.
MaxRSS    Maximum resident set size of all tasks in job.
MaxRSSNode The node on which the maxrss occurred.
MaxRSSTask The task ID where the maxrss occurred.
MaxVMSize Maximum Virtual Memory size of all tasks in job.
MaxVMSizeNode The node on which the maxvmsize occurred.
MaxVMSizeTask The task ID where the maxvmsize occurred.
MinCPU    Minimum (system + user) CPU time of all tasks in job.
MinCPUNode The node on which the mincpu occurred.
MinCPUTask The task ID where the mincpu occurred.
NCPUS     Total number of CPUs allocated to the job.  Equivalent to AllocCPUS.
NodeList  List of nodes in job/step.
NNodes    Number of nodes in a job or step.  If the job is running, or ran, this count will be the number allocated, else the number will be the number requested.
NTasks    Total number of tasks in a job or step.
Priority  Slurm priority.
Partition Identifies the partition on which the job ran.
QOS       Name of Quality of Service.
QOSRAW    Numeric id of Quality of Service.
ReqCPUFreq Requested CPU frequency for the step, in kHz.  Note: This value applies only to a job step. No value is reported for the job.
ReqCPUFreqGov Requested CPU frequency governor for the step, in kHz. Note: This value applies only to a job step. No value is reported for the job.
ReqCPUFreqMax Maximum requested CPU frequency for the step, in kHz. Note: This value applies only to a job step. No value is reported for the job.
ReqCPUFreqMin Minimum requested CPU frequency for the step, in kHz. Note: This value applies only to a job step. No value is reported for the job.
ReqCPUS   Number of requested CPUs.
ReqMem    Minimum required memory for the job, in MB. A 'c' at the end of number represents Memory Per CPU, a 'n' represents Memory Per Node.  Note: This value is only from the job allocation, not the step.
ReqNodes  Requested minimum Node count for the job/step.
ReqTres   Trackable resources. These are the minimum resource counts requested by the job/step at submission time. For more details see AccountingStorageTRES in slurm.conf.
Reservation Reservation Name.
ReservationId Reservation Id.
Reserved  How much wall clock time was used as reserved time for this job.  This is derived from how long a job was waiting from eligible time to when it actually started. Format is the same as Elapsed.
ResvCPU   How many CPU seconds were used as reserved time for this job.  Format is the same as Elapsed.
ResvCPURAW How many CPU seconds were used as reserved time for this job.  Format is in processor seconds.
Start     Initiation time of the job in the same format as End.
State     Displays the job status, or state.  See the JOB STATE CODES section below for a list of possible states.
If more information is available on the job state than will fit into the current field width (for example, the uid that CANCELLED a job) the state will be followed by a "+".  You can increase the size of the displayed state using the "%NUMBER" format modifier described earlier.
NOTE: The RUNNING state will return suspended jobs as well.  In order to print suspended jobs you must request SUSPENDED at a different call from RUNNING.
NOTE: The RUNNING state will return any jobs completed (cancelled or otherwise) in the time period requested as the job was also RUNNING during that time.  If you are only looking for jobs that finished, please choose the appropriate state(s) without the RUNNING state.
Submit    The time the job was submitted in the same format as End.
NOTE: If a job is requeued, the submit time is reset. To obtain the original submit time it is necessary to use the -D or --duplicate option to display all duplicate entries for a job.
Suspended The amount of time a job or job step was suspended. Format is the same as Elapsed.
SystemCPU The amount of system CPU time used by the job or job step. Format is the same as Elapsed.
NOTE: SystemCPU provides a measure of the task's parent process and does not include CPU time of child processes.
Timelimit What the timelimit was/is for the job. Format is the same as Elapsed.
TimelimitRaw What the timelimit was/is for the job. Format is in number of minutes.
TotalCPU  The sum of the SystemCPU and UserCPU time used by the job or job step.  The total CPU time of the job may exceed the job's elapsed time for jobs that include multiple job steps. Format is the same as Elapsed.
NOTE: TotalCPU provides a measure of the task's parent process and does not include CPU time of child processes.
TresUsageInAve Tres average usage in by all tasks in job.  NOTE: If corresponding TresUsageInMaxTask is -1 the metric is node centric instead of task.
TresUsageInMax Tres maximum usage in by all tasks in job.  NOTE: If corresponding TresUsageInMaxTask is -1 the metric is node centric instead of task.
TresUsageInMaxNode Node for which each maximum TRES usage out occurred.
TresUsageInMaxTask Task for which each maximum TRES usage out occurred.
TresUsageInMin Tres minimum usage in by all tasks in job.  NOTE: If corresponding TresUsageInMinTask is -1 the metric is node centric instead of task.
TresUsageInMinNode Node for which each minimum TRES usage out occurred.
TresUsageInMinTask Task for which each minimum TRES usage out occurred.
TresUsageInTot Tres total usage in by all tasks in job.
TresUsageOutAve Tres average usage out by all tasks in job.  NOTE: If corresponding TresUsageOutMaxTask is -1 the metric is node centric instead of task.
TresUsageOutMax Tres maximum usage out by all tasks in job.  NOTE: If corresponding TresUsageOutMaxTask is -1 the metric is node centric instead of task.
TresUsageOutMaxNode Node for which each maximum TRES usage out occurred.
TresUsageOutMaxTask Task for which each maximum TRES usage out occurred.
TresUsageOutTot Tres total usage out by all tasks in job.
UID       The user identifier of the user who ran the job.
User      The user name of the user who ran the job.
UserCPU   The amount of user CPU time used by the job or job step. Format is the same as Elapsed.
NOTE: UserCPU provides a measure of the task's parent process and does not include CPU time of child processes.
WCKey     Workload  Characterization  Key.   Arbitrary  string for grouping orthogonal accounts together.
WCKeyID   Reference to the wckey.
BF  BOOT_FAIL       Job terminated due to launch failure, typically due to a hardware failure (e.g. unable to boot the node or block and the job can not be requeued).
CA  CANCELLED       Job was explicitly cancelled by the user or system administrator.  The job may or may not have been initiated.
CD  COMPLETED       Job has terminated all processes on all nodes with an exit code of zero.
DL  DEADLINE        Job terminated on deadline.
F   FAILED          Job terminated with non-zero exit code or other failure condition.
NF  NODE_FAIL       Job terminated due to failure of one or more allocated nodes.
OOM OUT_OF_MEMORY   Job experienced out of memory error.
PD  PENDING         Job is awaiting resource allocation.
PR  PREEMPTED       Job terminated due to preemption.
R   RUNNING         Job currently has an allocation.
RQ  REQUEUED        Job was requeued.
RS  RESIZING        Job is about to change size.
RV  REVOKED         Sibling was removed from cluster due to other cluster starting the job.
S   SUSPENDED       Job has an allocation, but execution has been suspended and CPUs have been released for other jobs.
TO  TIMEOUT         Job terminated upon reaching its time limit.
The options --starttime and --endtime define the time window between which sacct is going to search. For historical and practical reasons their default values (i.e. the default time window) depends on other options: --jobs and --state.
Depending on if --jobs and/or --state are specified, the default values of --starttime  and --endtime options are:
WITHOUT EITHER --jobs NOR --state specified:
---starttime Defaults to Midnight.
---endtime Defaults to Now.
WITH --jobs AND WITHOUT --state specified:
---starttime Defaults to Epoch 0.
WITHOUT --jobs AND WITH --state specified:
---starttime Defaults to Now.
---endtime Defaults to --starttime and to Now if --starttime is not specified.
WITH BOTH --jobs AND --state specified:
---endtime Defaults to --starttime or to Now if --starttime is not specified.
NOTE: With -v/--verbose a message about the actual time window in use is shown.
Executing sacct sends a remote procedure call to slurmdbd. If enough calls from sacct or other Slurm client commands that send remote procedure calls to the slurmdbd daemon come in at once, it can result in a degradation of performance of the slurmdbd daemon, possibly resulting in a denial of service.
Do not run sacct or other Slurm client commands that send remote procedure calls to slurmdbd from loops in shell scripts or other programs. Ensure that programs limit calls to sacct to the minimum necessary for the information you are trying to gather.
Some sacct options may be set via environment variables. These environment variables, along with their corresponding options, are listed below. (Note: Commandline options will always override these settings.)
SACCT_FEDERATION    Same as --federation
SACCT_LOCAL         Same as --local
SLURM_CONF          The location of the Slurm configuration file.
SLURM_TIME_FORMAT   Specify the format used to report time stamps. A value of standard, the default value, generates output in the form "year-month-dateThour:minute:second".  A value of relative returns only "hour:minute:second" if the current day.  For other dates in the current year it prints the "hour:minute" preceded by "Tomorr" (tomorrow), "Ystday" (yesterday), the name of the day for the coming week (e.g. "Mon", "Tue", etc.), otherwise the date (e.g. "25 Apr").  For other years it returns a date month and year without a time (e.g. "6 Jun 2012"). All of the time stamps use a 24 hour format.
A valid strftime() format can also be specified. For example, a value of "%a %T" will report the day of the week and a time stamp (e.g. "Mon 12:34:56").
This example illustrates the default invocation of the sacct command:
# sacct Jobid      Jobname    Partition    Account AllocCPUS State     ExitCode ---------- ---------- ---------- ---------- ---------- ---------- -------- 2          script01   srun       acct1               1 RUNNING           0 3          script02   srun       acct1               1 RUNNING           0 4          endscript  srun       acct1               1 RUNNING           0 4.0                   srun       acct1               1 COMPLETED         0
This example shows the same job accounting information with the brief option.
# sacct --brief Jobid     State  ExitCode ---------- ---------- -------- 2          RUNNING           0 3          RUNNING           0 4          RUNNING           0 4.0        COMPLETED         0
# sacct --allocations Jobid      Jobname    Partition Account    AllocCPUS  State     ExitCode ---------- ---------- ---------- ---------- ------- ---------- -------- 3          sja_init   andy       acct1            1 COMPLETED         0 4          sjaload    andy       acct1            2 COMPLETED         0 5          sja_scr1   andy       acct1            1 COMPLETED         0 6          sja_scr2   andy       acct1           18 COMPLETED         2 7          sja_scr3   andy       acct1           18 COMPLETED         0 8          sja_scr5   andy       acct1            2 COMPLETED         0 9          sja_scr7   andy       acct1           90 COMPLETED         1 10         endscript  andy       acct1          186 COMPLETED         0
This example demonstrates the ability to customize the output of the sacct command.  The fields are displayed in the order designated on the command line.
# sacct --format=jobid,elapsed,ncpus,ntasks,state Jobid    Elapsed      Ncpus   Ntasks     State ---------- ---------- ---------- -------- ---------- 3            00:01:30          2        1 COMPLETED 3.0          00:01:30          2        1 COMPLETED 4            00:00:00          2        2 COMPLETED 4.0          00:00:01          2        2 COMPLETED 5            00:01:23          2        1 COMPLETED 5.0          00:01:31          2        1 COMPLETED
This example demonstrates the use of the -T (--truncate) option when used with -S (--starttime) and -E (--endtime). When the -T option is used, the start time of the job will be the specified -S value if the job was started before the specified time, otherwise the time will be the job's start time. The end time will be the specified -E option if the job ends after the specified time, otherwise it will be the jobs end time.
Without -T (normal operation) sacct output would be like this.
# sacct -S2014-07-03-11:40 -E2014-07-03-12:00 -X -ojobid,start,end,state JobID                 Start                  End        State --------- --------------------- -------------------- ------------ 2         2014-07-03T11:33:16   2014-07-03T11:59:01   COMPLETED 3         2014-07-03T11:35:21   Unknown               RUNNING 4         2014-07-03T11:35:21   2014-07-03T11:45:21   COMPLETED 5         2014-07-03T11:41:01   Unknown               RUNNING
By adding the -T option the job's start and end times are truncated to reflect only the time requested.  If a job started after the start time requested or finished before the end time requested those times are not altered.  The -T option is useful when determining exact run times during any given period.
# sacct -T -S2014-07-03-11:40 -E2014-07-03-12:00 -X -ojobid,jobname,user,start,end,state JobID                 Start                  End        State --------- --------------------- -------------------- ------------ 2         2014-07-03T11:40:00   2014-07-03T11:59:01   COMPLETED 3         2014-07-03T11:40:00   2014-07-03T12:00:00   RUNNING 4         2014-07-03T11:40:00   2014-07-03T11:45:21   COMPLETED 5         2014-07-03T11:41:01   2014-07-03T12:00:00   RUNNING
NOTE: If no -s (--state) option is given sacct will display eligible jobs during the specified period of time, otherwise it will return jobs that were in the state requested during that period of time.
This example demonstrates the differences running sacct with and without the --state flag for the same time period. Without the --state option, all eligible jobs in that time period are shown.
# sacct -S11:20:00 -E11:25:00 -X -ojobid,start,end,state JobID               Start                 End      State ------------ ------------------- ------------------- ---------- 2955                    11:15:12            11:20:12  COMPLETED 2956                    11:20:13            11:25:13  COMPLETED
With the --state=pending option, only job 2956 will be shown because it had a dependency on 2955 and was still PENDING from 11:20:00 until it started at 11:21:13. Note that even though we requested PENDING jobs, the State shows as COMPLETED because that is the current State of the job.
# sacct --state=pending -S11:20:00 -E11:25:00 -X -ojobid,start,end,state JobID               Start                 End      State ------------ ------------------- ------------------- ---------- 2956                    11:20:13            11:25:13  COMPLETED
Copyright (C) 2005-2007 Copyright Hewlett-Packard Development Company L.P. Copyright (C) 2008-2010 Lawrence Livermore National Security.  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). Copyright (C) 2010-2014 SchedMD LLC.
This file is part of Slurm, a resource management program.  For details, see <https://slurm.schedmd.com/>.
Slurm is free software; 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.
Slurm is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
/etc/slurm.conf Entries to this file enable job accounting and designate the job accounting log file that collects system job accounting.
/var/log/slurm_accounting.log The default job accounting log file.  By default, this file is set to read and write permission for root only.
sstat(1), ps (1), srun(1), squeue(1), getrusage (2), time (2)
ARP(8)                 Linux System Administrator's Manual                ARP(8)
arp - manipulate the system ARP cache
arp [-vn] [-H type] [-i if] [-ae] [hostname]
arp [-v] [-i if] -d hostname [pub]
arp [-v] [-H type] [-i if] -s hostname hw_addr [temp]
arp [-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub
arp [-v] [-H type] [-i if] -Ds hostname ifname [netmask nm] pub
arp [-vnD] [-H type] [-i if] -f [filename]
Arp manipulates or displays the kernel's IPv4 network neighbour cache. It can add entries to the table, delete one or display the current content.
ARP stands for Address Resolution Protocol, which is used to find the media access control address of a network neighbour for a given IPv4 Address.
arp with no mode specifier will print the current content of the table. It is possible to limit the number of entries printed, by specifying an hardware address type, interface name or host address.
arp -d address will delete a ARP table entry. Root or netadmin privilege is required to do this. The entry is found by IP address. If a hostname is given, it will be resolved before looking up the entry in the ARP table.
arp -s address hw_addr is used to set up a new table entry. The format of the hw_addr parameter is dependent on the hardware class, but for most classes one can assume that the usual presentation can be used.  For the Ethernet class, this is 6 bytes in hexadecimal, separated by colons. When adding proxy arp entries (that is those with the publish flag set) a netmask may be specified to proxy arp for entire subnets. This is not good practice, but is supported by older kernels because it can be useful. If the temp flag is not supplied entries will be permanent stored into the ARP cache. To simplify setting up entries for one of your own network interfaces, you can use the arp -Ds address ifname form. In that case the hardware address is taken from the interface with the specified name.
-v, --verbose Tell the user what is going on by being verbose.
-n, --numeric shows numerical addresses instead of trying to determine symbolic host, port or user names.
-H type, --hw-type type, -t type When setting or reading the ARP cache, this optional parameter tells arp which class of entries it should check for.  The default value of this parameter is ether (i.e. hardware code 0x01 for IEEE 802.3 10Mbps Ethernet).  Other values might include network technologies such as ARCnet (arcnet) , PROnet (pronet) , AX.25 (ax25) and NET/ROM (netrom).
-a     Use alternate BSD style output format (with no fixed columns).
-e     Use default Linux style output format (with fixed columns).
-D, --use-device Instead of a hw_addr, the given argument is the name of an interface.  arp will use the MAC address of that interface for the table entry. This is usually the best option to set up a proxy ARP entry to yourself.
-i If, --device If Select an interface. When dumping the ARP cache only entries matching the specified interface will be printed. When setting a permanent or temp ARP entry this interface will be associated with the entry; if this option is not used, the kernel will guess based on the routing table. For pub entries the specified interface is the interface on which ARP requests will be answered. NOTE: This has to be different from the interface to which the IP datagrams will be routed.  NOTE: As of kernel 2.2.0 it is no longer possible to set an ARP entry for an entire subnet. Linux instead does automagic proxy arp when a route exists and it is forwarding. See arp(7) for details. Also the dontpub option which is available for delete and set operations cannot be used with 2.4 and newer kernels.
-f filename, --file filename Similar to the -s option, only this time the address info is taken from file filename.  This can be used if ARP entries for a lot of hosts have to be set up.  The name of the data file is very often /etc/ethers, but this is not official. If no filename is specified /etc/ethers is used as default.
The format of the file is simple; it only contains ASCII text lines with a hostname, and a hardware address separated by whitespace. Additionally the pub, temp and netmask flags can be used.
In all places where a hostname is expected, one can also enter an IP address in dotted-decimal notation.
As a special case for compatibility the order of the hostname and the hardware address can be exchanged.
Each complete entry in the ARP cache will be marked with the C flag. Permanent entries are marked with M and published entries have the P flag.
/usr/sbin/arp -i eth0 -Ds 10.0.0.2 eth1 pub
This will answer ARP requests for 10.0.0.2 on eth0 with the MAC address for eth1.
/usr/sbin/arp -i eth1 -d 10.0.0.1
Delete the ARP table entry for 10.0.0.1 on interface eth1. This will match published proxy ARP entries and permanent entries.
/proc/net/arp /etc/networks /etc/hosts /etc/ethers
ethers(5), rarp(8), route(8), ifconfig(8), netstat(8)
Fred N. van Kempen <waltje@uwalt.nl.mugnet.org>, Bernd Eckenfels <net-tools@lina.inka.de>.
LEAVE(1)                   BSD General Commands Manual                  LEAVE(1)
leave — remind you when you have to leave
leave [[+]hhmm]
leave waits until the specified time (within the next 12 hours), then reminds you that you have to leave by writing to the TTY that you executed leave on.
You are reminded 5 minutes and 1 minute before the actual time, at the time, and every minute thereafter.  When you log off, leave exits just before it would have printed the next message.
hhmm  The time of day is in the form hhmm where hh is a time in hours (on a 12 or 24 hour clock), and mm are minutes.
However, all times are converted to a 12 hour clock, and assumed to be in the next 12 hours.  An attempt to set an alarm for farther into the future will be truncated to within the next 12 hours.
+     If the time is preceded by ‘+’, the alarm will go off in hours and minutes from the current time.
If no argument is given, leave prompts with "When do you have to leave?"  A reply of newline causes leave to exit, otherwise the reply is assumed to be a time.  This form is suitable for inclusion in a ~/.login or ~/.profile.
calendar(1), csh(1), sh(1)
The leave command appeared in 3.0BSD.
In the modern age with X(1) and window multiplexing programs like window(1) and screen(1), the leave command's reminders and admonitions might not be seen if the user has the window where leave was started minimized or obscured.
This all begs for a more general user notifications system to be implemented.
TAR(1)                           GNU TAR Manual                           TAR(1)
tar - an archiving utility
Traditional usage tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ARG...]
UNIX-style usage tar -A [OPTIONS] ARCHIVE ARCHIVE
tar -c [-f ARCHIVE] [OPTIONS] [FILE...]
tar -d [-f ARCHIVE] [OPTIONS] [FILE...]
tar -t [-f ARCHIVE] [OPTIONS] [MEMBER...]
tar -r [-f ARCHIVE] [OPTIONS] [FILE...]
tar -u [-f ARCHIVE] [OPTIONS] [FILE...]
tar -x [-f ARCHIVE] [OPTIONS] [MEMBER...]
GNU-style usage tar {--catenate|--concatenate} [OPTIONS] ARCHIVE ARCHIVE
tar --create [--file ARCHIVE] [OPTIONS] [FILE...]
tar {--diff|--compare} [--file ARCHIVE] [OPTIONS] [FILE...]
tar --delete [--file ARCHIVE] [OPTIONS] [MEMBER...]
tar --append [-f ARCHIVE] [OPTIONS] [FILE...]
tar --list [-f ARCHIVE] [OPTIONS] [MEMBER...]
tar --test-label [--file ARCHIVE] [OPTIONS] [LABEL...]
tar --update [--file ARCHIVE] [OPTIONS] [FILE...]
tar --update [-f ARCHIVE] [OPTIONS] [FILE...]
tar {--extract|--get} [-f ARCHIVE] [OPTIONS] [MEMBER...]
This manpage is a short description of GNU tar.  For a detailed discussion, including examples and usage recommendations, refer to the GNU Tar Manual available in texinfo format.  If the info reader and the tar documentation are properly installed on your system, the command
info tar
You can also view the manual using the info mode in emacs(1), or find it in various formats online at
http://www.gnu.org/software/tar/manual
If any discrepancies occur between this manpage and the GNU Tar Manual, the later shall be considered the authoritative source.
GNU tar is an archiving program designed to store multiple files in a single file (an archive), and to manipulate such archives.  The archive can be either a regular file or a device (e.g. a tape drive, hence the name of the program, which stands for tape archiver), which can be located either on the local or on a remote machine.
Option styles Options to GNU tar can be given in three different styles.  In traditional style, the first argument is a cluster of option letters and all subsequent arguments supply arguments to those options that require them.  The arguments are read in the same order as the option letters. Any command line words that remain after all options has been processed are treated as non-optional arguments: file or archive member names.
For example, the c option requires creating the archive, the v option requests the verbose operation, and the f option takes an argument that sets the name of the archive to operate upon.  The following command, written in the traditional style, instructs tar to store all files from the directory /etc into the archive file etc.tar verbosely listing the files being archived:
tar cfv etc.tar /etc
In UNIX or short-option style, each option letter is prefixed with a single dash, as in other command line utilities.  If an option takes argument, the argument follows it, either as a separate command line word, or immediately following the option.  However, if the option takes an optional argument, the argument must follow the option letter without any intervening whitespace, as in -g/tmp/snar.db.
Any number of options not taking arguments can be clustered together after a single dash, e.g. -vkp.  Options that take arguments (whether mandatory or optional), can appear at the end of such a cluster, e.g. -vkpf a.tar.
The example command above written in the short-option style could look like:
tar -cvf etc.tar /etc or tar -c -v -f etc.tar /etc
In GNU or long-option style, each option begins with two dashes and has a meaningful name, consisting of lower-case letters and dashes.  When used, the long option can be abbreviated to its initial letters, provided that this does not create ambiguity.  Arguments to long options are supplied either as a separate command line word, immediately following the option, or separated from the option by an equals sign with no intervening whitespace.  Optional arguments must always use the latter method.
Here are several ways of writing the example command in this style:
tar --create --file etc.tar --verbose /etc or (abbreviating some options): tar --cre --file=etc.tar --verb /etc
The options in all three styles can be intermixed, although doing so with old options is not encouraged.
Operation mode The options listed in the table below tell GNU tar what operation it is to perform.  Exactly one of them must be given.  Meaning of non-optional arguments depends on the operation mode requested.
-A, --catenate, --concatenate Append archive to the end of another archive.  The arguments are treated as the names of archives to append.  All archives must be of the same format as the archive they are appended to, otherwise the resulting archive might be unusable with non-GNU implementations of tar.  Notice also that when more than one archive is given, the members from archives other than the first one will be accessible in the resulting archive only if using the -i (--ignore-zeros) option.
Compressed archives cannot be concatenated.
-c, --create Create a new archive.  Arguments supply the names of the files to be archived.  Directories are archived recursively, unless the --no-recursion option is given.
-d, --diff, --compare Find differences between archive and file system.  The arguments are optional and specify archive members to compare.  If not given, the current working directory is assumed.
--delete Delete from the archive.  The arguments supply names of the archive members to be removed.  At least one argument must be given.
This option does not operate on compressed archives.  There is no short option equivalent.
-r, --append Append files to the end of an archive.  Arguments have the same meaning as for -c (--create).
-t, --list List the contents of an archive.  Arguments are optional.  When given, they specify the names of the members to list.
--test-label Test the archive volume label and exit.  When used without arguments, it prints the volume label (if any) and exits with status 0.  When one or more command line arguments are given.  tar compares the volume label with each argument.  It exits with code 0 if a match is found, and with code 1 otherwise.  No output is displayed, unless used together with the -v (--verbose) option.
There is no short option equivalent for this option.
-u, --update Append files which are newer than the corresponding copy in the archive.  Arguments have the same meaning as with -c and -r options.  Notice, that newer files don't replace their old archive copies, but instead are appended to the end of archive.  The resulting archive can thus contain several members of the same name, corresponding to various versions of the same file.
-x, --extract, --get Extract files from an archive.  Arguments are optional.  When given, they specify names of the archive members to be extracted.
--show-defaults Show built-in defaults for various tar options and exit.  No arguments are allowed.
-?, --help Display a short option summary and exit.  No arguments allowed.
--usage Display a list of available options and exit.  No arguments allowed.
--version Print program version and copyright information and exit.
Operation modifiers --check-device Check device numbers when creating incremental archives (default).
-g, --listed-incremental=FILE Handle new GNU-format incremental backups.  FILE is the name of a snapshot file, where tar stores additional information which is used to decide which files changed since the previous incremental dump and, consequently, must be dumped again.  If FILE does not exist when creating an archive, it will be created and all files will be added to the resulting archive (the level 0 dump).  To create incremental archives of non-zero level N, create a copy of the snapshot file created during the level N-1, and use it as FILE.
When listing or extracting, the actual contents of FILE is not inspected, it is needed only due to syntactical requirements.  It is therefore common practice to use /dev/null in its place.
--hole-detection=METHOD Use METHOD to detect holes in sparse files.  This option implies --sparse.  Valid values for METHOD are seek and raw.  Default is seek with fallback to raw when not applicable.
-G, --incremental Handle old GNU-format incremental backups.
--ignore-failed-read Do not exit with nonzero on unreadable files.
--level=NUMBER Set dump level for created listed-incremental archive.  Currently only --level=0 is meaningful: it instructs tar to truncate the snapshot file before dumping, thereby forcing a level 0 dump.
-n, --seek Assume the archive is seekable.  Normally tar determines automatically whether the archive can be seeked or not.  This option is intended for use in cases when such recognition fails. It takes effect only if the archive is open for reading (e.g. with --list or --extract options).
--no-check-device Do not check device numbers when creating incremental archives.
--no-seek Assume the archive is not seekable.
--occurrence[=N] Process only the Nth occurrence of each file in the archive.  This option is valid only when used with one of the following subcommands: --delete, --diff, --extract or --list and when a list of files is given either on the command line or via the -T option. The default N is 1.
--restrict Disable the use of some potentially harmful options.
--sparse-version=MAJOR[.MINOR] Set version of the sparse format to use (implies --sparse).  This option implies --sparse.  Valid argument values are 0.0, 0.1, and 1.0.  For a detailed discussion of sparse formats, refer to the GNU Tar Manual, appendix D, "Sparse Formats".  Using info reader, it can be accessed running the following command: info tar 'Sparse Formats'.
-S, --sparse Handle sparse files efficiently.  Some files in the file system may have segments which were actually never written (quite often these are database files created by such systems as DBM).  When given this option, tar attempts to determine if the file is sparse prior to archiving it, and if so, to reduce the resulting archive size by not dumping empty parts of the file.
Overwrite control These options control tar actions when extracting a file over an existing copy on disk.
-k, --keep-old-files Don't replace existing files when extracting.
--keep-newer-files Don't replace existing files that are newer than their archive copies.
--keep-directory-symlink Don't replace existing symlinks to directories when extracting.
--no-overwrite-dir Preserve metadata of existing directories.
--one-top-level[=DIR] Extract all files into DIR, or, if used without argument, into a subdirectory named by the base name of the archive (minus standard compression suffixes recognizable by --auto-compress).
--overwrite Overwrite existing files when extracting.
--overwrite-dir Overwrite metadata of existing directories when extracting (default).
--recursive-unlink Recursively remove all files in the directory prior to extracting it.
--remove-files Remove files from disk after adding them to the archive.
--skip-old-files Don't replace existing files when extracting, silently skip over them.
-U, --unlink-first Remove each file prior to extracting over it.
-W, --verify Verify the archive after writing it.
Output stream selection --ignore-command-error
Ignore subprocess exit codes.
--no-ignore-command-error Treat non-zero exit codes of children as error (default).
-O, --to-stdout Extract files to standard output.
--to-command=COMMAND Pipe extracted files to COMMAND.  The argument is the pathname of an external program, optionally with command line arguments.  The program will be invoked and the contents of the file being extracted supplied to it on its standard input.  Additional data will be supplied via the following environment variables:
TAR_FILETYPE Type of the file. It is a single letter with the following meaning:
f           Regular file d           Directory l           Symbolic link h           Hard link b           Block device c           Character device
Currently only regular files are supported.
TAR_MODE File mode, an octal number.
TAR_FILENAME The name of the file.
TAR_REALNAME Name of the file as stored in the archive.
TAR_UNAME Name of the file owner.
TAR_GNAME Name of the file owner group.
TAR_ATIME Time of last access. It is a decimal number, representing seconds since the Epoch.  If the archive provides times with nanosecond precision, the nanoseconds are appended to the timestamp after a decimal point.
TAR_MTIME Time of last modification.
TAR_CTIME Time of last status change.
TAR_SIZE Size of the file.
TAR_UID UID of the file owner.
TAR_GID GID of the file owner.
Additionally, the following variables contain information about tar operation mode and the archive being processed:
TAR_VERSION GNU tar version number.
TAR_ARCHIVE The name of the archive tar is processing.
TAR_BLOCKING_FACTOR Current blocking factor, i.e. number of 512-byte blocks in a record.
TAR_VOLUME Ordinal number of the volume tar is processing (set if reading a multi-volume archive).
TAR_FORMAT Format of the archive being processed.  One of: gnu, oldgnu, posix, ustar, v7.
TAR_SUBCOMMAND A short option (with a leading dash) describing the operation tar is executing.
Handling of file attributes --atime-preserve[=METHOD] Preserve access times on dumped files, either by restoring the times after reading (METHOD=replace, this is the default) or by not setting the times in the first place (METHOD=system)
--delay-directory-restore Delay setting modification times and permissions of extracted directories until the end of extraction.  Use this option when extracting from an archive which has unusual member ordering.
--group=NAME[:GID] Force NAME as group for added files.  If GID is not supplied, NAME can be either a user name or numeric GID.  In this case the missing part (GID or name) will be inferred from the current host's group database.
When used with --group-map=FILE, affects only those files whose owner group is not listed in FILE.
--group-map=FILE Read group translation map from FILE.  Empty lines are ignored. Comments are introduced with # sign and extend to the end of line. Each non-empty line in FILE defines translation for a single group.  It must consist of two fields, delimited by any amount of whitespace:
OLDGRP NEWGRP[:NEWGID]
OLDGRP is either a valid group name or a GID prefixed with +. Unless NEWGID is supplied, NEWGRP must also be either a valid group name or a +GID.  Otherwise, both NEWGRP and NEWGID need not be listed in the system group database.
As a result, each input file with owner group OLDGRP will be stored in archive with owner group NEWGRP and GID NEWGID.
--mode=CHANGES Force symbolic mode CHANGES for added files.
--mtime=DATE-OR-FILE Set mtime for added files.  DATE-OR-FILE is either a date/time in almost arbitrary format, or the name of an existing file.  In the latter case the mtime of that file will be used.
-m, --touch Don't extract file modified time.
--no-delay-directory-restore Cancel the effect of the prior --delay-directory-restore option.
--no-same-owner Extract files as yourself (default for ordinary users).
--no-same-permissions Apply the user's umask when extracting permissions from the archive (default for ordinary users).
--numeric-owner Always use numbers for user/group names.
--owner=NAME[:UID] Force NAME as owner for added files.  If UID is not supplied, NAME can be either a user name or numeric UID.  In this case the missing part (UID or name) will be inferred from the current host's user database.
When used with --owner-map=FILE, affects only those files whose owner is not listed in FILE.
--owner-map=FILE Read owner translation map from FILE.  Empty lines are ignored. Comments are introduced with # sign and extend to the end of line. Each non-empty line in FILE defines translation for a single UID. It must consist of two fields, delimited by any amount of whitespace:
OLDUSR NEWUSR[:NEWUID]
OLDUSR is either a valid user name or a UID prefixed with +. Unless NEWUID is supplied, NEWUSR must also be either a valid user name or a +UID.  Otherwise, both NEWUSR and NEWUID need not be listed in the system user database.
As a result, each input file owned by OLDUSR will be stored in archive with owner name NEWUSR and UID NEWUID.
-p, --preserve-permissions, --same-permissions extract information about file permissions (default for superuser)
--same-owner Try extracting files with the same ownership as exists in the archive (default for superuser).
-s, --preserve-order, --same-order Sort names to extract to match archive
--sort=ORDER When creating an archive, sort directory entries according to ORDER, which is one of none, name, or inode.
The default is --sort=none, which stores archive members in the same order as returned by the operating system.
Using --sort=name ensures the member ordering in the created archive is uniform and reproducible.
Using --sort=inode reduces the number of disk seeks made when creating the archive and thus can considerably speed up archivation.  This sorting order is supported only if the underlying system provides the necessary information.
Extended file attributes --acls Enable POSIX ACLs support.
--no-acls Disable POSIX ACLs support.
--selinux Enable SELinux context support.
--no-selinux Disable SELinux context support.
--xattrs Enable extended attributes support.
--no-xattrs Disable extended attributes support.
--xattrs-exclude=PATTERN Specify the exclude pattern for xattr keys.  PATTERN is a POSIX regular expression, e.g. --xattrs-exclude='^user.', to exclude attributes from the user namespace.
--xattrs-include=PATTERN Specify the include pattern for xattr keys.  PATTERN is a POSIX regular expression.
Device selection and switching -f, --file=ARCHIVE Use archive file or device ARCHIVE.  If this option is not given, tar will first examine the environment variable `TAPE'.  If it is set, its value will be used as the archive name.  Otherwise, tar will assume the compiled-in default.  The default value can be inspected either using the --show-defaults option, or at the end of the tar --help output.
An archive name that has a colon in it specifies a file or device on a remote machine.  The part before the colon is taken as the machine name or IP address, and the part after it as the file or device pathname, e.g.:
--file=remotehost:/dev/sr0
An optional username can be prefixed to the hostname, placing a @ sign between them.
By default, the remote host is accessed via the rsh(1) command. Nowadays it is common to use ssh(1) instead.  You can do so by giving the following command line option:
--rsh-command=/usr/bin/ssh
The remote machine should have the rmt(8) command installed.  If its pathname does not match tar's default, you can inform tar about the correct pathname using the --rmt-command option.
--force-local Archive file is local even if it has a colon.
-F, --info-script=COMMAND, --new-volume-script=COMMAND Run COMMAND at the end of each tape (implies -M).  The command can include arguments.  When started, it will inherit tar's environment plus the following variables:
TAR_FD File descriptor which can be used to communicate the new volume name to tar.
If the info script fails, tar exits; otherwise, it begins writing the next volume.
-L, --tape-length=N Change tape after writing Nx1024 bytes.  If N is followed by a size suffix (see the subsection Size suffixes below), the suffix specifies the multiplicative factor to be used instead of 1024.
This option implies -M.
-M, --multi-volume Create/list/extract multi-volume archive.
--rmt-command=COMMAND Use COMMAND instead of rmt when accessing remote archives.  See the description of the -f option, above.
--rsh-command=COMMAND Use COMMAND instead of rsh when accessing remote archives.  See the description of the -f option, above.
--volno-file=FILE When this option is used in conjunction with --multi-volume, tar will keep track of which volume of a multi-volume archive it is working in FILE.
Device blocking -b, --blocking-factor=BLOCKS Set record size to BLOCKSx512 bytes.
-B, --read-full-records When listing or extracting, accept incomplete input records after end-of-file marker.
-i, --ignore-zeros Ignore zeroed blocks in archive.  Normally two consecutive 512-blocks filled with zeroes mean EOF and tar stops reading after encountering them.  This option instructs it to read further and is useful when reading archives created with the -A option.
--record-size=NUMBER Set record size.  NUMBER is the number of bytes per record.  It must be multiple of 512.  It can can be suffixed with a size suffix, e.g. --record-size=10K, for 10 Kilobytes.  See the subsection Size suffixes, for a list of valid suffixes.
Archive format selection -H, --format=FORMAT Create archive of the given format.  Valid formats are:
gnu    GNU tar 1.13.x format
oldgnu GNU format as per tar <= 1.12.
pax, posix POSIX 1003.1-2001 (pax) format.
ustar  POSIX 1003.1-1988 (ustar) format.
v7     Old V7 tar format.
--old-archive, --portability Same as --format=v7.
--pax-option=keyword[[:]=value][,keyword[[:]=value]]... Control pax keywords when creating PAX archives (-H pax).  This option is equivalent to the -o option of the pax(1) utility.
--posix Same as --format=posix.
-V, --label=TEXT Create archive with volume name TEXT.  If listing or extracting, use TEXT as a globbing pattern for volume name.
Compression options -a, --auto-compress Use archive suffix to determine the compression program.
-I, --use-compress-program=COMMAND Filter data through COMMAND.  It must accept the -d option, for decompression.  The argument can contain command line options.
-j, --bzip2 Filter the archive through bzip2(1).
-J, --xz Filter the archive through xz(1).
--lzip Filter the archive through lzip(1).
--lzma Filter the archive through lzma(1).
--lzop Filter the archive through lzop(1).
--no-auto-compress Do not use archive suffix to determine the compression program.
-z, --gzip, --gunzip, --ungzip Filter the archive through gzip(1).
-Z, --compress, --uncompress Filter the archive through compress(1).
--zstd Filter the archive through zstd(1).
Local file selection --add-file=FILE Add FILE to the archive (useful if its name starts with a dash).
--backup[=CONTROL] Backup before removal.  The CONTROL argument, if supplied, controls the backup policy.  Its valid values are:
none, off Never make backups.
t, numbered Make numbered backups.
nil, existing Make numbered backups if numbered backups exist, simple backups otherwise.
never, simple Always make simple backups
If CONTROL is not given, the value is taken from the VERSION_CONTROL environment variable.  If it is not set, existing is assumed.
-C, --directory=DIR Change to DIR before performing any operations.  This option is order-sensitive, i.e. it affects all options that follow.
--exclude=PATTERN Exclude files matching PATTERN, a glob(3)-style wildcard pattern.
--exclude-backups Exclude backup and lock files.
--exclude-caches Exclude contents of directories containing file CACHEDIR.TAG, except for the tag file itself.
--exclude-caches-all Exclude directories containing file CACHEDIR.TAG and the file itself.
--exclude-caches-under Exclude everything under directories containing CACHEDIR.TAG
--exclude-ignore=FILE Before dumping a directory, see if it contains FILE.  If so, read exclusion patterns from this file.  The patterns affect only the directory itself.
--exclude-ignore-recursive=FILE Same as --exclude-ignore, except that patterns from FILE affect both the directory and all its subdirectories.
--exclude-tag=FILE Exclude contents of directories containing FILE, except for FILE itself.
--exclude-tag-all=FILE Exclude directories containing FILE.
--exclude-tag-under=FILE Exclude everything under directories containing FILE.
--exclude-vcs Exclude version control system directories.
--exclude-vcs-ignores Exclude files that match patterns read from VCS-specific ignore files.  Supported files are: .cvsignore, .gitignore, .bzrignore, and .hgignore.
-h, --dereference Follow symlinks; archive and dump the files they point to.
--hard-dereference Follow hard links; archive and dump the files they refer to.
-K, --starting-file=MEMBER Begin at the given member in the archive.
--newer-mtime=DATE Work on files whose data changed after the DATE.  If DATE starts with / or . it is taken to be a file name; the mtime of that file is used as the date.
--no-null Disable the effect of the previous --null option.
--no-recursion Avoid descending automatically in directories.
--no-unquote Do not unquote input file or member names.
--no-verbatim-files-from Treat each line read from a file list as if it were supplied in the command line.  I.e., leading and trailing whitespace is removed and, if the resulting string begins with a dash, it is treated as tar command line option.
This is the default behavior.  The --no-verbatim-files-from option is provided as a way to restore it after --verbatim-files-from option.
This option is positional: it affects all --files-from options that occur after it in, until --verbatim-files-from option or end of line, whichever occurs first.
It is implied by the --no-null option.
--null Instruct subsequent -T options to read null-terminated names verbatim (disables special handling of names that start with a dash).
See also --verbatim-files-from.
-N, --newer=DATE, --after-date=DATE Only store files newer than DATE.  If DATE starts with / or . it is taken to be a file name; the mtime of that file is used as the date.
--one-file-system Stay in local file system when creating archive.
-P, --absolute-names Don't strip leading slashes from file names when creating archives.
--recursion Recurse into directories (default).
--suffix=STRING Backup before removal, override usual suffix.  Default suffix is ~, unless overridden by environment variable SIMPLE_BACKUP_SUFFIX.
-T, --files-from=FILE Get names to extract or create from FILE.