Manual Reference Pages - SMUGFS (4)
smugfs - file system access to SmugMug photo sharing
Smugfs is a user-level file system that provides access to images
stored on the SmugMug photo sharing service.
It logs in after
obtaining a password from
keypattern (if any)
as key criteria
smugfs serves a virtual directory tree mounted at
/n/smug) and posted at
srvname , if the
-s option is given.
The directory tree is arranged in five levels:
root, user, category, album, and image.
/n/smug/cmac/ is a user directory,
/n/smug/cmac/People/ is a category directory,
/n/smug/cmac/People/Friends/ is an album directory,
/n/smug/cmac/albums/Friends/2631/ is an image directory.
SmugMug allows fine-grained classification
via subcategories, but subcategories are not yet implemented.
All directories contain a special control file named
ctl; text commands written to
smugfss behavior or implement functionality
that does not fit nicely into the file system
Smugfs caches information about users, categories, albums,
and images. If changes are made outside of
smugfs (for example, using a web browser),
the cache may need to be discarded.
Writing the string
sync to a directorys
ctl file causes
smugfs to discard all cached information used to
present that directory and its children.
sync to the root
ctl file discards all of
smugfs s cached information.
The root directory contains directories
named after users.
By default, it contains only a directory for
the logged-in user, but other directories will
be created as needed to satisfy directory lookups.
In addition to user directories, the root directory
contains three special files:
rpclog returns a list of recent RPCs issued to the SmugMug API server.
Reads at the end of the file block until a new RPC is issued.
uploads file lists the file upload queue (q.v.).
User directories contain category directories
named after the categories.
SmugMug pre-defines a variety of categories,
so it is common to have many categories that
do not contain albums.
In a user directory, creating a new directory
creates a new category on SmugMug.
Similarly, renaming or removing a category
directory renames or removes the category on SmugMug.
Categories cannot be removed if they contain albums.
User directories also contain a directory
albums that itself contains all of that users albums.
Each category directory contains album directories
named using the albums title.
In a category directory, creating a new directory
creates a new album on SmugMug.
Similarly, renaming or removing an album directory
renames or removes the album on SmugMug.
Albums cannot be removed if they contain images.
Each album directory contains image directories
named using the images decimal SmugMug ID.
Image directories cannot be created or renamed,
but they can be removed. Removing an image directory
removes the image from the album on SmugMug.
Album directories also contain three special files,
settings file contains the album settings in textual form,
one setting per line.
Each line represents a single setting and is formatted
as an alphabetic setting name followed by a single tab
followed by the value.
Many settings can be changed by writing new setting lines,
in the same format, to the
Copying a file into the album directory queues it for
uploading to SmugMug to be added to the album.
Files disappear from the album directory once they
have finished uploading, replaced by new image directories.
uploads file in the root directory lists all pending uploads,
which are stored temporarily
Each image directory contains an image file, named
with its original name, if available.
If the image belongs to another user, SmugMug does not
expose the original name, so the file is named
nnnn is the SmugMug image ID number.
The file content is the original image
or else the largest image available.
The directory contains a
settings file holding per-image settings, similar to the
file in the album directory;
url file, containing URLs to the various sized images
on the SmugMug server.
/n/smug; the current user must have write access to
Watch API calls as they execute:
% cat /n/smug/rpclog &
Create a new album in the Vacation category
and fill it with photos:
% mkdir /n/smug/you/Vacation/Summer
% cp *.jpg /n/smug/you/Vacation/Summer
The photos are now uploading in the background.
Wait for the uploads to finish:
% while(test -s /n/smug/uploads) sleep 60
Make the album publicly viewable and share it.
% echo public 1 >/n/smug/you/Vacation/Summer/settings
% cat /n/smug/you/Vacation/Summer/url | mail friends
If multiple categories or albums have the same name,
only one will be accessible via the file system interface.
Renaming the accessible one via
will resolve the problem.
Boolean values appear as
false in settings files but must be changed using
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.