sanskrit-iast/iast.1

106 lines
3 KiB
Groff
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.TH "iast" "1" "25 September 2020" "sanskrit-iast" "Sanskrit Transliteration"
.SH NAME
.B iast
- a helper for Sanskrit transliteration
.SH SYNOPSIS
.SY iast
.OP -h
.OP -v
.RB [ -f
.IR FILE ]...\&
.RB [ -r " |"
.BR -c " |"
.BR -e ]
.RI [ "TEXT ARGUMENTS" ]...
.YS
.SH DESCRIPTION
\fBiast\fR is a tool for the lossless transliteration of Sanskrit terms written
in Devanagari into Latin using the IAST scheme (International Alphabet of
Sanskrit Transliteration).
The program allows to perform transliteration either on all non-option
arguments or on whole files specified by the \fB-f\fR option. By default, it
performs transliteration from Devanagari to a corresponding romanised version,
but using the \fB-r\fR switch, reverse transliteration can be performed, converting
romanised texts back into Devanagari.
.SH OPTIONS
.B \-f
.I FILE
.RS 4
Input file for processing.
.RE
.B \-r
.RS 4
Use reverse transliteration (from Latin to Devanagari).
.RE
.B \-c
.RS 4
Transcript a Devanagari text into Czech.
.RE
.B \-e
.RS 4
Convert a symbolic ASCII(7) text to IAST representation.
.RE
.B \-h
.RS 4
Show usage information and exit.
.RE
.B \-v
.RS 4
Show version number and exit.
.RE
.SH ENCODING
When the flag \fB-e\fR is set on, the program converts purely ASCII-encoded strings
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.
The encoding scheme is based on the following principle: characters -, .,
, 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-,
it will be encoded as ‘ā’ and the sequence n~ as ‘ñ’ and so on. The only
exception from the rule is the letter n because it can be encoded both with
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
shortcuts to encode the letters ‘ā’, ‘ī’, ‘ū’, ‘ś’ and ‘ñ’ respectively.
.SH AUTHOR
Copyright (c) 2018, 2020 Vlasta Vesely <vlastavesely@protonmail.ch>
.SH 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.
.RS 4
GitLab: <https://gitlab.com/vlastavesely/sanskrit-iast/issues>
.br
GitHub: <https://github.com/vlastavesely/sanskrit-iast/issues>
.RE
.SH LICENSE AND WARRANTY
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License version 2 as published by the
Free Software Foundation.
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
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.