man1/git-hash-object.1

   1 '\" t
   2 .\"     Title: git-hash-object
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-07-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.41.0.337.g830b4a04c4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HASH\-OBJECT" "1" "2023\-07\-14" "Git 2\&.41\&.0\&.337\&.g830b4a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-hash-object \- Compute object ID and optionally create an object from a file
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit hash\-object\fR [\-t <type>] [\-w] [\-\-path=<file> | \-\-no\-filters]
  36                 [\-\-stdin [\-\-literally]] [\-\-] <file>\&...
  37 \fIgit hash\-object\fR [\-t <type>] [\-w] \-\-stdin\-paths [\-\-no\-filters]
  38 .fi
  39 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 Computes the object ID value for an object with specified type with the contents of the named file (which can be outside of the work tree), and optionally writes the resulting object into the object database\&. Reports its object ID to its standard output\&. When <type> is not specified, it defaults to "blob"\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-t <type>
  46 .RS 4
  47 Specify the type of object to be created (default: "blob")\&. Possible values are
  48 \fBcommit\fR,
  49 \fBtree\fR,
  50 \fBblob\fR, and
  51 \fBtag\fR\&.
  52 .RE
  53 .PP
  54 \-w
  55 .RS 4
  56 Actually write the object into the object database\&.
  57 .RE
  58 .PP
  59 \-\-stdin
  60 .RS 4
  61 Read the object from standard input instead of from a file\&.
  62 .RE
  63 .PP
  64 \-\-stdin\-paths
  65 .RS 4
  66 Read file names from the standard input, one per line, instead of from the command\-line\&.
  67 .RE
  68 .PP
  69 \-\-path
  70 .RS 4
  71 Hash object as it were located at the given path\&. The location of file does not directly influence on the hash value, but path is used to determine what Git filters should be applied to the object before it can be placed to the object database, and, as result of applying filters, the actual blob put into the object database may differ from the given file\&. This option is mainly useful for hashing temporary files located outside of the working directory or files read from stdin\&.
  72 .RE
  73 .PP
  74 \-\-no\-filters
  75 .RS 4
  76 Hash the contents as is, ignoring any input filter that would have been chosen by the attributes mechanism, including the end\-of\-line conversion\&. If the file is read from standard input then this is always implied, unless the
  77 \fB\-\-path\fR
  78 option is given\&.
  79 .RE
  80 .PP
  81 \-\-literally
  82 .RS 4
  83 Allow
  84 \fB\-\-stdin\fR
  85 to hash any garbage into a loose object which might not otherwise pass standard object parsing or git\-fsck checks\&. Useful for stress\-testing Git itself or reproducing characteristics of corrupt or bogus objects encountered in the wild\&.
  86 .RE
  87 .SH "GIT"
  88 .sp
  89 Part of the \fBgit\fR(1) suite