Update 'docs/commands.md'

This commit is contained in:
Glenn Y. Rolland 2023-05-27 18:18:28 +00:00
parent ef322cd71e
commit 33a3960354

View file

@ -1,13 +1,31 @@
# Commands # Commands
generate: Cette commande génère un fichier de calendrier. L'option --... semble être un placeholder, donc je suppose qu'il pourrait y avoir d'autres options à spécifier ici. ## generate
@ read: Cette commande lit un fichier .ics (comme alice.ics ou bob.ics) et l'ajoute à la pile. Cette commande génère un fichier de calendrier. L'option --... semble être un placeholder, donc je suppose qu'il pourrait y avoir d'autres options à spécifier ici.
@ filter --merge: Cette commande retire le fichier .ics du dessus de la pile, applique une opération de fusion (le détail précis de cette opération n'est pas précisé dans votre description), puis ajoute le résultat à la pile. ## read
@ filter --anonymize: Cette commande retire le fichier .ics du dessus de la pile, applique une opération d'anonymisation (probablement en supprimant ou en brouillant les informations sensibles), puis ajoute le résultat à la pile. Cette commande lit un fichier .ics (comme alice.ics ou bob.ics) et l'ajoute à la pile.
@ union: Cette commande retire les deux fichiers .ics du dessus de la pile, calcule l'union de leurs événements (c'est-à-dire tous les événements qui apparaissent dans l'un ou l'autre fichier), puis ajoute le résultat à la pile. ## filter
@ substract: Cette commande retire les deux fichiers .ics du dessus de la pile, soustrait les événements du second fichier du premier (c'est-à-dire les événements qui apparaissent dans le premier fichier mais pas dans le second), puis ajoute le résultat à la pile. Cette commande retire le fichier .ics du dessus de la pile, applique un filtre, puis ajoute le résultat à la pile.
* --merge-overlaps: applique une opération de fusion des évenements qui se chevauchent
* --anonymize: applique une opération d'anonymisation qui supprime le titre et le détails des évenements
## union
Cette commande retire les deux fichiers .ics du dessus de la pile, calcule l'union de leurs événements (c'est-à-dire tous les événements qui apparaissent dans l'un ou l'autre fichier), puis ajoute le résultat à la pile.
## swap
Cette commande inverse l'élément du haut de la pile avec l'élement juste en dessous.
## substract
Cette commande retire les deux fichiers .ics du dessus de la pile, construit la différence entre les deux (c'est-à-dire retire du calendrier du bas de la pile les éléments qui sont dans celui du haut de la pile), puis ajoute le résultat à la pile.
* --events : supprime les evements qui sont dans le calendrier en haut de pile
* --intervals : supprime les intervales de temps des évenements qui sont dans le cadrier en haut de pile