Ls — Mediated Wiki

{{Short description|Shell command for listing files}} {{about|the Unix-style command line shell directory listing command|other uses|LS (disambiguation){{!}}LS}} {{redirect|ls(1)|similarly named topics|LS1 (disambiguation)}} {{Lowercase title}} {{Infobox software | name = ls | screenshot = Ls --color=auto -ls linux.png | caption = Long file listing with <code>ls --color=auto -l</code> in Linux showing various modes, date formats, colors and appended indicators (executables and directories). | author = coreutils: Richard Stallman and David MacKenzie | developer = Various open-source and commercial developers | programming language = C | operating system = Multics, Unix, Unix-like, Plan 9, Inferno, MSX-DOS | genre = Command | license = coreutils: GPLv3+ BusyBox: GPL-2.0-only Toybox: 0BSD Plan 9: MIT License | website = }}

'''<code>ls</code>''' is a shell command for listing files {{endash}} including special files such as directories. Originally developed for Unix and later codified by POSIX and Single UNIX Specification, it is supported in many operating systems today, including Unix-like variants, Windows (via PowerShell and UnxUtils),<ref>{{Cite web|url=https://unxutils.sourceforge.net/|title=Native Win32 ports of some GNU utilities|website=unxutils.sourceforge.net|access-date=2025-08-09|archive-date=2006-02-09|archive-url=https://web.archive.org/web/20060209022842/http://unxutils.sourceforge.net/|url-status=live}}</ref> EFI,<ref name="EFI-Shells-and-Scripting">{{cite web |title=EFI Shells and Scripting |url=http://software.intel.com/en-us/articles/efi-shells-and-scripting/ |url-status=deviated |archive-url=https://web.archive.org/web/20130927203229/http://software.intel.com/en-us/articles/efi-shells-and-scripting/ |archive-date=September 27, 2013 |access-date=2013-09-25 |publisher=Intel}}</ref> and MSX-DOS (via MSX-DOS2 Tools).<ref>{{Cite web|url=https://archive.org/details/MSXDOS2TOOLS|title=MSX-DOS2 Tools User's Manual - MSX-DOS2 TOOLS ユーザーズマニュアル|date=April 1, 1993|via=Internet Archive}}</ref>

The numerical computing environments MATLAB and GNU Octave include an <code>ls</code> command with similar functionality.<ref>{{Cite web|url=https://www.mathworks.com/help/matlab/ref/ls.html|title=List folder contents - MATLAB ls|access-date=2019-04-06|archive-date=2012-10-09|archive-url=https://web.archive.org/web/20121009233800/https://www.mathworks.com/help/matlab/ref/ls.html|url-status=live}}</ref><ref>{{Cite web |title=Function Reference: Ls |url=https://octave.sourceforge.io/octave/function/ls.html |website=Octave Forge |access-date=2019-04-06 |archive-date=2019-04-06 |archive-url=https://web.archive.org/web/20190406171041/https://octave.sourceforge.io/octave/function/ls.html |url-status=live }}</ref>

An <code>ls</code> command appeared in the first version of AT&T UNIX. The name inherited from Multics and is short for "list".<ref>{{Cite web |date=14 February 1985 |title=Multics manual page for ls or list command |url=https://web.mit.edu/multics-history/source/Multics/doc/info_segments/list.info}}</ref><ref>{{cite web |url=https://tldp.org/LDP/LG/issue48/fischer.html |title=A Brief History of the 'ls' command |first=Eric |last=Fischer |website=The Linux Documentation Project |access-date=2022-12-09 |archive-date=2023-01-02 |archive-url=https://web.archive.org/web/20230102040116/https://tldp.org/LDP/LG/issue48/fischer.html |url-status=live }}</ref><ref>{{cite web | url = http://bitsavers.org/pdf/honeywell/large_systems/multics/AG92-03A_multicsCmds_Feb80.pdf | title = Multics programmer's manual - Commands and active functions | page = 397 }}</ref> {{code|ls}} is part of the X/Open Portability Guide since issue 2 of 1987. It was inherited into the first version of POSIX.1 and the Single Unix Specification.<ref>{{man|cu|ls|SUS}}</ref>

In MS-DOS, OS/2, and Windows, the equivalent command is <code>dir</code>. Apple DOS for the Apple II uses {{code|CATALOG}}.

== Behavior == When invoked with no path argument, <code>ls</code> lists the files of the working directory. Otherwise, it includes each specified file and each file of a specified directory.

Common options include:

* {{code|-a}} Includes '''a'''ll files, even those starting with <code>.</code>, which on Unix-based systems are otherwise not included * {{code|-A}} Same as {{code|-a}}, but excludes the special entries <code>.</code> (working directory) and <code>..</code> (parent of working directory) * <code>-l</code> Selects the '''l'''ong output format which extends the default output of the file name with additional information including type (<code>-</code> for regular file, <code>d</code> for directory, <code>l</code> for symbolic link, <code>n</code> for network file, <code>s</code> for socket, <code>p</code> for named pipe (FIFO), <code>c</code> for character special file, <code>b</code>for block special file), permissions, hard link count, owning user and group, size, last-modified timestamp * <code>-h</code> Output sizes as so-called '''h'''uman readable by using units of KB, MB, GB instead of bytes. This option is not part of the POSIX standard, although implemented in several systems, e.g., GNU coreutils in 1997,<ref>{{cite web |url=http://git.savannah.gnu.org/cgit/coreutils.git/commit/src/ls.c?id=b76a4533046163978f7517f9ea6d3307bfa0a98a |title=(decode_switches): -h and -H override output units. |publisher=coreutils.git |date=1997-12-31 |access-date=2014-11-05 |archive-date=2019-12-10 |archive-url=https://web.archive.org/web/20191210055340/https://git.savannah.gnu.org/cgit/coreutils.git/commit/src/ls.c?id=b76a4533046163978f7517f9ea6d3307bfa0a98a |url-status=live }}</ref> FreeBSD 4.5 in 2002,<ref>{{cite web |url=https://svnweb.freebsd.org/base?view=revision&revision=88591 |title=[base] Log of /stable/10/bin/ls/ls.c |date=2001-12-28 |access-date=2014-11-05 |archive-date=2015-09-21 |archive-url=https://web.archive.org/web/20150921164916/http://svnweb.freebsd.org/base?view=revision |url-status=live }}</ref> and Solaris 9 in 2002.<ref>{{citation |url=http://docs.oracle.com/cd/E19683-01/806-5202/6je7shk5c/index.html |title=What's New in the Solaris 9 Operating Environment |publisher=Sun Microsystems |year=2002 |access-date=2014-11-05 |archive-date=2015-03-18 |archive-url=https://web.archive.org/web/20150318060312/http://docs.oracle.com/cd/E19683-01/806-5202/6je7shk5c/index.html |url-status=live }}</ref>

* <code>-R</code> Include files of a directory tree, '''r'''ecursively * <code>-t</code> Sort the list by modification time (default sort is alphabetically) * <code>-u</code> Sort the list by last access time * <code>-c</code> Sort the list by last attribute (status) change time * <code>-r</code> Reverse the order, for example most recent time last * <code>--full-time</code> Show times down to the millisecond instead of just the minute * <code>-1</code> One entry per line * <code>-m</code> Stream format; list items across the page, separated by commas. * <code>-g</code> Include group but not owner * <code>-o</code> Include owner but not group (when combined with <code>-g</code> both group and owner are suppressed) * <code>-d</code> Show information about a directory or symbolic link, rather than the contents of a directory or the link's target * <code>-F</code> Append a "/" to directory names, a "*" to executable files and a "@" to symbolic links

== Example == The following example shows the long form output: <syntaxhighlight lang="console"> $ ls -l drwxr--r-- 1 fjones editors 4096 Mar 2 12:52 drafts -rw-r--r-- 3 fjones editors 30405 Mar 2 12:52 edition-32 -r-xr-xr-x 1 fjones bookkeepers 8460 Jan 16 2022 edit.sh </syntaxhighlight>

Each output line includes a file type letter ('-' for file, 'd' for directory), 9 letters representing permissions, the number of hard links, owning user, owning group, size, modification date, name. In the working directory, the owner <code>fjones</code> has a directory named <code>drafts</code>, a regular file named <code>edition-32</code>, and an executable named <code>edit.sh</code> which is "old", i.e. modified more than 6 months ago as indicated by the display of the year.

<syntaxhighlight lang="console"> ┌─────────── file (not a directory) |┌─────────── read-write (no execution) permissions for the owner |│ ┌───────── read-only permissions for the group |│ │ ┌─────── read-only permissions for others |│ │ │ ┌── 3 hard links |│ │ │ │ ┌── owning user |│ │ │ │ │ ┌── owning group |│ │ │ │ │ │ ┌── file size in bytes |│ │ │ │ │ │ │ ┌── last modified on |│ │ │ │ │ │ │ │ ┌── filename -rw-r--r-- 3 fjones editors 30405 Mar 2 12:52 edition-32 </syntaxhighlight>

Some implementations support color output to indicate metadata. GNU <code>ls</code> provides the <code>--color</code> option<ref>{{Cite web |title=General output formatting (GNU Coreutils 9.1) |url=https://www.gnu.org/software/coreutils/manual/html_node/General-output-formatting.html |access-date=2023-01-07 |website=www.gnu.org |archive-date=2023-01-07 |archive-url=https://web.archive.org/web/20230107084005/https://www.gnu.org/software/coreutils/manual/html_node/General-output-formatting.html |url-status=live }}</ref> which enables using a database to control colors maintained using dircolors. FreeBSD <code>ls</code> provides the <code>-G</code> option which enables using the termcap database<ref>{{cite web |url=http://www.freebsd.org/cgi/man.cgi?query=ls |title=FreeBSD Man Pages — ls |access-date=June 23, 2013 |archive-date=September 22, 2013 |archive-url=https://web.archive.org/web/20130922040709/http://www.freebsd.org/cgi/man.cgi?query=ls |url-status=live }}</ref> The following example shows possible color output:

-rw-r--r-- 1 tsmitt nregion 26650 Dec 20 11:16 audio.ogg brw-r--r-- 1 tsmitt nregion 64 Jan 27 05:52 bd-block-device crw-r--r-- 1 tsmitt nregion 255 Jan 26 13:57 cd-character-device -rw-r--r-- 1 tsmitt nregion 290 Jan 26 14:08 image.png drwxrwxr-x 2 tsmitt nregion 48 Jan 26 11:28 di-directory -rwxrwxr-x 1 tsmitt nregion 29 Jan 26 14:03 ex-executable -rw-r--r-- 1 tsmitt nregion 0 Dec 20 09:39 fi-regular-file lrwxrwxrwx 1 tsmitt nregion 3 Jan 26 11:44 ln-soft-link -> dir lrwxrwxrwx 1 tsmitt nregion 15 Dec 20 10:57 or-orphan-link -> mi-missing-link drwxr-xrwx 2 tsmitt nregion 4096 Dec 20 10:58 ow-other-writeable-dir prw-r--r-- 1 tsmitt nregion 0 Jan 26 11:50 pi-pipe -rwxr-sr-x 1 tsmitt nregion 0 Dec 20 11:05 sg-setgid srw-rw-rw- 1 tsmitt nregion 0 Jan 26 12:00 so-socket drwxr-xr-t 2 tsmitt nregion 4096 Dec 20 10:58 st-sticky-dir -rwsr-xr-x 1 tsmitt nregion 0 Dec 20 11:09 su-setuid -rw-r--r-- 1 tsmitt nregion 10240 Dec 20 11:12 compressed.gz drwxrwxrwt 2 tsmitt nregion 4096 Dec 20 11:10 tw-sticky-other-writeable-dir

== See also == * {{Annotated link|stat (Unix)}} * {{Annotated link|chown}} * {{Annotated link|chgrp}} * {{Annotated link|du (Unix)}} * {{Annotated link|mdls}} * {{Annotated link|User identifier (Unix)}} * {{Annotated link|Group identifier (Unix)}} * {{Annotated link|List of POSIX commands}} * {{Annotated link|Unix directory structure}}

== References == {{Reflist}}

== External links == {{Wikibooks|Guide to Unix|Commands}} * {{man|cu|ls}} * {{man|1|ls|FreeBSD}} * {{man|1|ls|NetBSD}} * {{man|1|ls|OpenBSD}} * {{man|1|ls|Solaris}} * {{man|1|ls|Linux}} * {{man|1|ls|Plan 9}} * {{man|1|ls|Inferno}} * [http://ftp.gnu.org/pub/gnu/coreutils/ GNU <code>ls</code> source code (as part of coreutils)] * [http://wiki.linuxquestions.org/wiki/Ls <code>ls</code>] at the LinuxQuestions.org wiki

Category:Multics commands Category:Standard Unix programs Category:Unix SUS2008 utilities Category:Plan 9 commands Category:Inferno (operating system) commands Category:IBM i Qshell commands