Orbifx's Logarion
Title:
Guide to text repositories with Logarion
Authors:
orbifx
Date:
Id:
11bcd8e9-280b-4baf-9e15-3589b8ecc521

For the following guide the `txt` command needs to be installed in your system. Visit <https://logarion.orbitalfox.eu/> for what Logarion is how to install it and how to ask questions.

To file and exchange texts, `txt` uses plain-text headers on the top of text files. The basic headers include an identifier, topics, authors and a date. It also needs to know basic repository information.

Help

Use `txt help` for general use or specific details.

Pull

A remote repository can be registered and texts copied locally. To add a new remote run:

txt pull "url"

where "url" is the address of the remote repository. The program will fetch the `index.pck` file and download the text files. It will not redownload previous texts, unless they have edited.

After a remote has been added, running `txt pull` will pull all known repositories.

New texts

To create new text files with the header fields to populate, use:

txt new "My title"

where "My title" is the initial title you wish the text to have. The command will return the filename of the new text. The filename starts with a part of the ID and the title of the text. Use the file name to open it with your text editor.

Convert

Generate web sites and Gemini capsules of a text collection using `txt convert`. Before converting, an index file must be generated using `txt index`. Upload the `index.pck` and the text files of the subdirectory to a host of your choice. If the host provides HTTP or Gemini access, upload `.htm` and `.gem` files respectively.

Subrepositories

It may be useful to separate your texts in various subrepositories to upload to different locations. Use `txt file` to link texts in different subdirectories. For example:

txt file a.txt b.txt public/

Will link a.txt and b.txt within public. Then run:

txt index public/

To index those file and finally:

txt convert public/

To convert them.