mirror of
https://github.com/Dushistov/sdcv.git
synced 2025-12-15 17:31:56 +00:00
108 lines
3.6 KiB
Groff
108 lines
3.6 KiB
Groff
.TH SDCV 1 "2006-04-24" "sdcv-0.4.2"
|
|
.SH NAME
|
|
sdcv \- console version of StarDict program
|
|
.SH SYNOPSIS
|
|
.B sdcv
|
|
[
|
|
.BI options
|
|
]
|
|
[list of words]
|
|
.SH DESCRIPTION
|
|
.I sdcv
|
|
is a simple, cross-platform text-based utility
|
|
for working with dictionaries in StarDict format.
|
|
Each word from "list of words" may be a string
|
|
with a leading '/' for using a Fuzzy search algorithm,
|
|
with a leading '|' for using full-text search,
|
|
and the string may contain '?' and '*' for regexp search.
|
|
It works in interactive and non-interactive mode.
|
|
To exit from interactive mode press Ctrl+D.
|
|
In interactive mode,
|
|
if sdcv was compiled with readline library support,
|
|
you can use the UP and DOWN keys to cycle through history.
|
|
.SH OPTIONS
|
|
.TP 8
|
|
.B "\-h \-\-help"
|
|
Display help message and exit
|
|
.TP 8
|
|
.B "\-v \-\-verbose"
|
|
Display version and exit
|
|
.TP 8
|
|
.B "\-l \-\-list\-dicts"
|
|
Display list of available dictionaries and exit
|
|
.TP 8
|
|
.B "\-u \-\-use\-dict filename"
|
|
For search use only dictionary with this bookname
|
|
.TP 8
|
|
.B "\-n \-\-non\-interactive"
|
|
For use in scripts
|
|
.TP 8
|
|
.B "\-x \-\-only\-data\-dir"
|
|
For use in scripts: only use the dictionaries in data-dir, do not search in user and system directories
|
|
.TP 8
|
|
.B "\-e \-\-exact\-search"
|
|
Do not fuzzy-search for similar words, only return exact matches
|
|
.TP 8
|
|
.B "\-j \-\-json"
|
|
Print the results of list-dicts and searches as json, not as plain text.
|
|
For use in automatically processing the results of a dictionary lookup.
|
|
.TP 8
|
|
.B "\-\-utf8\-output"
|
|
Force sdcv to not convert to locale charset, output in utf8
|
|
.TP 8
|
|
.B "\-\-utf8\-input"
|
|
Force sdcv to not convert from locale charset, assume that
|
|
input is in utf8
|
|
.TP 8
|
|
.B "\-\-data\-dir path/to/directory"
|
|
Use this directory as the path to the stardict data directory. This means that
|
|
sdcv searches for dictionaries in data-dir/dic directory.
|
|
.TP 8
|
|
.B "\-\-color"
|
|
Use ANSI escape codes for colorizing sdcv output (does not work with json output).
|
|
.SH FILES
|
|
.TP
|
|
/usr/share/stardict/dic
|
|
.TP
|
|
$(XDG_DATA_HOME)/stardict/dic
|
|
|
|
Place where sdcv expects to find dictionaries.
|
|
Instead of /usr/share/stardict/dic you can use any directory
|
|
you want, just set the STARDICT_DATA_DIR environment variable.
|
|
For example, if you have dictionaries in /mnt/data/stardict-dicts/dic,
|
|
set STARDICT_DATA_DIR to /mnt/data/stardict-dicts.
|
|
.TP
|
|
$(XDG_DATA_HOME)/sdcv_history
|
|
|
|
This file includes the last $(SDCV_HISTSIZE) words, which you sought with sdcv.
|
|
SDCV uses this file only if it was compiled with readline library support.
|
|
.TP
|
|
$(XDG_CONFIG_HOME)/sdcv_ordering
|
|
|
|
This is a text file containing one dictionary bookname per line.
|
|
It specifies in which order the results of a search should be shown.
|
|
.SH ENVIRONMENT
|
|
Environment Variables Used By \fIsdcv\fR:
|
|
.TP 20
|
|
.B STARDICT_DATA_DIR
|
|
If set, sdcv uses this variable as the data directory, this means that sdcv
|
|
searches dictionaries in $\fBSTARDICT_DATA_DIR\fR/dic
|
|
.TP 20
|
|
.B SDCV_HISTSIZE
|
|
If set, sdcv writes in $(XDG_DATA_HOME)/sdcv_history (or $(SDCV_HISTFILE)) the last $(SDCV_HISTSIZE) words,
|
|
which you look up using sdcv. If it is not set, then the last 2000 words are saved in $(XDG_DATA_HOME)/sdcv_history.
|
|
.TP 20
|
|
.B SDCV_HISTFILE
|
|
If set, sdcv writes it's history to $(SDCV_HISTFILE). If it is not set, then the default $(XDG_DATA_HOME)/sdcv_history path will be used.
|
|
.TP 20
|
|
.B SDCV_PAGER
|
|
If SDCV_PAGER is set, its value is used as the name of the program
|
|
to use to display the dictionary article.
|
|
.SH BUGS
|
|
Email bug reports to dushistov at mail dot ru. Be sure to include the word
|
|
"sdcv" somewhere in the "Subject:" field.
|
|
.SH AUTHORS
|
|
Evgeniy A. Dushistov, Hu Zheng
|
|
.SH SEE ALSO
|
|
stardict(1), http://sdcv.sourceforge.net/, http://stardict.sourceforge.net
|