From 52fad02903468c05d2422a340ad8dbcdf18ed475 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Fri, 28 Feb 2020 13:31:38 -0800 Subject: [PATCH] doc update --- docs/parsers/ls.md | 12 ++++++------ jc/parsers/ls.py | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index bdf47299..d1f4ba3e 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -1,9 +1,9 @@ # jc.parsers.ls jc - JSON CLI output utility ls Parser -Note: The -l option of ls should be used to correctly parse filenames that include newline characters. +Note: The -l or -b option of ls should be used to correctly parse filenames that include newline characters. Since ls does not encode newlines in filenames when outputting to a pipe it will cause jc to see - multiple files instead of a single file if -l is not used. + multiple files instead of a single file if -l or -b is not used. Usage: @@ -11,11 +11,11 @@ Usage: ls options supported: - -laR + -lbaR --time-style=full-iso - -h file sizes will be available in text form with -r but larger file sizes - with human readable suffixes will be converted to Null in default view - since the parser attempts to convert this field to an integer. + -h file sizes will be available in text form with -r but larger file sizes + with human readable suffixes will be converted to Null in default view + since the parser attempts to convert this field to an integer. Compatibility: diff --git a/jc/parsers/ls.py b/jc/parsers/ls.py index b1ec6c2d..b81571a0 100644 --- a/jc/parsers/ls.py +++ b/jc/parsers/ls.py @@ -1,8 +1,8 @@ """jc - JSON CLI output utility ls Parser -Note: The -l option of ls should be used to correctly parse filenames that include newline characters. +Note: The -l or -b option of ls should be used to correctly parse filenames that include newline characters. Since ls does not encode newlines in filenames when outputting to a pipe it will cause jc to see - multiple files instead of a single file if -l is not used. + multiple files instead of a single file if -l or -b is not used. Usage: @@ -10,11 +10,11 @@ Usage: ls options supported: - -laR + -lbaR --time-style=full-iso - -h file sizes will be available in text form with -r but larger file sizes - with human readable suffixes will be converted to Null in default view - since the parser attempts to convert this field to an integer. + -h file sizes will be available in text form with -r but larger file sizes + with human readable suffixes will be converted to Null in default view + since the parser attempts to convert this field to an integer. Compatibility: