.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CIL 1"
.TH CIL 1 "2018-09-09" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
cil \- the command\-line issue list
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    $ cil init
\&    $ cil summary
\&    $ cil list
\&    $ cil list \-\-status=New
\&    $ cil list \-\-label=Release\-v0.1
\&    $ cil list \-\-is\-open
\&
\&    $ cil add
\&    ... added issue \*(Aqcafebabe\*(Aq ...
\&    $ cil show cafebabe
\&    $ cil edit cafebabe
\&    $ cil status cafebabe InProgress
\&
\&    $ cil comment cafebabe
\&    ... added comment \*(Aqdeadbeef\*(Aq ...
\&
\&    $ cil attach cafebabe filename.txt
\&    ... added attachment \*(Aqdecaf7ea\*(Aq ...
\&
\&    $ cil extract decaf7ea
\&    $ cil extract decaf7ea \-\-filename=other_filename.txt
\&
\&    $ cil am email.txt
\&
\&    $ cil track
\&    $ cil fsck
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Cil is a small but useful command-line issue list. It saves issues, comments
and attachments as local files which you can check in to your repository.
.IP "init [\-\-path=PATH] [\-\-bare]" 4
.IX Item "init [--path=PATH] [--bare]"
Creates a local '.cil' file and an 'issues' directory. If \s-1PATH\s0 is specified,
the config file and directory will be created in the destination directory.
.Sp
Usually, cil will write a small \f(CW\*(C`.cil\*(C'\fR file such that you can use various
filter commands immediately and can also serve as an example config file. Using
\&\f(CW\*(C`\-\-bare\*(C'\fR just touches the \f(CW\*(C`.cil\*(C'\fR config file ready for your own manipulation.
.IP "summary [filters]" 4
.IX Item "summary [filters]"
Displays a one line summary for each issue. You may filter on both the Status
and Label fields.
.IP "list [filters]" 4
.IX Item "list [filters]"
Shows each issue with more information. You may filter on both the Status and
Label fields.
.IP "add [\-\-mine] [summary]" 4
.IX Item "add [--mine] [summary]"
Adds an issues after you have edited the input.  Text passed
after 'add' will be used as the bug summary line.
.Sp
If you use the \-\-mine flag, the AssignedTo field is automatically set to you
(saves having to copy and paste the CreatedBy field).
.IP "show \s-1ISSUE\s0" 4
.IX Item "show ISSUE"
Shows the issue name with more detail.
.IP "status \s-1ISSUE NEW_STATUS\s0" 4
.IX Item "status ISSUE NEW_STATUS"
Shortcut so that you can set a new status on an issue without having to edit
it.
.IP "depends-on \s-1ISSUE1 ISSUE2\s0" 4
.IX Item "depends-on ISSUE1 ISSUE2"
Shortcut so that cil will add a 'DependsOn' from issue 1 to issue
2. Conversley, issue 2 will also then contain a 'Precedes' pointer to issue 1.
.IP "precedes \s-1ISSUE1 ISSUE2\s0" 4
.IX Item "precedes ISSUE1 ISSUE2"
This is the exact opposite of \f(CW\*(C`depends\-on\*(C'\fR and is here for convenience and
completeness. ie. issue 1 has to be completed before issue 2.
.IP "status \s-1ISSUE NEW_STATUS\s0" 4
.IX Item "status ISSUE NEW_STATUS"
Shortcut so that you can set a new status on an issue without having to edit
it.
.IP "steal \s-1ISSUE\s0" 4
.IX Item "steal ISSUE"
Shortcut to assign this issue to yourself. It reads your \f(CW\*(C`~/.cilrc\*(C'\fR file for
your UserName and UserEmail and uses this to populate the \f(CW\*(C`AssignedTo\*(C'\fR field
in the issue.
.IP "edit \s-1ISSUE\s0" 4
.IX Item "edit ISSUE"
Edits the issue. If it changes, set the updates time to now.
.IP "comment \s-1ISSUE\s0" 4
.IX Item "comment ISSUE"
Adds a comment to an issues after you have edited the input.
.IP "attach \s-1ISSUE FILENAME\s0" 4
.IX Item "attach ISSUE FILENAME"
Adds that particular filename to an existing issue.
.IP "extract \s-1ATTACHMENT\s0 [\-\-filename=FILENAME]" 4
.IX Item "extract ATTACHMENT [--filename=FILENAME]"
Extracts the file from the attachment number. If filename if given uses that,
otherwise it will use the original one saved along with the attachment.
.IP "am" 4
.IX Item "am"
Applies an email message to the issue list. It tries to figure out the type of
email it is, whether it is a new issue or a comment on an already existing
issue. For example, if it can find valid issue names in the subject or body of
the message, it adds it as a comment to that issue. If it can't find any valid
issue names, it presumes it's a new issue and adds that.
.Sp
Note: this command will deal with Mailbox format files later on.
.IP "track \s-1ISSUE\s0" 4
.IX Item "track ISSUE"
This command outputs one or more command which you should run so that your \s-1VCS\s0
knows about your issue. It makes sure all the comments and attachments are done
too.
.IP "fsck" 4
.IX Item "fsck"
Tries to help you organise your issues if any aren't valid or have broken
relationships.
.SH "FILTERS"
.IX Header "FILTERS"
Filters can be used on both the \f(CW\*(C`summary\*(C'\fR and \f(CW\*(C`list\*(C'\fR commands. Most can be
combined. See each individual filter for details.
.IP "\-\-status=STATUS" 4
.IX Item "--status=STATUS"
You can choose any of the Statuses which might appear in your issues. This
status does not have to be defined in your \f(CW\*(C`.cil\*(C'\fR file, even if you have
\&\f(CW\*(C`StatusStrict\*(C'\fR turned on.
.IP "\-\-label=LABEL" 4
.IX Item "--label=LABEL"
You can choose any of the Labels which might appear in your issues. This
label does not have to be defined in your \f(CW\*(C`.cil\*(C'\fR file, even if you have
\&\f(CW\*(C`LabelStrict\*(C'\fR turned on.
.IP "\-\-is\-open, \-\-is\-closed" 4
.IX Item "--is-open, --is-closed"
These check both \f(CW\*(C`StatusOpenList\*(C'\fR and \f(CW\*(C`StatusClosedList\*(C'\fR from your \f(CW\*(C`.cil\*(C'\fR
file. If both are specified, you're likely to get no issues unless you
explicitly defined a status as being in both lists (for whatever reason you
have).
.IP "\-\-assigned\-to=EMAIL_ADDRESS, \-\-is\-mine" 4
.IX Item "--assigned-to=EMAIL_ADDRESS, --is-mine"
These items are mutually exclusive. The \f(CW\*(C`\-\-assigned\-to\*(C'\fR just checks the email
address in the AssignedTo field. It does not match anything else in that field,
including any preceding name or any angle brackets.
.Sp
The \f(CW\*(C`\-\-is\-mine\*(C'\fR filter is a shortcut to asking if AssignedTo is you. Cil knows
your email address if you define it in your user's \f(CW\*(C`~/.cilrc\*(C'\fR file as
\&\f(CW\*(C`UserEmail\*(C'\fR.
.SH ".cil"
.IX Header ".cil"
The \f(CW\*(C`.cil\*(C'\fR file is used to configure bits and pieces within cil for this
particular issue list. The following options are available and where stated,
may be declared multiple times:
.PP
The \f(CW\*(C`.cil\*(C'\fR file is fairly simple and an example can be seen here:
.PP
.Vb 11
\&    UseGit: 1
\&    StatusStrict: 1
\&    StatusOpenList: New
\&    StatusOpenList: InProgress
\&    StatusClosedList: Finished
\&    LabelStrict: 1
\&    LabelAllowedList: Type\-Enhancement
\&    LabelAllowedList: Type\-Defect
\&    LabelAllowedList: Priority\-High
\&    LabelAllowedList: Priority\-Medium
\&    LabelAllowedList: Priority\-Low
.Ve
.IP "UseGit" 4
.IX Item "UseGit"
Default: 0, Type: Boolean (0/1)
.Sp
Determines whether to use Git or not. Some features require Git though Cil is
perfectly usable without.
.IP "StatusStrict" 4
.IX Item "StatusStrict"
Default: 0, Type: Boolean (0/1)
.Sp
If this is set to a true value then cil checks that the status you enter into
an issue (after adding or editing) is also in the allowed list (see
StatusAllowedList).
.IP "StatusOpenList" 4
.IX Item "StatusOpenList"
Default: empty, Type: List
.Sp
This list is checked against when filtering with \-\-is\-open.
.IP "StatusClosedList" 4
.IX Item "StatusClosedList"
Default: empty, Type: List
.Sp
This list is checked against when filtering with \-\-is\-closed.
.IP "StatusAllowedList" 4
.IX Item "StatusAllowedList"
This list is automatically generated from the StatusOpenList and the
StatusClosedList. It does not have to appear in the config file.
.IP "LabelStrict" 4
.IX Item "LabelStrict"
Default: 0, Type: Boolean (0/1)
.Sp
This determines that labels you enter are checked against LabelAllowedList. Set
to 1 if you require this feature.
.IP "LabelAllowedList" 4
.IX Item "LabelAllowedList"
Default: empty, Type: List
.Sp
This determines which labels are allowed if you have turned on LabelStrict.
.SH "~/.cilrc"
.IX Header "~/.cilrc"
The \f(CW\*(C`~/.cilrc\*(C'\fR file is read to configure the user's preferences for all cil
lists they're using. It is of the same format as the \f(CW\*(C`.cil\*(C'\fR file and contains
the following options:
.PP
.Vb 2
\&    UserName: Andrew Chilton
\&    UserEmail: andychilton@gmail.com
.Ve
.IP "UserName" 4
.IX Item "UserName"
Default: 'Name', Type: String
.Sp
This is used as a default in the \f(CW\*(C`CreatedBy\*(C'\fR and \f(CW\*(C`AssignedTo\*(C'\fR fields in any
issues/comments/attachments you add.
.IP "UserEmail" 4
.IX Item "UserEmail"
Default: 'Email', Type: String
.Sp
This is used as a default in the \f(CW\*(C`CreatedBy\*(C'\fR and \f(CW\*(C`AssignedTo\*(C'\fR fields in any
issues/comments/attachments you add.
.SH "BUGS"
.IX Header "BUGS"
Probably. Let me know :\-)
.SH "TODO"
.IX Header "TODO"
To get a ToDo list for cil, clone the repo, find the issues/ dir and type:
.PP
.Vb 1
\&    $ cil \-\-is\-open
.Ve
.PP
This gives the current outstanding issues in cil.
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Chilton <andychilton@gmail.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2008 by Andrew Chilton
.PP
Cil is free software: you can redistribute it and/or modify it under the terms
of the \s-1GNU\s0 General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY
WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A
PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/> or write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, \s-1MA
02110\-1301, USA.\s0