Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuuuube committed Mar 23, 2024
1 parent 280fd6f commit 952a85f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Kuuubedit

Powerful headless text editor for processing large files.

WARNING: Files are not buffered, the file size capable of being loaded is limited by your memory size.
Powerful headless text editor for processing enormous files.

## Args

Expand All @@ -14,7 +12,9 @@ WARNING: Files are not buffered, the file size capable of being loaded is limite

- `-u`, `--undo`: Enables the undo command.

- `-b BUFFER`, `--buffer BUFFER`: Sets file buffer size (unfinished, currently, only --no-buf is supported).
- `-b BUFFER`, `--buffer BUFFER`: Sets file buffer size in bytes. Default: 100000000 (100MB), Minimum: 1024 (1KB), Maximum: 18446744073709551615 (18.4EB).

- `-n`, `--no-buf`: Disabled file buffering.

## Commands

Expand Down
5 changes: 3 additions & 2 deletions src/args_parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ pub struct Args {
pub undo: bool,

/// Sets file buffer size
#[arg(short, long, default_value_t = 100000000, value_parser = buffer_size_check)]
/// [min: 1024] [max: 18446744073709551615]
#[arg(short, long, default_value_t = 100000000, value_parser = buffer_size_check, verbatim_doc_comment)]
pub buffer: u64,

/// Disables file buffering
#[arg(long)]
#[arg(short, long)]
pub no_buf: bool,

/// Path to file to open
Expand Down

0 comments on commit 952a85f

Please sign in to comment.