path: root/docs/muttdelay.1

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "MUTTDELAY 1"
.TH MUTTDELAY 1 "2014-07-04" "muttdelay 0.0.0" "User Commands"
.\" 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"
muttdelay \- A muttdelay project
.SH "WTF?"
.IX Header "WTF?"
You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy.
.PP
Feel free to modify any aspects. This project is just an empty example muttdelay.
.PP
Follow these steps:
.SS "Install required packages"
.IX Subsection "Install required packages"
Run the following:
.PP
.Vb 1
\&    sudo aptitude install lintian devscripts dpkg\-dev make perl
.Ve
.PP
Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
.SS "Compile the project"
.IX Subsection "Compile the project"
Go to the to level directory and run
.PP
.Vb 1
\&    make
.Ve
.PP
To test run
.PP
.Vb 1
\&    ./bin/muttdelay
.Ve
.PP
It should print out the version number of the project.
.SS "Create a Debian package"
.IX Subsection "Create a Debian package"
Go to the to level directory and run
.PP
.Vb 1
\&    make deb
.Ve
.PP
It will create the files like:
.PP
.Vb 4
\&    ../muttdelay_0.0.0.0_all.deb
\&    ../muttdelay_0.0.0.0.dsc
\&    ../muttdelay_0.0.0.0_amd64.changes
\&    ../muttdelay_0.0.0.0.tar.gz
.Ve
.PP
It should create a debian package in ../. Check and install it, e.g:
.PP
.Vb 2
\&    lintian \-\-pedantic ../muttdelay_0.0.0.0_all.deb 
\&    sudo dpkg \-i ../muttdelay_0.0.0.0_all.deb
.Ve
.PP
Run
.PP
.Vb 1
\&    dpkg \-L muttdelay
.Ve
.PP
to see whats in there. You can now run
.PP
.Vb 1
\&    /usr/bin/muttdelay
.Ve
.PP
or for example
.PP
.Vb 1
\&    man muttdelay
.Ve
.SS "Read the Makefile"
.IX Subsection "Read the Makefile"
Read the Makefile in order to understand what's going on.
.SH "Customize"
.IX Header "Customize"
Now, since you understood everything feel free to customize everything the way you want it. E.g.:
.PP
.Vb 1
\&    Don\*(Aqt use POD for documentation but LaTeX
\&
\&    Compile a C program
\&
\&    Include a ./lib dir, add it to the \*(Aqinstall\*(Aq Makefile rule
\&
\&    etc etc.
.Ve
.PP
You should also consider the following:
.SS "Manual page"
.IX Subsection "Manual page"
This muttdelay is using \s-1POD\s0 for creating manual pages. Edit ./docs/muttdelay.pod and run
.PP
.Vb 1
\&    make documentation
.Ve
.PP
in order to build ./docs/muttdelay.1. The page will be included in the resulting debian package automatically. You can review the page with
.PP
.Vb 1
\&    man ./docs/muttdelay.1
.Ve
.SS "Renaming muttdelay into your project name"
.IX Subsection "Renaming muttdelay into your project name"
Rename all files which have *muttdelay* included into your own new package name. You can do that with:
.PP
.Vb 3
\&    PROJECTNAME=yourproject
\&    find . \-name \e*muttdelay\e* | 
\&    while read muttdelay; do git mv $muttdelay ${muttdelay/muttdelay/$PROJECTNAME}; done
.Ve
.PP
Search all content and rename *muttdelay* into your own new package name. You can do that with:
.PP
.Vb 2
\&    grep \-R muttdelay . | grep \-v .git | 
\&    cut \-d: \-f1 | uniq | xargs sed \-i "s/muttdelay/$PROJECTNAME/g"
.Ve
.SS "Updating ./debian"
.IX Subsection "Updating ./debian"
Edit the following files accordingly to your new project (e.g. with vim):
.PP
.Vb 1
\&    vim ./debian/{control,copyright,README}
.Ve
.SS "Update changelog"
.IX Subsection "Update changelog"
Go to the to level directory and run
.PP
.Vb 1
\&    dch \-i
.Ve