mirror of
https://github.com/zplug/zplug
synced 2025-04-06 07:39:12 +02:00
119 lines
2.5 KiB
Groff
119 lines
2.5 KiB
Groff
'\" t
|
|
.\" Title: zplug-use
|
|
.\" 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\-USE" "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-use \- Specify the pattern of the files to source or add to `$PATH`
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fIzplug\fR \fI"username/reponame"\fR, \fIuse:plugin\fR
|
|
.fi
|
|
.sp
|
|
.nf
|
|
The word \'package\' refers to the string in the format: "username/reponame"\&.
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
By using use tag, you can choose files that you want to load\&. Specify the pattern of the files to source (for plugin) or the relative path from the package root of the file to add to $PATH (for command) / Useful, for example, with from:gh\-r you can specify use:"*darwin*{amd,386}*" and so on\&. If you want to use extended glob, see later section for setting the zstyle\&.
|
|
.sp
|
|
.it 1 an-trap
|
|
.nr an-no-space-flag 1
|
|
.nr an-break-flag 1
|
|
.br
|
|
.B Table\ \&1.\ \&zplug use tag
|
|
.TS
|
|
allbox tab(:);
|
|
ltB ltB.
|
|
T{
|
|
Possive Values
|
|
T}:T{
|
|
Default value
|
|
T}
|
|
.T&
|
|
lt lt.
|
|
T{
|
|
.sp
|
|
(file patterns)
|
|
T}:T{
|
|
.sp
|
|
*\&.zsh
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
.sp
|
|
Besides, by using zstyle command, you can change default value:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ zstyle ":zplug:tag" use "*\&.sh"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
Case of :
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ zplug "b4b4r07/enhancd" \e
|
|
as:plugin, \e
|
|
use:"*\&.sh"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
Case of GitHub Release:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
$ zplug "peco/peco" \e
|
|
as:command, \e
|
|
from:gh\-r, \e
|
|
use:"*darwin*"
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBzplug(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
|