github.com/artpar/rclone@v1.67.3/docs/content/commands/rclone_checksum.md (about)

     1  ---
     2  title: "rclone checksum"
     3  description: "Checks the files in the destination against a SUM file."
     4  slug: rclone_checksum
     5  url: /commands/rclone_checksum/
     6  groups: Filter,Listing
     7  versionIntroduced: v1.56
     8  # autogenerated - DO NOT EDIT, instead edit the source code in cmd/checksum/ and as part of making a release run "make commanddocs"
     9  ---
    10  # rclone checksum
    11  
    12  Checks the files in the destination against a SUM file.
    13  
    14  ## Synopsis
    15  
    16  
    17  Checks that hashsums of destination files match the SUM file.
    18  It compares hashes (MD5, SHA1, etc) and logs a report of files which
    19  don't match.  It doesn't alter the file system.
    20  
    21  The sumfile is treated as the source and the dst:path is treated as
    22  the destination for the purposes of the output.
    23  
    24  If you supply the `--download` flag, it will download the data from the remote
    25  and calculate the content hash on the fly.  This can be useful for remotes
    26  that don't support hashes or if you really want to check all the data.
    27  
    28  Note that hash values in the SUM file are treated as case insensitive.
    29  
    30  If you supply the `--one-way` flag, it will only check that files in
    31  the source match the files in the destination, not the other way
    32  around. This means that extra files in the destination that are not in
    33  the source will not be detected.
    34  
    35  The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match`
    36  and `--error` flags write paths, one per line, to the file name (or
    37  stdout if it is `-`) supplied. What they write is described in the
    38  help below. For example `--differ` will write all paths which are
    39  present on both the source and destination but different.
    40  
    41  The `--combined` flag will write a file (or stdout) which contains all
    42  file paths with a symbol and then a space and then the path to tell
    43  you what happened to it. These are reminiscent of diff files.
    44  
    45  - `= path` means path was found in source and destination and was identical
    46  - `- path` means path was missing on the source, so only in the destination
    47  - `+ path` means path was missing on the destination, so only in the source
    48  - `* path` means path was present in source and destination but different.
    49  - `! path` means there was an error reading or hashing the source or dest.
    50  
    51  The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
    52  option for more information.
    53  
    54  
    55  ```
    56  rclone checksum <hash> sumfile dst:path [flags]
    57  ```
    58  
    59  ## Options
    60  
    61  ```
    62        --combined string         Make a combined report of changes to this file
    63        --differ string           Report all non-matching files to this file
    64        --download                Check by hashing the contents
    65        --error string            Report all files with errors (hashing or reading) to this file
    66    -h, --help                    help for checksum
    67        --match string            Report all matching files to this file
    68        --missing-on-dst string   Report all files missing from the destination to this file
    69        --missing-on-src string   Report all files missing from the source to this file
    70        --one-way                 Check one way only, source files must exist on remote
    71  ```
    72  
    73  
    74  ## Filter Options
    75  
    76  Flags for filtering directory listings.
    77  
    78  ```
    79        --delete-excluded                     Delete files on dest excluded from sync
    80        --exclude stringArray                 Exclude files matching pattern
    81        --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
    82        --exclude-if-present stringArray      Exclude directories if filename is present
    83        --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
    84        --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
    85    -f, --filter stringArray                  Add a file filtering rule
    86        --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
    87        --ignore-case                         Ignore case in filters (case insensitive)
    88        --include stringArray                 Include files matching pattern
    89        --include-from stringArray            Read file include patterns from file (use - to read from stdin)
    90        --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
    91        --max-depth int                       If set limits the recursion depth to this (default -1)
    92        --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
    93        --metadata-exclude stringArray        Exclude metadatas matching pattern
    94        --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
    95        --metadata-filter stringArray         Add a metadata filtering rule
    96        --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
    97        --metadata-include stringArray        Include metadatas matching pattern
    98        --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
    99        --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
   100        --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
   101  ```
   102  
   103  ## Listing Options
   104  
   105  Flags for listing directories.
   106  
   107  ```
   108        --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
   109        --fast-list           Use recursive list if available; uses more memory but fewer transactions
   110  ```
   111  
   112  See the [global flags page](/flags/) for global options not listed here.
   113  
   114  # SEE ALSO
   115  
   116  * [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
   117