TweetFollow Us on Twitter

Command Line Interface

Volume Number: 16 (2000)
Issue Number: 10
Column Tag: Mac OS X

An Intro to Mac OS X's Command Line Interface

by Andrew C. Stone

Back in the mid to late eighties, DOS was king and PC users would make fun of the "MacInToy" simply because it had no expert command line interface (CLI). Of course, this was before the PC world ditched their own command line interface in favor of an uglied-down graphical user interface that poorly copied the Macintosh's finely detailed GUI. Being an old Unix weenie from the academic Computer Science scene, I can understand the argument that the command line is an extremely powerful tool for expert users and programmers. Of course I also understand that it needs to be hidden from the casual user, lest they type "rm -rf /" as root and totally erase their hard disk!

And now, the CLI is just one more compelling feature of Mac OS X. OS X is based on Darwin, Apple's version of the open source FreeBSD 3.x combined with the Carnegie Melon University Mach 3.x kernel. The command line and all the standard Unix utilities are part and parcel of the developer distribution. While it is still not clear what will or won't ship to the end user in the final OS X, DP4 gives you Terminal.app (/System/Administration/Terminal.app) to provide a "shell" allowing you to type commands directly to the computer for both interactive and batch processing. This article is an introduction into the use of the command line, and I hope to provide enough information to convince unrepentent GUI freaks that a CLI is indeed useful, and share some cool tricks, tips and information on where to go to learn more.

She Sells C-shells

Once upon a time, there was just the c-shell, /bin/csh. However, Unix hackers love to cram more and more features into any one given program, so now there are several shell programs to pick from, including: tcsh, csh, zsh and bash. When you double-click Terminal.app to launch a shell, Terminal uses your default shell as the command line interface. In a standard installation, the default shell is tcsh. Your default shell is stored in NetInfo, and can be set by editing the User in /System/Administration/NetworkManager.app. Click on "Users", then select a user, then edit the shell field to the complete path of your desired default shell. You can always switch shells on the fly by just typing the name of new shell. Each shell has its strengths and supporters - you might play around to see which one you prefer. I use bash whenever I need to be able to include newlines (returns) in a command - and it handles filenames with embedded spaces rather well. Each of the various shells share a lot in common, but syntax does vary from shell to shell, so I'll just use the most basic examples here which at least apply to csh. In any regard, launch Terminal.app so you can start to play!

Man - the manual pages

One of the Unix shell's most useful features is the builtin manual pages, which document all the commands. Before we learn about "man", a short discussion of why Unix uses such cryptic and abbreviated names is in order! If you have some familiarity with DOS, you'll know that to copy a file, you type:

   copy <FILE_1> <FILE_2>

The same command in Unix is "cp". It seems early Unix programmers hated to type and loved lacunae - and you'll learn Unix shell programming faster if you can uncover the mnemonic embedded in each command. For example, csh = C shell; mv = move; ln = link; ls = list; mkdir = make directory; etc. But the cool thing is that you don't have to remember much to use Unix because the man pages detail the use of every Unix command. For example, to learn about the manual pages, type:

   man man

You'll see something like:

MAN(1)      System Reference Manual      MAN(1)

NAME
   man - display the on-line manual pages

SYNOPSIS
   man [-achw] [-C file] [-M path] [-m path] [section] name ...

DESCRIPTION
   The man utility displays the BSD Unix manual pages 
   entitled name.

The options are as follows:

   -a Display all of the manual pages for a 
   specified section and name combination. 
   (Normally, only the first manual page found is displayed.)
   ....

When you can't remember the command that you want to learn about, you can always try the apropos command, which searches the man pages' names for the given word. For example, typing

apropos directory

gives back a list of Unix commands whose description includes "directory" (directory is the Unix term for folder).


DirHandle(3)         - supply object methods for directory handles
FindBin(3)            - Locate directory of original perl script
Tcl_TranslateFileName(3)   - convert file name to native form and replace tilde 
with home directory
basename(1), dirname(1)   - return filename or directory                                   
portion of pathname
cd(1)                  - change working directory
cd(n)                  - Change working directory
chdir(2), fchdir(2)   - change current working directory
chroot(2)               - change root directory
chroot(8)               - change root directory
dir(5), dirent(5)      - directory file format
directory(3), opendir(3), readdir(3), telldir(3), seekdir(3), rewinddir(3), 
closedir(3), dirfd(3) - directory operations
ditto(8)               - copy source directories to destination                               
directory
getcwd(3)            - get pathname of current working directory
getcwd(3), getwd(3)   - get working directory pathname
getdirentries(2)   - get directory entries in a filesystem                               
independent format
ls(1)            - list directory contents
mkdir(2)         - make a directory file
mtree(8)         - map a directory hierarchy
nifind(1)      - find a directory in the NetInfo hierarchy
pax(1)            - read and write file archives and copy                         
directory hierarchies
pwd(1)            - return working directory name
pwd(n)            - Return the current working directory
remove(3)      - remove directory entry
rm(1)            - remove directory entries
rmdir(2)         - remove a directory file
scandir(3), alphasort(3) - scan a directory
unlink(2)      - remove directory entry
whois(1)         - Internet user name directory service

Apropos reveals the rich set of commands available to both the command line user and C programmer . The number following the command indicates which man subdirectory should be consulted. To read about a man page in a particular subsection, for example, scandir(3), you'd type:

   man 3 scandir

If you just typed that in, you'll notice that it's actually a C language prototype, and not really available as a command line call! If the subdirectory is 1, it's a shell command; otherwise it's a C function. Still, most standard C library functions are exposed as callable binary programs or shell scripts.

Anatomy of a Shell Command

After looking at a few Unix man pages, you'll notice that a consistent style is used to make it easy to grasp the functionality and options of a command. The simplest example is a command which takes no flags or arguments, for example:

   date

A flag modifies how the command works and is represented by a letter or digit which follows a "-" (dash) or another flag. Arguments are input to the command, such as filenames or folders:

cp -rf /bin/cat /tmp/catty
-  - ---- -----
command  flags   argument 1         argument 2

The man page presents a synopsis of the command in a standardized notation to express when a flag or argument is optional and/or repeatable. Let's look at the first example of the synopsis of "man" to learn how to decode the notation:

man [-achw] [-C file] [-M path] [-m path] [section] name ...

Anything enclosed within "[" and "]" represents optional flags and arguments. For example you could include -a or -c or -ac or -ca or -achw as valid flags to the man command.

When a word follows a flag, you must provide an argument if you use that flag. For example [-M path] means that if you use the optional -M flag, you must follow it with a full path name.

If you see ellipses, such as at the end of the synopsis, it means you can provide any number of additional names as arguments to the command.

All of the flags and arguments are described in the body of the man page for the command. Also, at the end of the man page is a section which gives additional related commands. For instance, on man's man page, you would find:

SEE ALSO
apropos(1),  whatis(1),  whereis(1),  man.conf(5),  mdoc(7),  mdoc.samples(7)

Do a "man" on some of these to keep learning more.

Less Typing, More Power

Power users, who are always looking for ways to maximize the amount accomplished with a minimal amount of typing, use initialization files to personalize their shells. Initialization files contain environmental variables, aliases, and other customizations, such as a clever shell prompt. Each shell program looks for a different initialization file; for example, csh uses ~/.cshrc and bash uses ~/.bashrc. Extra Credit: using man, find the name of the initialization file for tsch!

Aliases are short cuts to make complex commands that you use available with just a few typed characters. For example, let's say you always want to see your directory files listed in reverse order of the time created, that is, with the newest files listed at the top with the long listing:

   ls -lt 

You could add this line to your ~/.cshrc file:

   alias lt "ls -lt"

Next time you start a c shell (or type the command "source ~/.cshrc" to reread the initialization file), when you type "lt", you'll get the equivalent of typing "ls -lt". People love to put gnarly prompt creation commands in their init files, and this example is about as scary as they get:

alias cd 'cd \!*; set currDir = 'basename $cwd'; set currDir = 'echo "<${host}:"$currDir
" ! >"'; set prompt = "${currDir} "'
cd $cwd

This produces a lovely, palatable prompt which tells you which machine you are on, which directory you are in, and the number of the current command, for example:

<hermione:Developer 24 >

Which leads us to a discussion of typing less through use of history and command substitution. Your "history" is a record of the commands you've issued. Type

   history

to see a numbered list of the commands you have typed recently:

     1  cd
     2  cd Library/Preferences/
     3  rm ApplicationCacheTheFinalChapter
     4  ps -axw | grep Mail
     5  man man
     6  apropos link
     7  apropos time
     8  apropos link
     9  apropos directory

To repeat a previous command, for example, "man man", simply type:

   !5

!5 is pronounced "BANG-5" in Unix. A "*" is "splat". A "|" is a pipe, although French Surrealist painter Renð Magritte would say, "Ce n'est pas un pipe"!

To repeat the last command issued, type:

   !!

To refer to the last argument of the last command, use"!$". For example:

   cat !$

displays the contents of the last file you referenced in your last command.

In some shells, you can use your up and down arrow keys to repeat commands issued before.

Because many shell commands operate on files, and because typing file names is tedious and prone to error, you have various shortcut options.

Most shells have builtin "escape completion" which will complete the names of files and folders if you type the first few unique characters and then type your escape completion key (this might be "ESC" or F5 or even TAB in some shells). The vanilla C shell has this turned off by default, but you can add the following line to your .cshrc file to enable escape completion:

   set filec

As of DP4, the default shell is tsch, which has escape completion on. Type two escapes if one escape doesn't complete anything.

And, for you GUI junkies, OS X lets you drag and drop files or folders from the Finder onto shells, instead of laboriously typing out entire path names. You'll even get the correct escape codes for spaces, or perhaps the whole path will be correctly quoted. Because the shell interprets "words" (alphanumberic strings separated by spaces or tabs), you need to use to either "escape" the characters with a backslash:

   cd /Mac\ OS\ X

or type it with quotes:

   cd "/Mac OS X"

Bulk Processing and Iterations

Where a CLI has it all over a GUI is when you need to perform some boring, repetitve task on a bunch of files. For example, suppose you want to change the path extension of a whole folder full of files, say from ".TIF" to ".tiff" You can't do this in a GUI without an additional program, but in the C shell, you can use a simple looping shell command, using the "foreach" statement. Type:

   foreach i ( *.TIF )

At this point, you enter an interactive subshell with a new prompt, " ? ". You can type any number of commands for sequential processing, referring to the current file as $i, and the "root" of that file ($i:r), ie, the filename's full path removing it's path extension. See "man cshrc" for more info on referring to parts of a file path. Finally, when you are finished issuing commands, type end and computation begins.

? echo $i            // which file are we on? We'll print it out
? mv $i $i:r.tiff   // move that file to the same name, less extension, plus .tiff
? end                  // this terminates the loop and begins processing

Plumbing: Input, Output and Pipes

Unix is designed for hooking up the output from one process to the input of another. This is done through two basic mechanisms: redirection of standard input/standard output and pipes.

The less than symbol, "<", means take input from whatever is producing output on the right hand side of the "<". For example, you can use the command line "mail" to send ascii files:

   mail harry@stone.com < /etc/hostconfig

You can use I/O redirection whenever a command expects standard input (stdin) or produces standard output (stdout). When a process expects a feed of input, then you must rely on the chaining of processes through pipes. Pipes can be used effectively with gnutar to copy large trees of files to new locations:

   (/usr/bin/gnutar chf - Stone_CD) | (cd /BackUp; /usr/bin/gnutar xf -)

Note how you can also stage commands by separating them with a ";". Here, we are creating a new "tar" archive, changing to a new directory, and then unarchiving it to standard out, thus copying the original hierarchy of files to this new location.

Once you get the hang of Unix, you'll find that you can do all sorts of tasks. For example, the age old bean counting task of counting lines of code can be done trivially using the powerful and confusing "find" piped to the meta-command "xargs" which calls the word count program "wc". Assuming you have changed directory to the top level of your source code, type:

   find . -name '*.[hmc]' | xargs wc -l

which translates to: beginning at the top level in this current directory, recursively find all files which end in either .h, .c or .m, and use each file found as the input to the word counting program, with the option of counting only lines (not words or characters), with the bonus of providing a grand total of lines. What may look like jibberish will soon become recognizable and habitual!

And, for authors paid by the word and to honor the oft times obfuscated nature of Unix, here's an alias for your initialization file:

alias wordcount
(cat !* | tr -s '       .,;:?!()[]"' '\012' | cat -n | tail -1 | awk '{print $1}')

and you would use it in a source directory by typing:

   wordcount *.[hmc]

To go "deeper" you just add on more arguments:

   wordcount *.[hmc] */*[hmc] */*/*[hmc]

Conclusion

It takes years to learn Unix completely, but only moments to learn enough to be useful. The online man pages allow a quick refresher course in any command and are an excellent lifetime teaching tool. The shell is a power user's friend and can expand the capabilities and productivity of OS X. Granted that it is not for everyone, but for those who dare, it's a true bonus!


Andrew Stone <andrew@stone.com> is founder of Stone Design Corp <http://www.stone.com/> and has spent 12 years writing Cocoa software in its various incarnations.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Pinegrow 6.23 - Mockup and design web pa...
Pinegrow (was Pinegrow Web Designer) is desktop app that lets you mockup and design webpages faster with multi-page editing, CSS and LESS styling, and smart components for Bootstrap, Foundation,... Read more
WhatsApp 2.2149.4 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
Microsoft Remote Desktop 10.7.4 - Connec...
Microsoft Remote Desktop for Mac is an application that allows connecting to virtual apps or another PC remotely. Discover the power of Windows with Remote Desktop designed to help you manage your... Read more
ffWorks 2.6.7 - Convert multimedia files...
ffWorks, focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the command-line.... Read more
Opera 82.0.4227.58 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
Day One 6.15 - Maintain a daily journal.
Day One is an easy, great-looking way to use a journal / diary / text-logging application. Day One is well designed and extremely focused to encourage you to write more through quick Menu Bar entry,... Read more
Default Folder X 5.6.3 - Enhances Open a...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click on... Read more
OmniOutliner Pro 5.9.2 - Pro version of...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
OmniOutliner Essentials 5.9.2 - Organize...
OmniOutliner Essentials (was OmniOutliner) is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually... Read more
QuickBooks 19.0.11.984 - Financial manag...
QuickBooks helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save. Built for... Read more

Latest Forum Discussions

See All

The Best Wordle Clone in Town – The Touc...
In this week’s episode of The TouchArcade Show we dig into the drama of the moment which is the cloning and subsequent gloating about the cloning of the lovely little free word game Wordle. This leads into some additional drama about how PUGB Mobile... | Read more »
TouchArcade Game of the Week: ‘Cards Inf...
There’s nothing I love more than a perfect mobile game. What do I mean by that? Well, no game is actually perfect, but there’s something special about a game you know you can just whip out at a moment’s notice and dive into, and you know it will... | Read more »
‘Micro RPG’ Bringing Streamlined RPG Goo...
Originally announced on our forums more than 3 years ago, Micro RPG is an upcoming mobile game from a two-person studio that goes by the name JoliYeti Games and, as the title implies, it looks to offer all the fun of an RPG but in a more condensed... | Read more »
SwitchArcade Round-Up: ‘Kensei: The Seco...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for January 14th, 2022. Yesterday was a big day, but today shows that we’re still warming up the engines for this year. There are a handful of new releases, but nothing nearly as... | Read more »
Mobile MMORPG Shooter ‘Avatar: Reckoning...
Archosaur Games, Tencent, Lightstorm Entertainment, and Disney have just revealed a mobile MMORPG shooter Avatar: Reckoning. Avatar: Reckoning will be published by Level Infinite when it hits iOS and Android. It is an official Avatar game developed... | Read more »
‘Crashlands+’ Is Out Now on Apple Arcade...
The brilliant Crashlands from Butterscotch Shenanigans was confirmed to arrive on Apple Arcade as an App Store Great in the form of Crashlands+ () a little while ago and it has just released worldwide. If it isn’t live yet, it should roll out in... | Read more »
SwitchArcade Round-Up: ‘Eschatos’, ‘To B...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for January 13th, 2022. It’s a Thursday, and we’ve got a pretty hefty bag of new releases to dig into. There are always some fun surprises, and this week that came in the form of SNK Vs... | Read more »
‘Crush the Castle Legacy Collection’ Lau...
Ever since Angry Birds broke into the mainstream and became a household name more than a decade ago, there’s always been a small niche of people on the sidelines who would pipe up to remind everybody that “Crush the Castle did it first!" Indeed, the... | Read more »
Non-Violent Stealth Game ‘El Hijo – A Wi...
Over a year ago, Handy Games brought the non-violent stealth game El Hijo – A Wild West Tale to Switch, PS4, Xbox, PC, and Stadia. El Hijo – A Wild West Tale has been developed by Honig Studios and Quantumfrog. You play as El Hijo, a six year old,... | Read more »
‘ZED BLADE’ from SNK and Hamster Is Out...
After a bit of a break likely due to the holiday season, we’ve gotten a new title in the ACA NeoGeo series on iOS and Android. SNK and Hamster originally brought the series to mobile with Samurai Shodown IV, Alpha Mission II, and Metal Slug 5.... | Read more »

Price Scanner via MacPrices.net

Get an Apple Watch Series 7 for $50 off MSRP,...
Amazon has Apple Watch Series 7 models on sale for $50 off MSRP including free shipping. Their prices are the lowest available for Apple Watch Series 7 models today: – 41mm Apple Watch Series 7 GPS... Read more
Here are the details of Apple’s 2022 Educatio...
Need a new Apple Mac or iPad for school? Whether you’re a student, teacher, or staff member, you can use your .edu email address when ordering at Apple Education to take up to $400 off the price of a... Read more
Amazon is blowing out 2020 21″ iMacs for only...
Amazon has clearance 2020 21″ iMacs (2.3GHz Dual-Core i5, 8GB RAM, 256GB SSD) on sale right now for $599.99 including free shipping. Original MSRP for this model was $1099. Amazon expects delivery in... Read more
Find the best deal on an Apple MacBook using...
In the market for a new 13″ MacBook Air, 13″ MacBook Pro, 14″ MacBook Pro, or 16″ MacBook Pro with M1, M1 Pro, or M1 Max Apple Silicon? Use our Apple award-winning and exclusive price trackers to... Read more
Red Pocket Mobile is offering the Apple iPhon...
Switch to Red Pocket Mobile and get an Apple iPhone 13 Pro for $50 off MSRP, plus get free 6 months of Unlimited nationwide 5G service with the purchase of any iPhone 13. Red Pocket Mobile is a... Read more
24″ M1 iMacs on sale for $1249, $50 off Apple...
Amazon has base 24″ M1 iMacs (8-Core CPU/7-Core GPU/8GB RAM/256GB SSD) on sale today for $1249 shipped. Their price is $50 off Apple’s MSRP, and it’s the lowest price available for a new 24″ M1 iMac... Read more
Open-Box 16″ M1 Pro MacBook Pros available fo...
QuickShip Electronics has open-box return 16″ M1 Pro MacBook Pros in stock and on sale for $200-$300 off MSRP on their eBay store right now with free express delivery. According to QuickShip, “The... Read more
Stock Alert! Order a new 16″ M1 Pro MacBook P...
New 16″ MacBook Pros with Apple’s M1 Pro and M1 Max CPUs have been very hard to find, largely due to current global supply constraints. However, B&H Photo is reporting stock of Space Gray... Read more
Apple has maxed-out 13″ M1 MacBook Airs (16GB...
Save $250 on maxed-out 13″ M1 MacBook Airs today at Apple (16GB RAM/1TB SSD) with Certified Refurbished models available for $1399 in Space Gray and Gold colors. Regular price for this configuration... Read more
New promo at Xfinity Mobile: $400 off any App...
Xfinity Mobile is offering any new Apple iPhone for $400 off MSRP for new customers. This includes the iPhone 13. Price for the phone, including the discount, is spread monthly over a 24 month term... Read more

Jobs Board

Registered Nurse (RN) Employee Health PSJH -...
…is calling for a Registered Nurse (RN) Employee Health PSJH to our location in Apple Valley, CA.** We are seeking a Registered Nurse (RN) Employee Health PSJH to be Read more
Systems Administrator - Pearson (United State...
…and troubleshoot Windows operating systems (workstation and server), laptop computers, Apple iPads, Chromebooks and printers** + **Administer and troubleshoot all Read more
IT Assistant Level 1- IT Desktop Support Anal...
…providing tier-1 or better IT help desk support in a large Windows and Apple environment * Experience using IT Service Desk Management Software * Knowledge of IT Read more
Human Resources Business Partner PSJH - Provi...
…**is calling a** **Human Resources Business Partner, PSJH** **to our location in Apple Valley, CA.** **Applicants that meet qualifications will receive a text with Read more
Manager Community Health Investment Programs...
…is calling a Manager Community Health Investment Programs PSJH to our location in Apple Valley, CA.** **Qualified candidates will be invited to do a self-paced video Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.