Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs folder is fully translated to russian #365

Merged
merged 14 commits into from
Apr 30, 2022
146 changes: 146 additions & 0 deletions docs/config_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Конфигурация

Autin использует два файла конфигурации. Они хранятся в `~/.config/atuin/`. Данные
хранятся в `~/.local/share/atuin` (если не определено другое в XDG\_\*).

Путь до катклога конфигурации может быть изменён установкой
параметра `ATUIN_CONFIG_DIR`. Например

```
export ATUIN_CONFIG_DIR = /home/ellie/.atuin
```

## Пользовательская конфигурация

```
~/.config/atuin/config.toml
```

Этот файл используется когда клиент работает на локальной машине (не сервере).

See [config.toml](../atuin-client/config.toml) for an example

### `dialect`

Этот параметр контролирует как [stats](stats.md) команда обрабатывает данные.
Может принимать одно из двух допустимых значений:

```
dialect = "uk"
```

или

```
dialect = "us"
```

По умолчанию - "us".

### `auto_sync`

Синхронизироваться ли автоматически если выполнен вход. По умолчанию - да (true)
```
auto_sync = true/false
```

### `sync_address`

Адрес сервера для синхронизации. По умолчанию `https://api.atuin.sh`.

```
sync_address = "https://api.atuin.sh"
```

### `sync_frequency`

Как часто клиент синхронизируется с сервером. Может быть указано в
понятном для человека формате. Например, `10s`, `20m`, `1h`, и т.д.
По умолчанию `1h`

Если стоит значение 0, Autin будет синхронизироваться после каждой выполненной команды.
Помните, что сервера могут иметь ограничение на количество отправленных запросов.

```
sync_frequency = "1h"
```

### `db_path`

Путь до базы данных SQlite. По умолчанию это
`~/.local/share/atuin/history.db`.

```
db_path = "~/.history.db"
```

### `key_path`

Путь до ключа шифрования Autin. По умолчанию,
`~/.local/share/atuin/key`.

```
key = "~/.atuin-key"
```

### `session_path`

Путь до серверного файла сессии Autin. По умолчанию,
`~/.local/share/atuin/session`. На самом деле это просто API токен.

```
key = "~/.atuin-session"
```

### `search_mode`

Определяет, какой режим поиска будет использоваться. Autin поддерживает "prefix",
текст целиком (fulltext) и неточный ("fuzzy") поиск. Режим "prefix" производит
поиск по "запрос\*", "fulltext" по "\*запрос\*", и "fuzzy" использует
[вот такой](#fuzzy-search-syntax) синтаксис.

По умолчанию стоит значение "prefix"

### `filter_mode`

Фильтр, по-умолчанию использующийся для поиска

| Столбец 1 | Столбец 2 |
|------------------|----------------------------------------------------------|
| global (default) | Искать историю команд со всех хостов, сессий и каталогов |
| host | Искать историю команд с этого хоста |
| session | Искать историю команд этой сессии |
| directory | Искать историю команд, выполненных в текущей папке |

Режимы поиска могут быть изменены через ctrl-r


```
search_mode = "fulltext"
```

#### `fuzzy` синтаксис поиска

Режим поиска "fuzzy" основан на
[fzf search syntax](https://github.com/junegunn/fzf#search-syntax).

| Токен | Тип совпадений | Описание |
|-----------|----------------------------|-------------------------------------|
| `sbtrkt` | fuzzy-match | Всё, что совпадает с `sbtrkt` |
| `'wild` | exact-match (В кавычках) | Всё, что включает в себя `wild` |
| `^music` | prefix-exact-match | Всё, что начинается с `music` |
| `.mp3$` | suffix-exact-match | Всё, что заканчивается на `.mp3` |
| `!fire` | inverse-exact-match | Всё, что не включает в себя `fire` |
| `!^music` | inverse-prefix-exact-match | Всё, что не начинается с `music` |
| `!.mp3$` | inverse-suffix-exact-match | Всё, что не заканчивается на `.mp3` |

Знак вертикальной черты означает логическое ИЛИ. Например, запрос ниже вернет
всё, что начинается с `core` и заканчивается либо на `go`, либо на `rb`, либо на `py`.

```
^core go$ | rb$ | py$
```

## Серверная конфигурация

`// TODO`
27 changes: 27 additions & 0 deletions docs/import_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# `atuin import`

Autin может импортировать историю из "старого" файла истории

`atuin import auto` предпринимает попытку определить тип командного интерфейса
(через \$SHELL) и запускает нужный скрипт импорта.

К сожалению, эти файлы содержат не так много информации, как Autin, так что не
все функции будут доступны с импортированными данными.

# zsh

```
atuin import zsh
```

Если у вас есть HISTFILE, то эта команда должна сработать. Иначе, попробуйте

```
HISTFILE=/path/to/history/file atuin import zsh
```

Этот параметр поддерживает как и упрощённый, так и полный формат.

# bash

TODO
39 changes: 39 additions & 0 deletions docs/key-binding_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Key binding

По умолчанию, Autin будет переназначать <kbd>Ctrl-r</kbd> и клавишу 'стрелка вверх'.
Если вы не хотите этого, установите параметр ATUIN_NOBIND прежде чем вызывать `atuin init`

Например,

```
export ATUIN_NOBIND="true"
eval "$(atuin init zsh)"
```

Таким образом вы можете разрешить переназначение клавиш Autin, если это необходимо.
Делайте это до инициализирующего вызова.

# zsh

Autin устанавливает виджет ZLE "\_atuin_search_widget"

```
export ATUIN_NOBIND="true"
eval "$(atuin init zsh)"

bindkey '^r' _atuin_search_widget

# зависит от режима терминала
bindkey '^[[A' _atuin_search_widget
bindkey '^[OA' _atuin_search_widget
```

# bash

```
export ATUIN_NOBIND="true"
eval "$(atuin init bash)"

# Переопределите ctrl-r, и любые другие сочетания горячих клавиш тут
bind -x '"\C-r": __atuin_history'
```
11 changes: 11 additions & 0 deletions docs/list_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Вывад истории на экран

```
atuin history list
```

| Аргумент | Описание |
|----------------|--------------------------------------------------------------------------------|
| `--cwd/-c` | Каталог, историю команд которой необходимо вывести (по умолчанию все каталоги) |
| `--session/-s` | Выводит историю команд только текущей сессии (по умолчанию false) |
| `--human/-h` | Читаемый формат для времени и периодов времени (по умолчанию false) |
39 changes: 39 additions & 0 deletions docs/search_ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# `atuin search`

```
atuin search <query>
```

Поиск в Atuin также поддерживает wildcards со знаками `*` или `%`.
По умолчанию, должен быть указан префикс (т.е. все запросы автоматически дополняются wildcard -ами)


| Аргумент | Описание |
|--------------------|---------------------------------------------------------------------------------------------|
| `--cwd/-c` | Каталог, для которого отображается история (по умолчанию, все каталоги)) |
| `--exclude-cwd` | Исключить команды которые запускались в этом каталоге (по умолчанию none) |
| `--exit/-e` | Фильтровать по exit code (по умолчанию none) |
| `--exclude-exit` | Исключить команды, которые завершились с указанным значением (по умолчанию none) |
| `--before` | Включить только команды, которые были запущены до указанного времени (по умолчанию none) |
| `--after` | Включить только команды, которые были запущены после указанного времени (по умолчанию none) |
| `--interactive/-i` | Открыть интерактивный поисковой графический интерфейс (по умолчанию false) |
| `--human/-h` | Использовать читаемое формавтирование для времени и периодов времени (по умолчанию false) |

## Примеры

```
# Начать интерактивный поиск с текстовым пользовательским интерфейсом
atuin search -i

# Начать интерактивный поиск с текстовым пользовательским интерфейсом и уже введённым запросом
atuin search -i atuin

# Искать по всем командам, начиная с cargo, которые успешно завершились
atuin search --exit 0 cargo

# Искать по всем командам которые завершились ошибками и были вызваны в текущей папке и были запущены до первого апреля 2021
atuin search --exclude-exit 0 --before 01/04/2021 --cwd .

# Искать по всем командам, начиная с cargo, которые успешно завершились и были запущены после трёх часо дня вчера
atuin search --exit 0 --after "yesterday 3pm" cargo
```
Loading