Skip to content

Commit

Permalink
Cleanup doc (#1823)
Browse files Browse the repository at this point in the history
  • Loading branch information
joelim-work authored Nov 1, 2024
1 parent 3f63bc9 commit dda8e88
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
10 changes: 4 additions & 6 deletions doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ The following options can be used to customize the behavior of lf:
info []string (default '')
infotimefmtnew string (default 'Jan _2 15:04')
infotimefmtold string (default 'Jan _2 2006')
locale string (default '')
locale string (default '')
mouse bool (default false)
number bool (default false)
numberfmt string (default "\033[33m")
Expand Down Expand Up @@ -824,13 +824,11 @@ Format string of the file time shown in the info column when it matches this yea

Format string of the file time shown in the info column when it doesn't match this year.

## locale (string) (default `''`)
## locale (string) (default ``)

An IETF BCP 47 language tag (e.g. `zh-CN`) for specifying the locale used when using sort type
`natural` and `name`.
An IETF BCP 47 language tag (e.g. `zh-CN`) for specifying the locale used when using sort type `natural` and `name`.

An empty string means disable locale ordering, and the special value `'*'` is used
to indicate reading the locale setting from the system environment.
An empty string means disable locale ordering, and the special value `*` is used to indicate reading the locale setting from the system environment.

## mouse (bool) (default false)

Expand Down
16 changes: 13 additions & 3 deletions doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ The following options can be used to customize the behavior of lf:
info []string (default '')
infotimefmtnew string (default 'Jan _2 15:04')
infotimefmtold string (default 'Jan _2 2006')
locale string (default '')
mouse bool (default false)
number bool (default false)
numberfmt string (default "\033[33m")
Expand Down Expand Up @@ -878,6 +879,15 @@ infotimefmtold (string) (default Jan _2 2006)
Format string of the file time shown in the info column when it doesn't
match this year.

locale (string) (default ``)

An IETF BCP 47 language tag (e.g. zh-CN) for specifying the locale used
when using sort type natural and name.

An empty string means disable locale ordering, and the special value *
is used to indicate reading the locale setting from the system
environment.

mouse (bool) (default false)

Send mouse events as input.
Expand Down Expand Up @@ -1306,9 +1316,9 @@ string:

Command setlocal is used to set a local option for a directory which can
be a boolean or string. Currently supported local options are dirfirst,
dironly, hidden, info, reverse, and sortby. Adding a trailing path
separator (i.e. / for Unix and \ for Windows) sets the option for the
given directory along with its subdirectories:
dironly, hidden, info, reverse, sortby and locale. Adding a trailing
path separator (i.e. / for Unix and \ for Windows) sets the option for
the given directory along with its subdirectories:

setlocal /foo/bar hidden # boolean enable
setlocal /foo/bar hidden true # boolean enable
Expand Down
12 changes: 11 additions & 1 deletion lf.1
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ incsearch bool (default false)
info []string (default \[aq]\[aq])
infotimefmtnew string (default \[aq]Jan _2 15:04\[aq])
infotimefmtold string (default \[aq]Jan _2 2006\[aq])
locale string (default \[aq]\[aq])
mouse bool (default false)
number bool (default false)
numberfmt string (default \[dq]\[rs]033[33m\[dq])
Expand Down Expand Up @@ -895,6 +896,15 @@ this year.
.PP
Format string of the file time shown in the info column when it
doesn\[aq]t match this year.
.SS locale (string) (default \[ga]\[ga])
.PP
An IETF BCP 47 language tag (e.g.
\f[C]zh-CN\f[R]) for specifying the locale used when using sort type
\f[C]natural\f[R] and \f[C]name\f[R].
.PP
An empty string means disable locale ordering, and the special value
\f[C]*\f[R] is used to indicate reading the locale setting from the
system environment.
.SS mouse (bool) (default false)
.PP
Send mouse events as input.
Expand Down Expand Up @@ -1316,7 +1326,7 @@ Command \f[C]setlocal\f[R] is used to set a local option for a directory
which can be a boolean or string.
Currently supported local options are \f[C]dirfirst\f[R],
\f[C]dironly\f[R], \f[C]hidden\f[R], \f[C]info\f[R], \f[C]reverse\f[R],
and \f[C]sortby\f[R].
\f[C]sortby\f[R] and \f[C]locale\f[R].
Adding a trailing path separator (i.e.
\f[C]/\f[R] for Unix and \f[C]\[rs]\f[R] for Windows) sets the option
for the given directory along with its subdirectories:
Expand Down

0 comments on commit dda8e88

Please sign in to comment.