vlastavesely/sanskrit-iast
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update the man page

Browse source
This commit is contained in:
Vlasta Vesely 2020-01-22 19:01:18 +01:00
parent 64bbfc099f
commit be3a9a4cf8
No known key found for this signature in database
GPG key ID: EB0E649DC0DFCC22
1 changed files with 51 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
doc/iast.1.adoc
View file

@ -9,68 +9,81 @@ iast - a helper for Sanskrit transliteration
SYNOPSIS SYNOPSIS
-------- --------
-------------------------------------------------------------------------------- *iast* [*-h*] [*-v*] [*-f* 'FILE']... [*-r* | *-c* | *-e*] ['TEXT ARGUMENTS']...
iast [-h] [-v] [-f file] [-r] [-e] [-c] [text arguments]
--------------------------------------------------------------------------------
OPTIONS
-------
*-h*::
show help and exit
*-v*::
show version number and exit
*-f*::
input file for processing
*-r*::
reverse transliteration (from Latin to Devanagari)
*-c*::
transcript into Czech
*-e*::
convert symbolic ASCII text to IAST representation
DESCRIPTION DESCRIPTION
----------- -----------
iast is a tool for the lossless transliteration of Sanskrit terms written in *iast* is a tool for the lossless transliteration of Sanskrit terms written in
Devanagari into Latin using the International Alphabet of Sanskrit Devanagari into Latin using the IAST scheme (International Alphabet of Sanskrit
Transliteration (IAST). Transliteration).
By default, the program takes all input arguments written in Devanagari and The program allows to perform transliteration either on all non-option
transliterates them to IAST version. arguments or on whole files specified by the *-f* option. By default, it
performs transliteration from Devanagari to a corresponding romanised version,
but using the *-r* switch, reverse transliteration can be performed, converting
romanised texts back into Devanagari.
OPTIONS
-------
*-f* 'FILE'::
Input file for processing.
*-r*::
Use reverse transliteration (from Latin to Devanagari).
*-c*::
Transcript a Devanagari text into Czech.
*-e*::
Convert a symbolic ASCII(7) text to IAST representation.
*-h*::
Show usage information and exit.
*-v*::
Show version number and exit.
ENCODING ENCODING
-------- --------
When the flag "-e" is set on, the program converts purely ASCII-encoded strings When the flag '-e' is set on, the program converts purely ASCII-encoded strings
into the special characters of the IAST alphabet. For example, it converts into the special characters of the IAST alphabet. For example, it converts
"sam.skr.tam" to "saṃskṛtam" or "s,a-stram" to "śāstram". "sam.skr.tam" to "saṃskṛtam" or "s,a-stram" to "śāstram".
The encoding scheme is based on the following principle: characters "-", ".", The encoding scheme is based on the following principle: characters "-", ".",
"," and "~" are considered to be modifiers that modify a letter that stands "," and "~" are considered to be modifiers that modify a letter that stands
before the modifier. For example, if the string to be encoded contains "a-", before the modifier. For example, if the string to be encoded contains "a-",
it will be encoded as "ā" and sequence "n~" as "ñ". The only exception from it will be encoded as "ā" and the sequence "n~" as "ñ" and so on. The only
the rule is the letter "n" because it can be encoded both with an over-dot (ṅ) exception from the rule is the letter "n" because it can be encoded both with
and under-dot (ṇ). For the over-dot variant, the conversion sequence is "n^.". an over-dot (ṅ) and under-dot (ṇ). For the over-dot variant, the conversion
sequence is "n^.".
Alternatively, the Czech characters "á", "í", "ú", "š" and "ň" can be used as Alternatively, the Czech characters "á", "í", "ú", "š" and "ň" can be used as
shortcuts to encode the letters "ā", "ī", "ū", "ś" and "ñ" respectively. shortcuts to encode the letters "ā", "ī", "ū", "ś" and "ñ" respectively.
COPYRIGHT AUTHOR
--------- ------
Copyright (c) 2018, 2020 Vlasta Vesely <vlastavesely@protonmail.ch> Copyright (c) 2018, 2020 Vlasta Vesely <vlastavesely@protonmail.ch>
LICENSING AND WARRANTY REPORTING BUGS
---------------------- --------------
If you encounter a bug, you should make sure that you are using the latest
version of the software. If you do and the bug is still present, you can
report it using either the issues tracker on GitLab or GitHub.
GitLab: <https://gitlab.com/vlastavesely/sanskrit-iast/issues> +
GitHub: <https://github.com/vlastavesely/sanskrit-iast/issues>
LICENSE AND WARRANTY
--------------------
This software is released under the terms of the GPL license version 2 as This software is released under the terms of the GPL license version 2 as
published by the Free Software Foundation. You can freely redistribute and/or published by the Free Software Foundation.
modify the software under the terms of the license. See <https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt> for more details.
This program is distributed in the hope that it will be useful, but WITHOUT This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS