diff --git a/404.html b/404.html index 82ad28a..2c3f1e1 100644 --- a/404.html +++ b/404.html @@ -97,7 +97,7 @@ diff --git a/config.html b/config.html index 74f69ac..b025ccf 100644 --- a/config.html +++ b/config.html @@ -95,7 +95,7 @@ @@ -170,21 +170,22 @@ format called config.toml.

The configuration file path follows OS conventions (e.g. $XDG_CONFIG_HOME/tealdeer/config.toml on Linux). The paths can be queried with the following command:

-
$ tldr --show-paths
+
$ tldr --show-paths
 

 
Creating the config file can be done manually or with the help of tldr:

-
$ tldr --seed-config
+
$ tldr --seed-config
 

 
On Linux, this will usually be ~/.config/tealdeer/config.toml.

 
Config Example

 
Here's an example configuration file. Note that this example does not contain
 all possible config options. For details on the things that can be configured,
 please refer to the subsections of this documentation page
-(display, style,
+(display, style, search,
 updates or directories).

 
[display]
 compact = false
 use_pager = true
+show_title = false
 
 [style.command_name]
 foreground = "red"
diff --git a/config_directories.html b/config_directories.html
index eff8082..75c36b2 100644
--- a/config_directories.html
+++ b/config_directories.html
@@ -95,7 +95,7 @@
 
         
@@ -169,7 +169,7 @@
 
Override the cache directory. Remember to use an absolute path. Variable
 expansion will not be performed on the path. If the directory does not yet
 exist, it will be created.

-
[directories]
+
[directories]
 cache_dir = "/home/myuser/.tealdeer-cache/"
 

 
If no cache_dir is specified, tealdeer will fall back to a location that
@@ -179,7 +179,7 @@ Use tldr --show-paths to show the path that is being used.

 
Set the directory to be used to look up custom
 pages. Remember to use an absolute path. Variable
 expansion will not be performed on the path.

-
[directories]
+
[directories]
 custom_pages_dir = "/home/myuser/custom-tldr-pages/"
 

 
diff --git a/config_display.html b/config_display.html
index 26530d3..4b51695 100644
--- a/config_display.html
+++ b/config_display.html
@@ -95,7 +95,7 @@
 
         
@@ -167,7 +167,7 @@
 
In the display section you can configure the output format.

 
use_pager

 
Specifies whether the pager should be used by default or not (default false).

-
[display]
+
[display]
 use_pager = true
 

 
When enabled, less -R is used as pager. To override the pager command used,
@@ -176,9 +176,16 @@ set the PAGER environment variable.

 
compact

 
Set this to enforce more compact output, where empty lines are stripped out
 (default false).

-
[display]
+
[display]
 compact = true
 

+
show_title

+
Display the command name at the top of the page output (default false).

+
[display]
+show_title = true
+

+
When enabled, the command name will be displayed at the top of the output,
+styled with the command_name style configuration.

 
                     
 
diff --git a/config_search.html b/config_search.html
new file mode 100644
index 0000000..4143aa2
--- /dev/null
+++ b/config_search.html
@@ -0,0 +1,259 @@
+
+
+    
+        
+        
+        Section: [search] - Tealdeer User Manual
+        
+        
+
+
+        
+        
+
+
+        
+        
+        
+        
+
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+
+        
+        
+        
+        
+        
+
+        
+        
+        
+        
+
+        
+        
+
+        
+    
+    
+        
+        
+
+        
+        
+
+        
+        
+
+        
+        
+
+        
+
+        

+
+            

+                
+                
+                
+
+                
+                
+                
+
+                
+                
+
+                

+                    

+                        
Section: [search]

+
This config section is used to configure the page search in the cache.
+The settings apply to tldr <page> and tldr --list.

+
languages

+
The list of languages that should be considered when searching.
+If unspecified, the list of languages will be inferred from the LANG and LANGUAGE environment variables.
+Either way, the language used can be overwritten using the --language command line flag.

+
[search]
+# Show pages in German if available, otherwise show in English
+languages = ["de", "en"]
+

+
platforms

+
The list of platforms that should be considered when searching.
+In addition to the platforms listed in the help text of the --platform flag, there are two special platforms available:

+
    
+
  • "current": equals the platform that tealdeer was compiled for
    • 
+
  • "all": adds all remaining platforms to the list
    • 
+

+
Tealdeer searches the platforms in order of appearance in this list.
+The default list of platforms is ["current", "common", "all"].
+The list of platforms can be overwritten using the --platform command line flag.

+
[search]
+# Search for linux and common, and then search windows before trying the remaining platforms
+platforms = ["linux", "common", "windows", "all"]
+

+
+                    

+
+                    
+                

+            

+
+            
+
+        

+
+        
+
+        
+
+        
+
+        
+        
+        
+
+        
+
+        
+        
+        
+        
+        
+
+        
+        
+        
+
+        
+        
+
+        
+
+    
+
diff --git a/config_style.html b/config_style.html
index 532cb6e..4c1160c 100644
--- a/config_style.html
+++ b/config_style.html
@@ -95,7 +95,7 @@
 
         
@@ -187,19 +187,19 @@
 
  • 
 
    Color string (black, red, green, yellow, blue, magenta, cyan, white):
    
 
    Example:
    
-
    foreground = "green"
+
    foreground = "green"
 
    
 
    • 
 
  • 
 
    256 color ANSI code (tealdeer v1.5.0+)
    
 
    Example:
    
-
    foreground = { ansi = 4 }
+
    foreground = { ansi = 4 }
 
    
 
    • 
 
  • 
 
    24-bit RGB color (tealdeer v1.5.0+)
    
 
    Example:
    
-
    background = { rgb = { r = 255, g = 255, b = 255 } }
+
    background = { rgb = { r = 255, g = 255, b = 255 } }
 
    
 
    • 
 
@@ -215,7 +215,7 @@
                         
 
                         
-                            
                         
@@ -233,7 +233,7 @@
                 
 
                 
-                    
                 
diff --git a/config_updates.html b/config_updates.html
index 1e5540e..ef88f02 100644
--- a/config_updates.html
+++ b/config_updates.html
@@ -95,7 +95,7 @@
 
         
@@ -164,6 +164,7 @@
                 
    
                     
    
                         
    Section: [updates]
    
+
    This config section contains settings related to updating the tealdeer cache.
    
 
    Automatic updates
    
 
    Tealdeer can refresh the cache automatically when it is outdated. This
 behavior can be configured in the updates section and is disabled by
@@ -171,16 +172,52 @@ default.
    
 
    auto_update
    
 
    Specifies whether the auto-update feature should be enabled (defaults to
 false).
    
-
    [updates]
+
    [updates]
 auto_update = true
 
    
 
    auto_update_interval_hours
    
 
    Duration, since the last cache update, after which the cache will be
 refreshed (defaults to 720 hours). This parameter is ignored if auto_update
 is set to false.
    
-
    [updates]
+
    [updates]
 auto_update = true
 auto_update_interval_hours = 24
+
    
+
    Download configuration
    
+
    download_languages
    
+
    The list of languages which should be downloaded when updating.
+If unspecified, the languages listed in the search.languages setting are used.
+Thus, this setting is the most useful to instruct tealdeer to download pages in additional languages that are not searched by default.
+Either way, the language used can be overwritten using the --language command line flag.
    
+
    [search]
+languages = ["de", "en"]
+
+[updates]
+# sometimes I like to read the Italian description
+download_languages = ["de", "en", "it"]
+
    
+
    archive_source
    
+
    URL for the location of the tldr pages archive. By default the pages are
+fetched from the latest tldr-pages/tldr GitHub release.
    
+
    [updates]
+archive_source = "https://my-company.example.com/tldr/"
+
    
+
    tls_backend
    
+
    Specifies which TLS backend to use. Try changing this setting if you encounter certificate errors.
    
+
    Available options:
    
+
      
+
    • rustls-with-native-roots - Rustls (a TLS library in Rust) with native roots
      • 
+
    • rustls-with-webpki-roots - Rustls with WebPKI roots
      • 
+
    • native-tls - Native TLS
+
        
+
      • SChannel on Windows
        • 
+
      • Secure Transport on macOS
        • 
+
      • OpenSSL on other platforms
        • 
+
      
+
      • 
+
    
+
    [updates]
+tls_backend = "native-tls"
 
    
 
                     
    
@@ -188,7 +225,7 @@ auto_update_interval_hours = 24