summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-07-04 21:48:08 +0200
committerPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-07-04 21:48:08 +0200
commitb1696a55c38a1838ca25ebad58cd5b9ad48a9b75 (patch)
tree4c027e7413e50b4951aea9c8a980a40a9e6940d4 /docs
parent5361f26e75d3541968fb585a7e2d0af5283994e8 (diff)
rename
Diffstat (limited to 'docs')
-rw-r--r--docs/muttdelay.1 (renamed from docs/template.1)48
-rw-r--r--docs/muttdelay.pod (renamed from docs/template.pod)44
-rw-r--r--docs/muttdelay.txt (renamed from docs/template.txt)46
3 files changed, 69 insertions, 69 deletions
diff --git a/docs/template.1 b/docs/muttdelay.1
index a2947fa..769402e 100644
--- a/docs/template.1
+++ b/docs/muttdelay.1
@@ -124,18 +124,18 @@
.\" ========================================================================
.\"
.IX Title "TEMPLATE 1"
-.TH TEMPLATE 1 "2014-04-10" "template 0.0.0" "User Commands"
+.TH TEMPLATE 1 "2014-04-10" "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"
-template \- A template project
+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 template.
+Feel free to modify any aspects. This project is just an empty example muttdelay.
.PP
Follow these steps:
.SS "Install required packages"
@@ -158,7 +158,7 @@ Go to the to level directory and run
To test run
.PP
.Vb 1
-\& ./bin/template
+\& ./bin/muttdelay
.Ve
.PP
It should print out the version number of the project.
@@ -173,35 +173,35 @@ Go to the to level directory and run
It will create the files like:
.PP
.Vb 4
-\& ../template_0.0.0.0_all.deb
-\& ../template_0.0.0.0.dsc
-\& ../template_0.0.0.0_amd64.changes
-\& ../template_0.0.0.0.tar.gz
+\& ../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 ../template_0.0.0.0_all.deb
-\& sudo dpkg \-i ../template_0.0.0.0_all.deb
+\& 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 template
+\& dpkg \-L muttdelay
.Ve
.PP
to see whats in there. You can now run
.PP
.Vb 1
-\& /usr/bin/template
+\& /usr/bin/muttdelay
.Ve
.PP
or for example
.PP
.Vb 1
-\& man template
+\& man muttdelay
.Ve
.SS "Read the Makefile"
.IX Subsection "Read the Makefile"
@@ -223,32 +223,32 @@ Now, since you understood everything feel free to customize everything the way y
You should also consider the following:
.SS "Manual page"
.IX Subsection "Manual page"
-This template is using \s-1POD\s0 for creating manual pages. Edit ./docs/template.pod and run
+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/template.1. The page will be included in the resulting debian package automatically. You can review the page with
+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/template.1
+\& man ./docs/muttdelay.1
.Ve
-.SS "Renaming template into your project name"
-.IX Subsection "Renaming template into your project name"
-Rename all files which have *template* included into your own new package name. You can do that with:
+.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*template\e* |
-\& while read template; do git mv $template ${template/template/$PROJECTNAME}; done
+\& find . \-name \e*muttdelay\e* |
+\& while read muttdelay; do git mv $muttdelay ${muttdelay/muttdelay/$PROJECTNAME}; done
.Ve
.PP
-Search all content and rename *template* into your own new package name. You can do that with:
+Search all content and rename *muttdelay* into your own new package name. You can do that with:
.PP
.Vb 2
-\& grep \-R template . | grep \-v .git |
-\& cut \-d: \-f1 | uniq | xargs sed \-i "s/template/$PROJECTNAME/g"
+\& 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"
diff --git a/docs/template.pod b/docs/muttdelay.pod
index 76de14e..65625e3 100644
--- a/docs/template.pod
+++ b/docs/muttdelay.pod
@@ -1,12 +1,12 @@
=head1 NAME
-template - A template project
+muttdelay - A muttdelay project
=head1 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.
-Feel free to modify any aspects. This project is just an empty example template.
+Feel free to modify any aspects. This project is just an empty example muttdelay.
Follow these steps:
@@ -26,7 +26,7 @@ Go to the to level directory and run
To test run
- ./bin/template
+ ./bin/muttdelay
It should print out the version number of the project.
@@ -38,27 +38,27 @@ Go to the to level directory and run
It will create the files like:
- ../template_0.0.0.0_all.deb
- ../template_0.0.0.0.dsc
- ../template_0.0.0.0_amd64.changes
- ../template_0.0.0.0.tar.gz
+ ../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
It should create a debian package in ../. Check and install it, e.g:
- lintian --pedantic ../template_0.0.0.0_all.deb
- sudo dpkg -i ../template_0.0.0.0_all.deb
+ lintian --pedantic ../muttdelay_0.0.0.0_all.deb
+ sudo dpkg -i ../muttdelay_0.0.0.0_all.deb
Run
- dpkg -L template
+ dpkg -L muttdelay
to see whats in there. You can now run
- /usr/bin/template
+ /usr/bin/muttdelay
or for example
- man template
+ man muttdelay
=head2 Read the Makefile
@@ -80,26 +80,26 @@ You should also consider the following:
=head2 Manual page
-This template is using POD for creating manual pages. Edit ./docs/template.pod and run
+This muttdelay is using POD for creating manual pages. Edit ./docs/muttdelay.pod and run
make documentation
-in order to build ./docs/template.1. The page will be included in the resulting debian package automatically. You can review the page with
+in order to build ./docs/muttdelay.1. The page will be included in the resulting debian package automatically. You can review the page with
- man ./docs/template.1
+ man ./docs/muttdelay.1
-=head2 Renaming template into your project name
+=head2 Renaming muttdelay into your project name
-Rename all files which have *template* included into your own new package name. You can do that with:
+Rename all files which have *muttdelay* included into your own new package name. You can do that with:
PROJECTNAME=yourproject
- find . -name \*template\* |
- while read template; do git mv $template ${template/template/$PROJECTNAME}; done
+ find . -name \*muttdelay\* |
+ while read muttdelay; do git mv $muttdelay ${muttdelay/muttdelay/$PROJECTNAME}; done
-Search all content and rename *template* into your own new package name. You can do that with:
+Search all content and rename *muttdelay* into your own new package name. You can do that with:
- grep -R template . | grep -v .git |
- cut -d: -f1 | uniq | xargs sed -i "s/template/$PROJECTNAME/g"
+ grep -R muttdelay . | grep -v .git |
+ cut -d: -f1 | uniq | xargs sed -i "s/muttdelay/$PROJECTNAME/g"
=head2 Updating ./debian
diff --git a/docs/template.txt b/docs/muttdelay.txt
index 5200d1f..2ce9cb3 100644
--- a/docs/template.txt
+++ b/docs/muttdelay.txt
@@ -1,5 +1,5 @@
NAME
- template - A template project
+ muttdelay - A muttdelay project
WTF?
You may use this project in order to build your own Debian package for
@@ -7,7 +7,7 @@ WTF?
Debian GNU/Linux Wheezy.
Feel free to modify any aspects. This project is just an empty example
- template.
+ muttdelay.
Follow these steps:
@@ -26,7 +26,7 @@ WTF?
To test run
- ./bin/template
+ ./bin/muttdelay
It should print out the version number of the project.
@@ -37,27 +37,27 @@ WTF?
It will create the files like:
- ../template_0.0.0.0_all.deb
- ../template_0.0.0.0.dsc
- ../template_0.0.0.0_amd64.changes
- ../template_0.0.0.0.tar.gz
+ ../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
It should create a debian package in ../. Check and install it, e.g:
- lintian --pedantic ../template_0.0.0.0_all.deb
- sudo dpkg -i ../template_0.0.0.0_all.deb
+ lintian --pedantic ../muttdelay_0.0.0.0_all.deb
+ sudo dpkg -i ../muttdelay_0.0.0.0_all.deb
Run
- dpkg -L template
+ dpkg -L muttdelay
to see whats in there. You can now run
- /usr/bin/template
+ /usr/bin/muttdelay
or for example
- man template
+ man muttdelay
Read the Makefile
Read the Makefile in order to understand what's going on.
@@ -77,29 +77,29 @@ Customize
You should also consider the following:
Manual page
- This template is using POD for creating manual pages. Edit
- ./docs/template.pod and run
+ This muttdelay is using POD for creating manual pages. Edit
+ ./docs/muttdelay.pod and run
make documentation
- in order to build ./docs/template.1. The page will be included in the
+ in order to build ./docs/muttdelay.1. The page will be included in the
resulting debian package automatically. You can review the page with
- man ./docs/template.1
+ man ./docs/muttdelay.1
- Renaming template into your project name
- Rename all files which have *template* included into your own new
+ Renaming muttdelay into your project name
+ Rename all files which have *muttdelay* included into your own new
package name. You can do that with:
PROJECTNAME=yourproject
- find . -name \*template\* |
- while read template; do git mv $template ${template/template/$PROJECTNAME}; done
+ find . -name \*muttdelay\* |
+ while read muttdelay; do git mv $muttdelay ${muttdelay/muttdelay/$PROJECTNAME}; done
- Search all content and rename *template* into your own new package name.
+ Search all content and rename *muttdelay* into your own new package name.
You can do that with:
- grep -R template . | grep -v .git |
- cut -d: -f1 | uniq | xargs sed -i "s/template/$PROJECTNAME/g"
+ grep -R muttdelay . | grep -v .git |
+ cut -d: -f1 | uniq | xargs sed -i "s/muttdelay/$PROJECTNAME/g"
Updating ./debian
Edit the following files accordingly to your new project (e.g. with