1
0
mirror of https://github.com/zplug/zplug synced 2025-04-06 07:39:12 +02:00
zplug/doc/man/man5/zplug-frozen.5
b4b4r07 6ed0d984ab Fix typo
find . -type f -print0 | xargs -0 misspell -w
2016-12-22 20:07:00 +09:00

108 lines
2.3 KiB
Groff

'\" t
.\" Title: zplug-frozen
.\" Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 11/21/2016
.\" Manual: ZPLUG Manual
.\" Source: ZPLUG Manual
.\" Language: English
.\"
.TH "ZPLUG\-FROZEN" "5" "11/21/2016" "ZPLUG Manual" "ZPLUG Manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
zplug-frozen \- Do not update unless explicitly specified
.SH "SYNOPSIS"
.sp
.nf
\fIzplug\fR \fI"username/reponame"\fR, \fIfrozen:yes\fR
.fi
.sp
.nf
The word \'package\' refers to the string in the format: "username/reponame"\&.
.fi
.SH "DESCRIPTION"
.sp
By using frozen tag, you cant skip update of the repo when executing zplug command\&. In particular, this tag is particularly useful if you can describe the package with from:gh\-r tag since it\(cqs so heavy\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&zplug frozen tag
.TS
allbox tab(:);
ltB ltB.
T{
Possive Values
T}:T{
Default value
T}
.T&
lt lt.
T{
.sp
(truthy, falsy)
T}:T{
.sp
no
T}
.TE
.sp 1
.sp
Values \fItruthy\fR and \fIfalsy\fR mean any of "true, yes, on, 1" and "false, no, off, 0", respectively\&.
.sp
Besides, by using zstyle command, you can change default value:
.sp
.if n \{\
.RS 4
.\}
.nf
$ zstyle ":zplug:tag" frozen true
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.sp
Skip the update:
.sp
.if n \{\
.RS 4
.\}
.nf
$ zplug "stedolan/jq" \e
as:command, \e
from:gh\-r, \e
use:"*darwin*", \e
frozen:1, \e
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBzplug(1)\fR, \fBzplug\-update(1)\fR
.SH "FURTHER DOCUMENTATION"
.sp
See the references in official wiki page to get started using zplug\&. The wiki may perhaps be overwhelming for first\-time users\&.
.SH "AUTHORS"
.sp
zplug was originally written by Masaki Ishiyama (a\&.k\&.a @b4b4r07)\&. Many people have contributed to it\&.
.SH "COPYING"
.sp
Copyright (C) 2015\-2016 Masaki Ishiyama
.sp
MIT License
.SH "REPORTING BUGS"
.sp
Report bugs to the zplug issues