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

f.lux 37.7 - Adjusts the color of your d...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
BBEdit 11.6.1 - Powerful text and HTML e...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
ScreenFlow 6.1 - Create screen recording...
ScreenFlow is powerful, easy-to-use screencasting software for the Mac. With ScreenFlow you can record the contents of your entire monitor while also capturing your video camera, microphone and your... Read more
Microsoft Office 2016 15.25 - Popular pr...
Microsoft Office 2016 - Unmistakably Office, designed for Mac. The new versions of Word, Excel, PowerPoint, Outlook and OneNote provide the best of both worlds for Mac users - the familiar Office... Read more
FileZilla 3.21.0 - Fast and reliable FTP...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface. Version 3.21.0: Fixed Vulnerabilities Fixed a string format... Read more
Fantastical 2.2.5 - Create calendar even...
Fantastical 2 is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
The Hit List 1.1.26 - Advanced reminder...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more
Typinator 6.10 - Speedy and reliable tex...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
EtreCheck 3.0.2 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
FileZilla 3.21.0 - Fast and reliable FTP...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface. Version 3.21.0: Fixed Vulnerabilities Fixed a string format... Read more

Ruismaker FM (Music)
Ruismaker FM 1.0 Device: iOS Universal Category: Music Price: $4.99, Version: 1.0 (iTunes) Description: Following up on the success of Ruismaker, here's her crazy twin-sister, designed for people who want to design their own... | Read more »
Space Marshals 2 (Games)
Space Marshals 2 1.0.15 Device: iOS iPhone Category: Games Price: $5.99, Version: 1.0.15 (iTunes) Description: The sci-fi wild west adventure in outer space continues with Space Marshals 2. This tactical top-down shooter puts you in... | Read more »
Dungeon Warfare (Games)
Dungeon Warfare 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: Dungeon Warfare is a challenging tower defense game where you become a dungeon lord to defend your dungeon against greedy... | Read more »
Solitairica (Games)
Solitairica 1.0.7 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.7 (iTunes) Description: Solitairica takes RPG combat and challenging rogue-like progression to a fresh new place—the world of solitaire! | Read more »
Bowmasters tips, tricks and hints
At least for this writer, archery was one of the more pleasant surprises of the 2016 Rio Olympics. As opposed to target shooting with guns, which was dreadfully boring, watching people shoot arrows at targets was pretty darn cool. [Read more] | Read more »
Best apps for watching live TV
The Olympics have come and gone, leaving nearly everyone in a temporary state of "What the heck am I going to watch on TV right now?" Besides old reruns of Golden Girls, but that goes without saying. [Read more] | Read more »
What is Flip Diving, and why has it take...
Move over Pokemon GO. There's a new king in town, and it's "the world's #1 cliff diving game." [Read more] | Read more »
5 places where Pokemon GO is still numbe...
In the U.S., the bloom is off the Pokemon Go rose ever so slightly. It's still doing great, sitting atop the top grossing chart as it has for some time, but it's no longer among the top 10 free apps in downloads, possibly because darn near... | Read more »
Madden NFL Mobile: How defense has chang...
Saying that defense is not a priority in Madden NFL Mobile is a bit of an understatement. In asynchronous head-to-head play, you don't take control of your defenders at all, as the AI manages them while your opponent plays offense. When it's your... | Read more »
Feed Hawk (News)
Feed Hawk 1.0.1 Device: iOS Universal Category: News Price: $2.99, Version: 1.0.1 (iTunes) Description: Feed Hawk makes it easy to subscribe to the RSS feed of the website you are visiting. From within Safari, simply open a share... | Read more »

Price Scanner via MacPrices.net

Will We See A 10.5″ iPad Pro in 2017? – The ‘...
A MacRumors report, cites a research note from KGI Securities analyst Ming-Chi Kuo, saying a new size iPad model is in the works. According to the highly respected Cho, who has a strong track record... Read more
IOGEAR USB-C Docking Station Transforms Lapto...
IOGEAR has announced the launch of its innovative USB-C Docking Station with Power Delivery which turns USB-C enabled laptops into desktop workstations. The new IOGEAR USB-C Docking Station features... Read more
12-inch Retina MacBooks on sale for up to $10...
Amazon has 2016 12″ Apple Retina MacBooks on sale for $100 off MSRP. Shipping is free: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100 off MSRP - 12″ 1.1GHz Silver Retina MacBook: $1224.99 $75 off... Read more
13-inch 2.5GHz MacBook Pro (Apple refurbished...
Apple has Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 3.1GHz iMac 4K: $1379 $120 off MSRP - 21″ 2.8GHz iMac: $1199.99 $100 off MSRP - 21″ 1... Read more
Typinator 6.10 comes with 50 improvements – G...
Ergonis Software today announced release of Typinator 6.10, a new version of their text expander utility for macOS. Typinator 6.10 comes with 50 improvements, including new features, compatibility... Read more
Taxi Sim 2016 Puts Users Behind the Wheel in...
Ovilex Soft today announces Taxi Sim 2016, an update to their ultra-realistic 3D driving simulator app for iOS and Android devices — literally a global event what with the company’s nearly 450,000... Read more
11-inch 1.6GHz/128GB MacBook Air on sale for...
Amazon has the current-generation 11″ 1.6GHz/128GB MacBook Air (sku MJVM2LL/A) on sale for $788 for a limited time. Their price is $111 off MSRP, and it’s the lowest price available for this model. Read more
Apple refurbished Mac minis available for up...
Apple has Certified Refurbished Mac minis available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz Mac mini: $419 $80 off MSRP - 2.6GHz Mac... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more

Jobs Board

*Apple* Retail - Multiple Positions Akron, O...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Simply Mac *Apple* Specialist- Repair Techn...
…The Technician is a master at working with our customers to diagnose and repair Apple devices in a manner that exceeds the expectations set forth by Apple Read more
*Apple* Retail - Multiple Positions Germanto...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Professional Learning Specialist - A...
# Apple Professional Learning Specialist Job Number: 51234379 Portland, Maine, Maine, United States Posted: Aug. 18, 2016 Weekly Hours: 40.00 **Job Summary** The Read more
Lead *Apple* Solutions Consultant - Apple (...
# Lead Apple Solutions Consultant Job Number: 51218465 Richmond, VA, Virginia, United States Posted: Aug. 18, 2016 Weekly Hours: 40.00 **Job Summary** The Lead ASC Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.