GNU bug report logs - #75916
Making ls(1)'s --format clearer

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: coreutils; Reported by: Samuel Thibault <samuel.thibault@HIDDEN>; Done: Pádraig Brady <P@HIDDEN>; Maintainer for coreutils is bug-coreutils@HIDDEN.
bug closed, send any further explanations to 75916 <at> debbugs.gnu.org and Samuel Thibault <samuel.thibault@HIDDEN> Request was from Pádraig Brady <P@HIDDEN> to control <at> debbugs.gnu.org. Full text available.

Message received at 75916 <at> debbugs.gnu.org:


Received: (at 75916) by debbugs.gnu.org; 28 Jan 2025 20:25:10 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 28 15:25:10 2025
Received: from localhost ([127.0.0.1]:38791 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tcs90-0007bv-1t
	for submit <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:25:10 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10]:46938)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <samuel.thibault@HIDDEN>)
 id 1tcs8w-0007WZ-RP
 for 75916 <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:25:07 -0500
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <samuel.thibault@HIDDEN>)
 id 1tcs8p-0003vC-GN; Tue, 28 Jan 2025 15:25:00 -0500
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=In-Reply-To:MIME-Version:References:Subject:To:From:
 Date; bh=pY9a8P64QP0wvaODLOz05aGtnw81z/bxZiFoJjky/sM=; b=ONkwpNIcksUfDpIKCC2x
 Fn7YQ9dBvROxF1lzJKxSGuuXiZKiztCtW1yWacerLtU5T05LSTM4zs7rPUO+3uIqGqVj/pfT6Hjzh
 sxAWuviJg+ynsX6c+uyNEY2VDJfZS4YXT08vlATuRiNkJdGLHGPPwwxRcy8RxIMWgYQM6ofyoIT7k
 YpXRDvCNlx979Of67N/22e35w5xuWh7iqZ1kntyGr2e3jdNv8bJDqeMW1wElQzHHSiR+L56z5o618
 Pic2d4+JHMH+cNs8yyGkLO7ZeBfL7azWu/xf5wUNg826R8q/vvHaf/1rO6yQ7RTpQKztVcaQrSVAx
 X/YINMlHGWzJHQ==;
Date: Tue, 28 Jan 2025 21:24:57 +0100
From: Samuel Thibault <samuel.thibault@HIDDEN>
To: =?utf-8?Q?P=C3=A1draig?= Brady <P@HIDDEN>
Subject: Re: bug#75916: Making ls(1)'s --format clearer
Message-ID: <Z5k9GQDemfqf-8ty@begin>
References: <Z5k3ZR6vggR1l5Wm@begin>
 <15375f78-a8f3-498b-9439-34b202a43412@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <15375f78-a8f3-498b-9439-34b202a43412@HIDDEN>
Organization: I am not organized
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 75916
Cc: 75916 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

Pádraig Brady, le mar. 28 janv. 2025 20:20:54 +0000, a ecrit:
> On 28/01/2025 20:00, Samuel Thibault wrote:
> > ls(1) says this about --format:
> > 
> > --format=WORD
> >         across  -x,  commas -m, horizontal -x, long -l, single-column -1,
> >         verbose -l, vertical -C
> > 
> > It was not clear at all for my students (and not for me either,
> > actually), that it's the words that should be used, and not the letters.
> > 
> > The attached patch makes this much more explicit:
> > 
> > --format=WORD where WORD can be
> >         across  (like  -x),  commas (like -m), horizontal (like -x), long
> >         (like -l), single-column (like -1), verbose (like  -l),  vertical
> >         (like -C)
> 
> Right. It might suffice just to add the parentheses,
> and then the description would be of consistent form with:
> 
>   --sort=WORD          sort by WORD instead of name: none (-U), size  (-S),  time  (-t),
>           version (-v), extension (-X), width
> 
> 
>   --indicator-style=WORD
>           append  indicator with style WORD to entry names: none (default),
>           slash (-p), file-type (--file-type), classify (-F)
> 
> I'll adjust accordingly and push if you agree.

Sure, thanks!

Samuel




Information forwarded to bug-coreutils@HIDDEN:
bug#75916; Package coreutils. Full text available.

Message received at 75916 <at> debbugs.gnu.org:


Received: (at 75916) by debbugs.gnu.org; 28 Jan 2025 20:21:07 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 28 15:21:07 2025
Received: from localhost ([127.0.0.1]:38778 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tcs54-0007Ph-NQ
	for submit <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:21:06 -0500
Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:50600)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.84_2) (envelope-from <pixelbeat@HIDDEN>)
 id 1tcs52-0007Oq-Bk
 for 75916 <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:21:04 -0500
Received: by mail-wr1-x42b.google.com with SMTP id
 ffacd0b85a97d-386329da1d9so3205588f8f.1
 for <75916 <at> debbugs.gnu.org>; Tue, 28 Jan 2025 12:21:04 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1738095657; x=1738700457; darn=debbugs.gnu.org;
 h=content-transfer-encoding:in-reply-to:from:content-language
 :references:to:subject:user-agent:mime-version:date:message-id
 :sender:from:to:cc:subject:date:message-id:reply-to;
 bh=WH2FvrAHTn059WFnoVfqhu0So++/rB6hjB0fZW6C0KM=;
 b=K+VRrp7mxmbiRMA5ajMigkPHZ8vYnigqVRmMk/Vi9IT6bBiMov85H9aOboD0YUmMZl
 VuEckrxHlcSsruD9LH+YmT/2TglLyyhyWjFFM1CWHZZXdlifGlh8/1Vs7oTSvonYOw7I
 jkcBzP3Acp0dEAlvSwamU7Y27RNK5ryvY+LyA8YoAaVM+IhOEJcnF6gGqgXSS4C75zoO
 iI90Ad1eJ5KkkubWYEWqiEogSpuO3Ess9CHpGL+9DHyVV2dJurgRKeeJq61s15Euhw0Y
 FKSCljUFm1zKeKZZG8rX05SxuaidCnb7Hc/q/fCvwSQJnspKGy95mCU2S1+NdwYh0ygV
 kRKg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1738095657; x=1738700457;
 h=content-transfer-encoding:in-reply-to:from:content-language
 :references:to:subject:user-agent:mime-version:date:message-id
 :sender:x-gm-message-state:from:to:cc:subject:date:message-id
 :reply-to;
 bh=WH2FvrAHTn059WFnoVfqhu0So++/rB6hjB0fZW6C0KM=;
 b=lfP9HtRTEsJxv9T1Qi6y4R6sHQfUQ6ZtGgofvmcrBhjMXqWHSA1meK+hsQ4hvT4VUQ
 vCee/YHrgSIQ0N2UasCncN5fgOrtaAAd4Usi5a0TYSJ9SxbvuFMWda1Ojh63z1+JgE9z
 qkUkqxbUeAEIwqIu6FJQjLtWlstP+lkeTXda7y30RLV8S2QLurNEtSKXnwDo53UjC+Jh
 QvVejJFpJmbPzhRh//XJ/FmiksUb7wcev2MltHS3NsYX/c3zQk3WlfQHL+/FbnxVg3cO
 DXiTyD9q5buJkGRhU2pbBmkZLMNVqBWE7hVfWz/IbDwuQ8yR5MikF8DCeIZ3h0L3JuGx
 ZmXg==
X-Forwarded-Encrypted: i=1;
 AJvYcCX38j3ljcd16Z7o6CBSyvwJys7nlcFnOCxGYCAp6JocLvdzpAEvJvZUdnyFCud85p3HxjZumw==@debbugs.gnu.org
X-Gm-Message-State: AOJu0YxXnosZIz5V+aiD98L2+AeApoBhGvtreJkfK3nuULr26XgGSha7
 v4QySeQ703A+QHzviwDeY927eSQ9ooZPBwX5GJicIQpSnG5OS7AnB/oYag==
X-Gm-Gg: ASbGnctvJP2TGTgqbq8e2vgQagyTaU2Vl6ytPxU8z4DPgjPfZnJAefXhCA4sXOTtxBg
 2169eyi8tHBpg8ZjRWzmNE4LSaAiAKorvA0Bt6OpQvTCyZvZ05dKnqKl/nvBmQhUipVYNpmsyT6
 ByEe38TaPbk9ofvoRWbozEIYImRJRa6FbKCO/mMxcTCvVbRSk3h7+DyFIIJ7xaYLuz8hTal6WRI
 oCEFI53RejPIN1MjvNpFZSoZn9Ehlf6lblJzzvplsKP5Tauk8HHrmrAjVlm4FwBb2hZdZlASfiq
 XwKsQ8GoTkRY5CBI8ftyLl8RZuf5SO7578arW8p2GQRvYgoiso0LOWm5AlAZA5VckDSHNIg=
X-Google-Smtp-Source: AGHT+IGpEahkhnEZL9qzlU1wGPrP6Lbn3AjDYrweOeDmCp19VpuxneBTWkDFzrDh97bLXLQ/k3n/oQ==
X-Received: by 2002:a5d:6305:0:b0:38a:9ed4:9fff with SMTP id
 ffacd0b85a97d-38c520b9bbamr259521f8f.51.1738095657156; 
 Tue, 28 Jan 2025 12:20:57 -0800 (PST)
Received: from [192.168.1.31]
 (86-44-211-146-dynamic.agg2.lod.rsl-rtd.eircom.net. [86.44.211.146])
 by smtp.googlemail.com with ESMTPSA id
 ffacd0b85a97d-38c2a1c4212sm14566416f8f.87.2025.01.28.12.20.56
 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128);
 Tue, 28 Jan 2025 12:20:56 -0800 (PST)
Message-ID: <15375f78-a8f3-498b-9439-34b202a43412@HIDDEN>
Date: Tue, 28 Jan 2025 20:20:54 +0000
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird Beta
Subject: Re: bug#75916: Making ls(1)'s --format clearer
To: Samuel Thibault <samuel.thibault@HIDDEN>, 75916 <at> debbugs.gnu.org
References: <Z5k3ZR6vggR1l5Wm@begin>
Content-Language: en-US
From: =?UTF-8?Q?P=C3=A1draig_Brady?= <P@HIDDEN>
In-Reply-To: <Z5k3ZR6vggR1l5Wm@begin>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 75916
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

On 28/01/2025 20:00, Samuel Thibault wrote:
> Hello,
> 
> ls(1) says this about --format:
> 
> --format=WORD
>         across  -x,  commas -m, horizontal -x, long -l, single-column -1,
>         verbose -l, vertical -C
> 
> It was not clear at all for my students (and not for me either,
> actually), that it's the words that should be used, and not the letters.
> 
> The attached patch makes this much more explicit:
> 
> --format=WORD where WORD can be
>         across  (like  -x),  commas (like -m), horizontal (like -x), long
>         (like -l), single-column (like -1), verbose (like  -l),  vertical
>         (like -C)

Right. It might suffice just to add the parentheses,
and then the description would be of consistent form with:

   --sort=WORD          sort by WORD instead of name: none (-U), size  (-S),  time  (-t),
           version (-v), extension (-X), width


   --indicator-style=WORD
           append  indicator with style WORD to entry names: none (default),
           slash (-p), file-type (--file-type), classify (-F)

I'll adjust accordingly and push if you agree.

cheers,
Pádraig




Information forwarded to bug-coreutils@HIDDEN:
bug#75916; Package coreutils. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 28 Jan 2025 20:01:07 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Jan 28 15:01:06 2025
Received: from localhost ([127.0.0.1]:38733 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tcrli-0006SU-GV
	for submit <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:01:06 -0500
Received: from lists.gnu.org ([2001:470:142::17]:54198)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <samuel.thibault@HIDDEN>)
 id 1tcrlf-0006Rn-O6
 for submit <at> debbugs.gnu.org; Tue, 28 Jan 2025 15:01:04 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <samuel.thibault@HIDDEN>)
 id 1tcrlS-0005PV-DX
 for bug-coreutils@HIDDEN; Tue, 28 Jan 2025 15:00:55 -0500
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <samuel.thibault@HIDDEN>)
 id 1tcrlS-0008UO-5j
 for bug-coreutils@HIDDEN; Tue, 28 Jan 2025 15:00:50 -0500
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=MIME-Version:Subject:To:From:Date:in-reply-to:
 references; bh=VqdnCHJwR7jtQB8jbzZ0wJ07si2EOQqwojU4FFU317w=; b=W4tRJbqWv+dSWP
 5ModnHwWQKeDbJR8SqMPekihnSs5SREG6ppE5uYJm/vKsfGC6VKpHiYta8Wza5mbcTRD0syC4aggG
 CWj1yvvHMBxZilNVQ6CT8U2jYFKImmUQNilSS7BYpfTb9srUN+46R2PtR2wf/9VnaB00w/ubrrc7w
 6z4v9MwliJtBNhzq6VCHIBCiedo4qu1LNGWDAE0Tun0ykbdOvVe0cdQ6zw3Szcdu8SWKgDjHM7vuG
 JThIFtFRKvyJ/yUrzyyWy6F1uK8uByJrS0KeIQ3GdL/NAReX7w7r/kS9E+uh4HrR7MRh6TeOCSs06
 /+KgF9Eiq3VYtTs4nNXw==;
Date: Tue, 28 Jan 2025 21:00:37 +0100
From: Samuel Thibault <samuel.thibault@HIDDEN>
To: bug-coreutils@HIDDEN
Subject: Making ls(1)'s --format clearer
Message-ID: <Z5k3ZR6vggR1l5Wm@begin>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="CAxbdmkJuCVjkpJt"
Content-Disposition: inline
Organization: I am not organized
X-Spam-Score: -0.0 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)


--CAxbdmkJuCVjkpJt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Hello,

ls(1) says this about --format:

--format=WORD
       across  -x,  commas -m, horizontal -x, long -l, single-column -1,
       verbose -l, vertical -C

It was not clear at all for my students (and not for me either,
actually), that it's the words that should be used, and not the letters.

The attached patch makes this much more explicit:

--format=WORD where WORD can be
       across  (like  -x),  commas (like -m), horizontal (like -x), long
       (like -l), single-column (like -1), verbose (like  -l),  vertical
       (like -C)

Samuel

--CAxbdmkJuCVjkpJt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=patch

--- ./man/ls.1.original	2025-01-28 20:51:07.959926088 +0100
+++ ./man/ls.1	2025-01-28 20:58:01.681557095 +0100
@@ -59,9 +59,11 @@
 \fB\-\-file\-type\fR
 likewise, except do not append '*'
 .TP
-\fB\-\-format\fR=\fI\,WORD\/\fR
-across \fB\-x\fR, commas \fB\-m\fR, horizontal \fB\-x\fR, long \fB\-l\fR,
-single\-column \fB\-1\fR, verbose \fB\-l\fR, vertical \fB\-C\fR
+\fB\-\-format\fR=\fI\,WORD\/\fR where WORD can be
+\fBacross\fR (like \fB\-x\fR), \fBcommas\fR (like \fB\-m\fR),
+\fBhorizontal\fR (like \fB\-x\fR), \fBlong\fR (like \fB\-l\fR),
+\fBsingle\-column\fR (like \fB\-1\fR), \fBverbose\fR (like \fB\-l\fR),
+\fBvertical\fR (like \fB\-C\fR)
 .TP
 \fB\-\-full\-time\fR
 like \fB\-l\fR \fB\-\-time\-style\fR=\fI\,full\-iso\/\fR

--CAxbdmkJuCVjkpJt--




Acknowledgement sent to Samuel Thibault <samuel.thibault@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-coreutils@HIDDEN. Full text available.
Report forwarded to bug-coreutils@HIDDEN:
bug#75916; Package coreutils. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Wed, 29 Jan 2025 11:45:01 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.