Home Explore Blog CI



man-pages

69th chunk of `rsync.man`
0418a80521d4859ee96b234c901895a0ba1dc93997abff500000000100000ff7
 --list‐only
              This  option  will cause the source files to be listed instead of
              transferred.  This option is inferred if there is a single source
              arg and no destination specified, so its main uses are:

              1.     to turn a copy command that  includes  a  destination  arg
                     into a file‐listing command, or

              2.     to  be able to specify more than one source arg.  Note: be
                     sure to include the destination.

              CAUTION: keep in mind that a source arg with a wild‐card  is  ex‐
              panded  by  the  shell into multiple args, so it is never safe to
              try to specify a single wild‐card arg to try to  infer  this  op‐
              tion. A safe example is:

                  rsync ‐av ‐‐list‐only foo* dest/

              This  option  always  uses an output format that looks similar to
              this:

                  drwxrwxr‐x          4,096 2022/09/30 12:53:11 support
                  ‐rw‐rw‐r‐‐             80 2005/01/11 10:37:37 support/Makefile

              The only option that affects this output style is (as  of  3.1.0)
              the --human‐readable (-h) option.  The default is to output sizes
              as  byte  counts  with  digit separators (in a 14‐character‐width
              column).  Specifying at least one -h option makes the sizes  out‐
              put  with  unit  suffixes.  If you want old‐style bytecount sizes
              without digit separators (and an 11‐character‐width  column)  use
              --no‐h.

              Compatibility  note:  when  requesting  a remote listing of files
              from an rsync that is version 2.6.3 or older, you  may  encounter
              an error if you ask for a non‐recursive listing.  This is because
              a  file  listing  implies  the --dirs option w/o --recursive, and
              older rsyncs don’t have that option.  To avoid this problem,  ei‐
              ther  specify the --no‐dirs option (if you don’t need to expand a
              directory’s content), or turn on recursion and exclude  the  con‐
              tent of subdirectories: -r --exclude=’/*/*’.

       --bwlimit=RATE
              This  option  allows you to specify the maximum transfer rate for
              the data sent over the socket, specified  in  units  per  second.
              The  RATE  value can be suffixed with a string to indicate a size
              multiplier, and may be a fractional value (e.g.  --bwlimit=1.5m).
              If  no  suffix  is  specified, the value will be assumed to be in
              units of 1024 bytes (as if "K" or "KiB" had been appended).   See
              the --max‐size option for a description of all the available suf‐
              fixes.  A value of 0 specifies no limit.

              For  backward‐compatibility  reasons,  the  rate  limit  will  be
              rounded to the nearest KiB unit, so no  rate  smaller  than  1024
              bytes per second is possible.

              Rsync writes data over the socket in blocks, and this option both
              limits  the  size  of  the blocks that rsync writes, and tries to
              keep the average transfer rate  at  the  requested  limit.   Some
              burstiness may be seen where rsync writes out a block of data and
              then sleeps to bring the average rate into compliance.

              Due  to the internal buffering of data, the --progress option may
              not be an accurate reflection on how fast the data is being sent.
              This is because some files can show up as being rapidly sent when
              the data is quickly buffered, while other can  show  up  as  very
              slow  when the flushing of the output buffer occurs.  This may be
              fixed in a future version.

              See also the daemon version of the --bwlimit option.

       --stop‐after=MINS, (--time‐limit=MINS)

Title: Rsync: List-Only Output and Bandwidth Limiting
Summary
This section details the output format of the `--list-only` option, its interaction with `--human-readable`, and compatibility notes for older rsync versions. It then describes the `--bwlimit=RATE` option, which limits the transfer rate, explaining its units, rounding behavior, and potential impact on `--progress` output. Finally, it introduces the `--stop-after=MINS` option for limiting transfer duration.