Les paquets

De Wiki EELL.

(Différences entre les versions)
m (Liste de l'archive myproject.tar.gz : Retouches de couleurs)
m (Fichier project.prj : Retouches de couleurs)
Ligne 364 : Ligne 364 :
==== Fichier project.prj ====
==== Fichier project.prj ====
-
 
+
<pre style="color:white; background-color:#554455;">fonction1.c
-
<pre>fonction1.c
+
fonction2.c
fonction2.c
main.c</pre>
main.c</pre>

Version du 11 février 2014 à 13:53

EN COURS D'ECRITURE


 Exercice de construction d'un paquet debian.

Cet exercice a pour but de se familiariser avec la construction d'un paquet debian.
Ce paquet est construit à titre d"essai
Voyez la construction d'un paquet mkd officiel (version 131215)

Cette page a été optimisée pour "Version imprimable". Si vous désirez imprimer cette page assurez-vous que les textes déroulants ne sont pas masqués.


Les paquets d'installation des logiciels pour les systèmes d'exploitation linux permettent de sécuriser les systèmes grâce à des clés numériques. Ils permettent aussi de faciliter l'installation des applications.

La description qui suit ne conduit pas à la construction d'un paquet sécurisé


Sommaire

Créer un paquet debian

La lecture de la documentation sur le sujet est si obscure qu'il est bien difficile de créer son premier paquet.
L'objet de cet article est de voir, au travers d'un exemple simple, comment sortir de l'obscurité.

Le paquet debian que nous allons créer ne sera pas sécurisé et ne pourra pas être installé par le gestionnaire de la logithèque. Il sera simplement installé et désinstallé par des commandes shell.

Le paquet

  1. L'idée de la démonstration est de créer un utilitaire très simple à l'usage des programmeurs avec l'aide de la commande mkd.
  2. Nous nous sommes inspirés de l'article myecho[1] pour vous proposer cette commande que nous appellerons mkmaintainerdocu (Make maintainer documentation)
  3. Cette commande n'a pas pour ambition de persister dans les répertoires des commandes binaires (/bin, /usr/bin, etc.)

Que doit-il faire ?

  1. créer un fichier de projet pour une application écrite en langage C
  2. générer le fichier d'entête de l'application "<projet>.h
  3. générer la documentation des fonctions
  4. générer la documentation destinée aux programmeurs
  5. Si possible afficher les fichier à la fin de leur création ou modification.

Choix de l'exécutable

Le plus simple est de créer une commande shell bash, facile à maîtriser et inspirée par myecho cité dans les références.

Structure de l'archive projet-mkmaintainerdocu.tar.gz

"./" est le répertoire conteneur que nous pouvons appeler projet-mkmaintainerdocu Il contient nos utilitaires et les fichiers d'installation. "./mkmaintainerdocu" est le répertoire racine de notre paquet. Ce qui nous intéresse se trouve DANS ce répertoire

./mkmaintainerdocu/usr 
./mkmaintainerdocu/usr/share 
./mkmaintainerdocu/usr/share/doc 
./mkmaintainerdocu/usr/share/doc/changelog.debian - fichier à créer 
./mkmaintainerdocu/usr/share/doc/copyright - fichier à créer  
./mkmaintainerdocu/usr/share/doc/changelog - fichier à créer 
./mkmaintainerdocu/usr/share/doc/README - fichier à créer 
./mkmaintainerdocu/usr/local 
./mkmaintainerdocu/usr/local/bin 
./mkmaintainerdocu/usr/local/bin/mkmaintainerdocu - fichier à créer
./mkmaintainerdocu/DEBIAN 
./mkmaintainerdocu/DEBIAN/postrm - fichier à créer
./mkmaintainerdocu/DEBIAN/control - fichier à créer
./mkmaintainerdocu/DEBIAN/postinst - fichier à créer

* On y ajoutera les utilitaires :
./empaqueter - pour créer le paquet
./installer - pour installer l'application
./desinstaller - pour désinstaller le paquet
./KONSOLE - utilitaire pour créer une console locale

* Fichiers créés à l'empaquetage :
./mkmaintainerdocu.deb

* Remarques sur l'utilitaire de la logithèque :
./remarques


changelog.debian

  • fichier nécessaire à la création du paquet, peut être vide.
First version : 1.0 (2013-12-15)


copyright

  • fichier nécessaire à la création du paquet, peut être vide.
First version : 1.0 (2013-12-15) (c) Demo <demo@demo.com>

changelog

  • fichier nécessaire à la création du paquet, peut être vide.
First version : 1.0 (2013-12-15)

README

  • fichier utile à la construction du paquet
This demo command is writed to create a self debian package.

mkmaintainerdocu

  • notre fichier shell qui va exécuter nos commandes de création des documents
#!/bin/bash
# File mkmaintainerdocu writed by Clara Jimenez 2013-12-15
# Demo : Create any simple debian package for mkd and C programming language

# remove old files :
rm *.c~ # ATTENTION !
# create project file only with C files :
ls -1 *.c > project-prj
# create ./maintainer-documentation directory if not exist :
install -d ./maintainer-documentation

# Make header file project.h and header document; style C, overwrite, text only
echo " make header file './maintainer-documentation/project.h' "
mkd -Cjwt H project-prj ./maintainer-documentation/project.h
echo " make fuctions documentation './maintainer-documentation/project-functions-documentation.txt' "
mkd -Cjwt D project-prj ./maintainer-documentation/project-functions-documentation.txt

# Make individuals tests directives document; style C, overwrite, add line number, text only
echo " make tests document, directives for all functions './maintainer-documentation/\
project-functions-directives.txt' "
mkd -Cjwnt T project-prj ./maintainer-documentation/project-functions-directives.txt

# Make functions updates documentation; style C, overwrite, add line number, text only
echo " make functions maintainers documentation '/maintainer-documentation/\
project-functions-maintainers-doc.txt' "
mkd -Cjwnt P project-prj ./maintainer-documentation/project-functions-maintainers-doc.txt

echo " Make mkd tests : "
echo "  See in working directory. "

postrm

  • shell exécuté après la suppression du paquet (si nécessaire)
  • cet exécutable peut exécuter des mises à jour comme 'cat', 'whatis', et d'autres ...
#!/bin/bash
echo " If this message appears then 'mkmaintainerdocu' is now removed "

control

  • fichier nécessaire à la construction du paquet
Version: 1.0
Section: devel
Priority: optional
architecture: all
Depends: bash, mkd
Maintainer: Demo <demo@demo.com>
Description: Make maintainer documentation for C files. See mkd manual.
Suggests: mkdcppw
Recommends: mkd
  • Le classement des paquets doit être choisi dans une des sections :
    admin, devel, doc, graphics, libs, misc, net, otherofs, pyton, shells, sound, text, utils, x11.

postinst

  • shell exécuté après la création du paquet (si nécessaire)
  • cet exécutable peut exécuter des mises à jour comme 'cat', 'whatis', et d'autres ...
#!/bin/bash
echo " Use 'mkmaintainerdocu' in your working directory "
echo "  Then type 'mkmaintainerdocu' in your terminal or konsole "
echo "  See manual man1 'mkd' and, or, 'mkmaintainerdocu' "

utilitaires

empaqueter

#!/bin/bash
fakeroot chmod 755 mkmaintainerdocu/usr/local/bin/mkmaintainerdocu
fakeroot chmod 755 mkmaintainerdocu/DEBIAN/post*
fakeroot chmod 755 mkmaintainerdocu/DEBIAN/pre*
fakeroot rm *.deb
fakeroot dpkg-deb --build mkmaintainerdocu

installer

#!/bin/bash
sudo dpkg -i mkmaintainerdocu.deb

desinstaller

#!/bin/bash
sudo dpkg --remove mkmaintainerdocu
ou :
# sudo dpkg --purge mkmaintainerdocu

KONSOLE

#!/bin/bash
echo -e '\E['32';'01'm'"click on New Line to 'start' the Konsole"
# echo -e '\E['31';'01'm' "not 'start in a terminal'"
echo -e '\E['32';'01'm'"click on Ctrl-C to exit"
tput sgr0 # Reset text attributes to normal without clear
read pwd
pwd
echo $pwd
tput sgr0 # Reset text attributes to normal without clear
/usr/bin/konsole background-mode --workdir pwd dir
read

Contenu extrait du paquet

  • L'extraction recrée les répertoires avec la même structure.
./mkmaintainerdocu
./mkmaintainerdocu/usr
./mkmaintainerdocu/usr/share
./mkmaintainerdocu/usr/share/doc
./mkmaintainerdocu/usr/share/doc/changelog.debian
./mkmaintainerdocu/usr/share/doc/copyright
./mkmaintainerdocu/usr/share/doc/changelog
./mkmaintainerdocu/usr/share/doc/README
./mkmaintainerdocu/usr/local
./mkmaintainerdocu/usr/local/bin
./mkmaintainerdocu/usr/local/bin/mkmaintainerdocu
./mkmaintainerdocu/DEBIAN
./mkmaintainerdocu/DEBIAN/postrm
./mkmaintainerdocu/DEBIAN/control
./mkmaintainerdocu/DEBIAN/postinst

Tests

Sécurisation des paquets

Les paquets non sécurisés sont à proscrire.



Liens utiles

Créer un paquet ubuntu

Liste 'complète' ? des pages décrivant l'utilisation des paquets sous Ubuntu

Suggestions

  • Si vous utilisez souvent les mêmes codes d'extraction, vous pouvez créer un shell pour la maintenance dans le répertoire /usr/local/bin
  • Pour enregistrer la liste complète des chaînes de caractères ou/et la liste des messages à traduire Ajoutez la ligne suivante :
# Get all strings and select strings for translations
mkd -pnjs '**' project-prj ./maintainer-documentation/strings.txt | grep gettext > ./maintainer-documentation/strings-for-translations.txt 

Références

  1. http://alp.developpez.com/tutoriels/debian/creer-paquet/
Outils personnels