From 629a7f32974f6248d3fd8ed66a491aa01c0b0658 Mon Sep 17 00:00:00 2001 From: Gokcehan Date: Wed, 29 Aug 2018 19:28:22 +0300 Subject: [PATCH] update documentation --- doc.go | 8 ++++++-- docstring.go | 8 ++++++-- lf.1 | 10 ++++++++-- 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/doc.go b/doc.go index f134d214..daee9457 100644 --- a/doc.go +++ b/doc.go @@ -104,8 +104,8 @@ The following options can be used to customize the behavior of lf: reverse boolean (default off) smartcase boolean (default on) wrapscan boolean (default on) - findlen integer (default 1) - period integer (default 0) + findlen integer (default 1) (zero to prompt until single match) + period integer (default 0) (zero to disable periodic loading) scrolloff integer (default 0) tabstop integer (default 8) filesep string (default "\n") @@ -126,6 +126,10 @@ The following variables are exported for shell commands: $fx current file or selected file(s) if any $id id number of the client +The following variables are set to the corresponding values: + + $LF_LEVEL current nesting level + The following default values are set to the environmental variables on unix when they are not set or empty: diff --git a/docstring.go b/docstring.go index 2ce3d58e..96635f54 100644 --- a/docstring.go +++ b/docstring.go @@ -107,8 +107,8 @@ The following options can be used to customize the behavior of lf: reverse boolean (default off) smartcase boolean (default on) wrapscan boolean (default on) - findlen integer (default 1) - period integer (default 0) + findlen integer (default 1) (zero to prompt until single match) + period integer (default 0) (zero to disable periodic loading) scrolloff integer (default 0) tabstop integer (default 8) filesep string (default "\n") @@ -129,6 +129,10 @@ The following variables are exported for shell commands: $fx current file or selected file(s) if any $id id number of the client +The following variables are set to the corresponding values: + + $LF_LEVEL current nesting level + The following default values are set to the environmental variables on unix when they are not set or empty: diff --git a/lf.1 b/lf.1 index 72454cc2..3fd729d1 100644 --- a/lf.1 +++ b/lf.1 @@ -119,8 +119,8 @@ The following options can be used to customize the behavior of lf: reverse boolean (default off) smartcase boolean (default on) wrapscan boolean (default on) - findlen integer (default 1) - period integer (default 0) + findlen integer (default 1) (zero to prompt until single match) + period integer (default 0) (zero to disable periodic loading) scrolloff integer (default 0) tabstop integer (default 8) filesep string (default "\en") @@ -144,6 +144,12 @@ The following variables are exported for shell commands: $id id number of the client .EE .PP +The following variables are set to the corresponding values: +.PP +.EX + $LF_LEVEL current nesting level +.EE +.PP The following default values are set to the environmental variables on unix when they are not set or empty: .PP .EX