Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/10maurycy10/jargoncli

A rust utility to look up a term in the jargon file!
https://github.com/10maurycy10/jargoncli

Last synced: 11 days ago
JSON representation

A rust utility to look up a term in the jargon file!

Awesome Lists containing this project

README

        

# Jargoncli, a terminal Jargon file viewer

![Screenshot of using jargon cli to view the entry for "computer confeti"](jargon.png)

## Installation

Run ``cargo install jargoncli``.

The binary will be installed to ``~/.cargo/bin`` you may have to source ``~/.cargo/env`` to use it.

It is recommended to copy the ``jargon447`` file to the default path of ``/usr/local/share/jargon``.

### With local copy

run ``cargo install --path /path/to/repo`` to install it from a localy cloned repo.

### Without cargo

you can build it using rustc: ``rustc /path/to/repo/src/main.rs -o /path/to/binary/to/output -O``.

## Usage

```
jargoncli [file path/to/jargon/file] [define wordtodefine] [index]

file: Jargon file location
define: Print a word's entry in the file
index: Output a list of entrys
```

## Updating the file

You can download text versions of the file from http://www.catb.org/jargon/oldversions/.

The file seems to contain invalid UTF-8, which can be removed with iconv:

```
iconv -f utf8 -t utf8//IGNORE < jargonfile > jargonwithvalidunicode
```