git-secret/man/man1/git-secret-add.1

40 lines
1.3 KiB
Groff
Raw Normal View History

2016-02-23 21:48:25 +00:00
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
2018-04-14 00:34:54 +00:00
.TH "GIT\-SECRET\-ADD" "1" "April 2018" "sobolevn" "git-secret"
2016-02-23 21:48:25 +00:00
.
.SH "NAME"
\fBgit\-secret\-add\fR \- starts to track added files\.
.
.SH "SYNOPSIS"
.
.nf
git secret add [\-i] <pathspec>\.\.\.
2016-02-23 21:48:25 +00:00
.
.fi
.
.SH "DESCRIPTION"
2018-04-16 20:07:56 +00:00
\fBgit\-secret\-add\fR adds a filepath(es) into the \fB\.gitsecret/paths/mapping\.cfg\fR\. When adding files to encrypt, ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\.
2016-02-23 21:48:25 +00:00
.
.P
If there\'s no users in the \fBgit\-secret\fR\'s keyring, when adding a file, an exception will be raised\.
.
.P
It is not recommened to add filenames directly into the \fB\.gitsecret/paths/mapping\.cfg\fR, use the command\.
.
.SH "OPTIONS"
.
.nf
\-i \- auto adds given files to the `\.gitignore` if they are unignored at the moment\.
2016-02-23 21:48:25 +00:00
\-h \- shows this help\.
.
.fi
.
.SH "MANUAL"
Run \fBman git\-secret\-add\fR to see this note\.
.
2016-02-23 21:48:25 +00:00
.SH "SEE ALSO"
git\-secret\-init(1) \fIhttp://git\-secret\.io/git\-secret\-init\fR, git\-secret\-tell(1) \fIhttp://git\-secret\.io/git\-secret\-tell\fR, git\-secret\-hide(1) \fIhttp://git\-secret\.io/git\-secret\-hide\fR, git\-secret\-reveal(1) \fIhttp://git\-secret\.io/git\-secret\-reveal\fR