diff options
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/environment_sh.html | 92 | ||||
| -rw-r--r-- | docs/lib/global_sh.html | 218 | ||||
| -rw-r--r-- | docs/lib/project_sh.html | 43 |
3 files changed, 353 insertions, 0 deletions
diff --git a/docs/lib/environment_sh.html b/docs/lib/environment_sh.html new file mode 100644 index 0000000..792b83b --- /dev/null +++ b/docs/lib/environment_sh.html @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta http-equiv="Content-type" content="text/html; charset=UTF-8" /> +<link rel="stylesheet" href="../robodoc.css" type="text/css" /> +<script src="../robodoc.js"></script> +<title>environment.sh</title> +<!-- Source: ./lib/environment.sh --> +<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +</head> +<body> +<div id="logo"> +<a name="robo_top_of_doc"></a> +</div> <!-- logo --> +<div id="navigation"> +<a class="menuitem" href="../toc_index.html#top">Table of Contents</a> +<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a> +<a class="menuitem" href="../masterindex.html#top">Index</a> +<a class="menuitem" href="../robo_dirs.html#top">Directories</a> +<a class="menuitem" href="../robo_files.html#top">Files</a> +<a class="menuitem" href="../robo_definitions.html#top">Definitions</a> +<a class="menuitem" href="../robo_functions.html#top">Functions</a> +<a class="menuitem" href="../robo_modules.html#top">Modules</a> +</div> <!-- navigation --> +<div id="content"> +<hr /> +<a name="lib2fenvironment2esh"></a> +<a name="robo2"></a><h2>lib/environment.sh [ Files ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p class="item_name">NAME</p> +<p> environment - файл c основными константами и переменными. +</p> +<p class="item_name">USED BY</p> +<ul><li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> +</li> +<li> <a href="../jtx_sh.html#robo_top_of_doc">jtx.sh</a> +</li> +<li> someday.sh +</li> +<li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +<li> start_stop.sh +</li> +</ul> +<p></p> + +<hr /> +<a name="environment2esh2fFOOTE"></a> +<a name="robo7"></a><h2>environment.sh/FOOTE [ Definitions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>FOOTE</strong> - bash-скрипт $HOME/bin/foote.sh. +</p> + +<hr /> +<a name="environment2esh2fLIB5fDIR"></a> +<a name="robo8"></a><h2>environment.sh/LIB_DIR [ Definitions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>LIB_DIR</strong> - папка с вспомогательными функциями. +</p> + +<hr /> +<a name="environment2esh2fPEACLOCK5fCUSTOM5fCONFIG"></a> +<a name="robo9"></a><h2>environment.sh/PEACLOCK_CUSTOM_CONFIG [ Definitions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>PEACLOCK_CUSTOM_CONFIG</strong> - кастомный файл конфигурации для peaclock. +</p> + +<hr /> +<a name="environment2esh2fROOT5fDIR"></a> +<a name="robo10"></a><h2>environment.sh/ROOT_DIR [ Definitions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo2">environment.sh</a> ] [ <a href="../robo_definitions.html#robo_top_of_doc">Definitions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>ROOT_DIR</strong> - корень проекта. +</p> + +</div> <!-- content --> +<div id="footer"> +<p>Generated from ./lib/environment.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +</div> <!-- footer --> +</body> +</html> diff --git a/docs/lib/global_sh.html b/docs/lib/global_sh.html new file mode 100644 index 0000000..3600ff8 --- /dev/null +++ b/docs/lib/global_sh.html @@ -0,0 +1,218 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta http-equiv="Content-type" content="text/html; charset=UTF-8" /> +<link rel="stylesheet" href="../robodoc.css" type="text/css" /> +<script src="../robodoc.js"></script> +<title>global.sh</title> +<!-- Source: ./lib/global.sh --> +<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +</head> +<body> +<div id="logo"> +<a name="robo_top_of_doc"></a> +</div> <!-- logo --> +<div id="navigation"> +<a class="menuitem" href="../toc_index.html#top">Table of Contents</a> +<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a> +<a class="menuitem" href="../masterindex.html#top">Index</a> +<a class="menuitem" href="../robo_dirs.html#top">Directories</a> +<a class="menuitem" href="../robo_files.html#top">Files</a> +<a class="menuitem" href="../robo_definitions.html#top">Definitions</a> +<a class="menuitem" href="../robo_functions.html#top">Functions</a> +<a class="menuitem" href="../robo_modules.html#top">Modules</a> +</div> <!-- navigation --> +<div id="content"> +<hr /> +<a name="lib2fglobal2esh"></a> +<a name="robo3"></a><h2>lib/global.sh [ Files ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>global.sh</strong> - общие функции для всех скриптов. +</p> +<p class="item_name">USES</p> +<ul><li> <a href="./environment_sh.html#robo2">environment.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fcheckExistingProject"></a> +<a name="robo11"></a><h2>global.sh/checkExistingProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>checkExistingProject</strong> - проверка на наличие существующего проекта. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>checkExistingProject</strong> <id | uuid> +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fdenotateAllAnnotations"></a> +<a name="robo12"></a><h2>global.sh/denotateAllAnnotations [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>denotateAllAnnotations</strong> - удаление всех аннотаций у задачи. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>denotateAllAnnotations</strong> <id | uuid> +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fgetAnnotationCount"></a> +<a name="robo13"></a><h2>global.sh/getAnnotationCount [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getAnnotationCount</strong> - возвращает длину массива аннотаций задачи. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>getAnnotationCount</strong> <id | uuid> +</pre> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {String} - Количество аннотаций +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fgetLatestTaskId"></a> +<a name="robo14"></a><h2>global.sh/getLatestTaskId [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getLatestTaskId</strong> - возвращает id задачи. +</p> +<p class="item_name">DESCRIPTION</p> +<p> Возвращает id задачи с тегом +LATEST, которая является самой последней из добавленных. +</p> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {string} - Id задачи +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +</ul> +<p></p> +<p class="item_name">NOTES</p> +<pre> <a href="https://taskwarrior.org/docs/tags/">https://taskwarrior.org/docs/tags/</a> +</pre> + +<hr /> +<a name="global2esh2fgetTags"></a> +<a name="robo15"></a><h2>global.sh/getTags [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>getTags</strong> - возвращает массив тегов задачи. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>getTags</strong> <id | uuid> +</pre> +<p class="item_name">RETURN VALUE</p> +<pre class="source"># return {Array} - Массив тегов +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +<li> someday.sh +</li> +<li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fhasProject"></a> +<a name="robo16"></a><h2>global.sh/hasProject [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>hasProject</strong> - проверка на наличие проекта у задачи. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># id | uuid - id или uuid задачи. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>hasProject</strong> <id | uuid> +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +</ul> +<p></p> + +<hr /> +<a name="global2esh2fnotify"></a> +<a name="robo17"></a><h2>global.sh/notify [ Functions ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo3">global.sh</a> ] [ <a href="../robo_functions.html#robo_top_of_doc">Functions</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>notify</strong> - вывод сообщения через <strong>notify</strong>-send. +</p> +<p class="item_name">ARGUMENTS</p> +<pre class="source"># category - категория уведомления. +# message - строка сообщения. +</pre> +<p class="item_name">USAGE</p> +<pre class="source"># <strong>notify</strong> <category> <message> +</pre> +<p class="item_name">EXAMPLE</p> +<pre class="source"># <strong>notify</strong> "msg-error" "Ошибка!" +</pre> +<p class="item_name">USES</p> +<ul><li> <a href="#robo_top_of_doc">global.sh</a> +</li> +<li> <a href="./project_sh.html#robo_top_of_doc">project.sh</a> +</li> +<li> edit.sh +</li> +<li> someday.sh +</li> +<li> start_stop.sh +</li> +<li> <a href="../edit_project_sh.html#robo0">edit_project.sh</a> +</li> +</ul> +<p></p> +<p class="item_name">NOTES</p> +<pre> Категории уведомлений находятся в $HOME/.config/mako/category +</pre> + +</div> <!-- content --> +<div id="footer"> +<p>Generated from ./lib/global.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +</div> <!-- footer --> +</body> +</html> diff --git a/docs/lib/project_sh.html b/docs/lib/project_sh.html new file mode 100644 index 0000000..aded21a --- /dev/null +++ b/docs/lib/project_sh.html @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta http-equiv="Content-type" content="text/html; charset=UTF-8" /> +<link rel="stylesheet" href="../robodoc.css" type="text/css" /> +<script src="../robodoc.js"></script> +<title>project.sh</title> +<!-- Source: ./lib/project.sh --> +<!-- Generated with ROBODoc Version 4.99.44 (Mar 23 2025) --> +</head> +<body> +<div id="logo"> +<a name="robo_top_of_doc"></a> +</div> <!-- logo --> +<div id="navigation"> +<a class="menuitem" href="../toc_index.html#top">Table of Contents</a> +<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a> +<a class="menuitem" href="../masterindex.html#top">Index</a> +<a class="menuitem" href="../robo_dirs.html#top">Directories</a> +<a class="menuitem" href="../robo_files.html#top">Files</a> +<a class="menuitem" href="../robo_definitions.html#top">Definitions</a> +<a class="menuitem" href="../robo_functions.html#top">Functions</a> +<a class="menuitem" href="../robo_modules.html#top">Modules</a> +</div> <!-- navigation --> +<div id="content"> +<hr /> +<a name="lib2fproject2esh"></a> +<a name="robo4"></a><h2>lib/project.sh [ Files ]</h2> + +<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../tskw_sh.html#robo5">lib</a> ] [ <a href="../robo_files.html#robo_top_of_doc">Files</a> ]</p> +<p class="item_name">NAME</p> +<p> <strong>project.sh</strong> - общие функции для всех скриптов. +</p> + +</div> <!-- content --> +<div id="footer"> +<p>Generated from ./lib/project.sh with <a href="http://www.xs4all.nl/~rfsber/Robo/robodoc.html">ROBODoc</a> V4.99.44 on 2025-05-01 19:58:11</p> +</div> <!-- footer --> +</body> +</html> |