version v1.0.0

nlnwa · May 2, 2023 · ca8221d · ca8221d
1 parent 856ec9e
commit ca8221d
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 28 deletions.
diff --git a/docs/content/cmd/warc.md b/docs/content/cmd/warc.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc"
 slug: warc
 url: /cmd/warc/
@@ -11,7 +11,7 @@ A tool for handling warc files
 ### Options
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
   -h, --help                    help for warc
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])

diff --git a/docs/content/cmd/warc_cat.md b/docs/content/cmd/warc_cat.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc cat"
 slug: warc_cat
 url: /cmd/warc_cat/
@@ -29,11 +29,11 @@ warc cat -n4 -P file1.warc.gz | feh -
   -h, --help                   help for cat
       --id stringArray         filter record ID's. For more than one, repeat flag or comma separated list.
   -m, --mime-type strings      filter records with given mime-types. For more than one, repeat flag or comma separated list.
-  -n, --num int                print the n'th record. This is applied after records are filtered out by other options (default -1)
-  -o, --offset int             print record at offset bytes (default -1)
+  -n, --num int                print the n'th record (zero based). This is applied after records are filtered out by other options (default -1)
+  -o, --offset int             record offset (default -1)
   -P, --payload                show payload
   -p, --protocol-header        show protocol header
-  -c, --record-count int       The maximum number of records to show. Defaults to show all records except if -o or -n option is set, then default is one.
+  -c, --record-count int       The maximum number of records to show Defaults to show all records except if -o or -n option is set, then default is one.
   -t, --record-type strings    filter record types. For more than one, repeat flag or comma separated list.
                                Legal values: warcinfo,request,response,metadata,revisit,resource,continuation,conversion
   -S, --response-code string   filter records with given http response codes. Format is 'from-to' where from is inclusive and to is exclusive.
@@ -47,7 +47,7 @@ warc cat -n4 -P file1.warc.gz | feh -
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_completion.md b/docs/content/cmd/warc_completion.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc completion"
 slug: warc_completion
 url: /cmd/warc_completion/
@@ -63,7 +63,7 @@ warc completion [bash|zsh|fish|powershell]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_console.md b/docs/content/cmd/warc_console.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc console"
 slug: warc_console
 url: /cmd/warc_console/
@@ -22,7 +22,7 @@ warc console <directory> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_convert.md b/docs/content/cmd/warc_convert.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc convert"
 slug: warc_convert
 url: /cmd/warc_convert/
@@ -17,7 +17,7 @@ Convert web archives to warc files. Use subcommands for the supported formats
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_convert_arc.md b/docs/content/cmd/warc_convert_arc.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc convert arc"
 slug: warc_convert_arc
 url: /cmd/warc_convert_arc/
@@ -20,7 +20,7 @@ warc convert arc <files/dirs> [flags]
   -c, --concurrency int          number of input files to process simultaneously. The default value is 1.5 x <number of cpu cores> (default 24)
   -C, --concurrent-writers int   maximum concurrent WARC writers. This is the number of WARC-files simultaneously written to.
                                  A consequence is that at least this many WARC files are created even if there is only one input file. (default 1)
-  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-3-6")
+  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-5-2")
   -S, --file-size int            The maximum size for WARC files (default 1073741824)
       --flush                    if true, sync WARC file to disk after writing each record
   -h, --help                     help for arc
@@ -49,7 +49,7 @@ warc convert arc <files/dirs> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_convert_nedlib.md b/docs/content/cmd/warc_convert_nedlib.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc convert nedlib"
 slug: warc_convert_nedlib
 url: /cmd/warc_convert_nedlib/
@@ -20,7 +20,7 @@ warc convert nedlib <files/dirs> [flags]
   -c, --concurrency int          number of input files to process simultaneously. The default value is 1.5 x <number of cpu cores> (default 24)
   -C, --concurrent-writers int   maximum concurrent WARC writers. This is the number of WARC-files simultaneously written to.
                                  A consequence is that at least this many WARC files are created even if there is only one input file. (default 1)
-  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-3-6")
+  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-5-2")
   -S, --file-size int            The maximum size for WARC files (default 1073741824)
       --flush                    if true, sync WARC file to disk after writing each record
   -h, --help                     help for nedlib
@@ -47,7 +47,7 @@ warc convert nedlib <files/dirs> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_convert_warc.md b/docs/content/cmd/warc_convert_warc.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc convert warc"
 slug: warc_convert_warc
 url: /cmd/warc_convert_warc/
@@ -25,7 +25,7 @@ warc convert warc <files/dirs> [flags]
   -c, --concurrency int          number of input files to process simultaneously. The default value is 1.5 x <number of cpu cores> (default 24)
   -C, --concurrent-writers int   maximum concurrent WARC writers. This is the number of WARC-files simultaneously written to.
                                  A consequence is that at least this many WARC files are created even if there is only one input file. (default 1)
-  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-3-6")
+  -t, --default-date string      fetch date to use for records missing date metadata. Fetchtime is set to 12:00 UTC for the date (default "2023-5-2")
   -S, --file-size int            The maximum size for WARC files (default 1073741824)
       --flush                    if true, sync WARC file to disk after writing each record
   -h, --help                     help for warc
@@ -56,7 +56,7 @@ warc convert warc <files/dirs> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_dedup.md b/docs/content/cmd/warc_dedup.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc dedup"
 slug: warc_dedup
 url: /cmd/warc_dedup/
@@ -67,7 +67,7 @@ warc dedup [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_ls.md b/docs/content/cmd/warc_ls.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc ls"
 slug: warc_ls
 url: /cmd/warc_ls/
@@ -66,7 +66,7 @@ warc ls <files/dirs> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file

diff --git a/docs/content/cmd/warc_validate.md b/docs/content/cmd/warc_validate.md
@@ -1,5 +1,5 @@
 ---
-date: 2023-03-06T12:35:33+01:00
+date: 2023-05-02T10:06:41+02:00
 title: "warc validate"
 slug: warc_validate
 url: /cmd/warc_validate/
@@ -25,7 +25,7 @@ warc validate <files/dirs> [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string           config file. If not set, /etc/warc/, $HOME/.warc/ and current working dir will be searched for file config.yaml
+      --config string           config file. If not set, /etc/xdg/warc, /home/johnh/.config/warc and the current directory will be searched for a file named 'config.yaml'
       --log-console strings     the kind of log output to write to console. Valid values: info, error, summary, progress (default [progress,summary])
       --log-file strings        the kind of log output to write to file. Valid values: info, error, summary (default [info,error,summary])
   -L, --log-file-name string    a file to write log output. Empty for no log file