search

cheusov / dictd

Client/server software, human language dictionary databases, and tools supporting the DICT protocol (RFC 2229)
71 stars 10 forks source link

Add dictd configuration examples (or improve documentation) #10

Open hirmanpour opened 3 years ago

hirmanpour commented 3 years ago

Hi there,

I have been unable to find in the documentation (or in Google) any information regarding the syntax of the "filter" command.

It would be helpful to add to the dictd configuration examples section, some examples of filtering (for example to convert html to text).

Many thanks, Arach

cheusov commented 2 years ago

Actually, dictd documentation doesn't contain this kind of documentation and I think it's irrelevant to dictd. dictfmt(1) utility takes specifically formatted plain text on input. So, man page for dictfmt(1) also don't contain thinks like converting HTMLs to text etc Sorry for so long delay.

hirmanpour commented 2 years ago

Hi Aleksey and thanks for your reply.

man dictd specifies under the heading "Database Specification":

filter string Specifies the filter command. After the entry is extracted from the database, it will be filtered with this filter. This may be used to provide formatting for the entry (e.g., for html).

Surely, IMHO there should be an indication of the "filter command" syntax, or at least there should be a link to a place where the syntax of the filter command is described.

Or, is it that the "filter command" is somehow common knowledge that I'm not aware of or uses sed syntax ?

I think I'm missing something here ! :-)

Take care,

Arach