Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
NAD(1)			 Netatalk AFP Fileserver Manual 		  NAD(1)

Name
     nad - Netatalk AppleDouble file utility suite

Synopsis
     nad [-F configfile] [ls | cp | mv | rm | mkdir | rmdir | set | find] [a|]

     nad [-v | --version]

Description
     nad  is a file utility suite that can be used on a Netatalk host to manipu-
     late files and directories in AFP shared volumes.	AppleDouble data,  which
     could be one of extended attributes of files, ._ files, or files in .Apple-
     Double directories, as well as the CNID databases are updated appropriately
     when files in the shared Netatalk volume are modified.

     Using  nad  is preferable over the operating system's native file operation
     commands on files and directories in a Netatalk shared volume,  because  it
     preserves	the  integrity of Mac OS metadata and accuracy of the CNID data-
     base.

     It depends on Netatalk running on the host system and the AFP volume  being
     shared by Netatalk.

     Only users with appropriate permissions to access the files and directories
     can  use nad to manipulate them.  It is sensitive to afp.conf settings such
     as valid users and invalid users.

Options
     -F configfile

	    Use configfile as the full path to the Netatalk configuration file.

Available Commands
     List files and directories.

	    nad ls [-adlRu] {file|directory [a|]}

     Copy files and directories.

	    nad cp [-aipvf] {src_file} {dst_file}

	    nad cp -R [-aipvf] {src_file|src_directory a|} {dst_directory}

     Move files and directories.

	    nad mv [-finv] {src_file} {dst_file}

	    nad mv [-finv] {src_file|src_directory a|} {dst_directory}

     Remove files and directories.

	    nad rm [-Rv] {file|directory}

     Create directories.

	    nad mkdir [-pv] {directory [a|]}

     Remove empty directories.

	    nad rmdir [-pv] {directory [a|]}

     Set metadata on files.

	    nad set [-t type] [-c creator] [-l label] [-f flags] [-a attributes]
	    {file}

     Find files and directories.

	    nad find [-v volume_path] {name}

     Show version.

	    nad -v | --version

nad ls
     List files and directories in an  AFP  volume.   AppleDouble  metadata  and
     CNIDs are displayed in long output mode.

     Options:

     -a

	    Include directory entries whose names begin with a dot (.)

     -d

	    Directories are listed as plain files

     -l

	    Long output, list AFP info

     -R

	    List subdirectories recursively

     -u

	    List UNIX info

     Long output description

	    <unixinfo> <FinderFlags> <AFP Attributes> <Color> <Type> <Creator> <CNID from AppleDouble> <name>

	    FinderFlags (valid for (f)iles and/or (d)irectories):

	      d = On Desktop			  (f/d)
	      e = Hidden extension		  (f/d)
	      m = Shared (can run multiple times) (f)
	      n = No INIT resources		  (f)
	      i = Inited			  (f/d)
	      c = Custom icon			  (f/d)
	      t = Stationery			  (f)
	      s = Name locked			  (f/d)
	      b = Bundle			  (f/d)
	      v = Invisible			  (f/d)
	      a = Alias file			  (f/d)

	    AFP Attributes:

	      y = System			  (f/d)
	      w = No write			  (f)
	      p = Needs backup			  (f/d)
	      r = No rename			  (f/d)
	      l = No delete			  (f/d)
	      o = No copy			  (f)

	    Note: any letter appearing in uppercase means the flag is set but it's a directory for which the flag is not allowed.

nad cp
     Copy files and directories in an AFP volume.

     In  the  first  synopsis  form,  the  cp utility copies the contents of the
     src_file to the dst_file. In the second synopsis form, the contents of each
     named src_file is copied to the destination dst_directory. The names of the
     files themselves are not changed. If cp detects an attempt to copy  a  file
     to itself, the copy will fail.

     When  a  copy targeting an AFP volume is detected, its CNID database daemon
     is connected and all copies will also go through the CNID database.  Apple-
     Double data are also copied and created as needed when the target is an AFP
     volume.

     Options:

     -a

	    Archive mode. Same as -Rp.

     -f

	    For  each  existing destination pathname, remove it and create a new
	    file, without prompting for confirmation regardless of  its  permis-
	    sions. (The -f option overrides any previous -i or -n options.)

     -i

	    Cause cp to write a prompt to the standard error output before copy-
	    ing  a  file  that would overwrite an existing file. If the response
	    from the standard input begins with the character `y'  or  `Y',  the
	    file  copy is attempted. (The -i option overrides any previous -f or
	    -n options.)

     -n

	    Do not overwrite an existing file. (The -n option overrides any pre-
	    vious -f or -i options.)

     -p

	    Cause cp to preserve the following attributes of each source file in
	    the copy: modification time, access time,  file  flags,  file  mode,
	    user ID, and group ID, as allowed by permissions. If the user ID and
	    group  ID cannot be preserved, no error message is displayed and the
	    exit value is not altered.

     -R

	    If src_file designates a directory, cp copies the directory and  the
	    entire subtree connected at that point. If the src_file ends in a /,
	    the  contents  of the directory are copied rather than the directory
	    itself.

     -v

	    Cause cp to be verbose, showing files as they are copied.

     -x

	    File system mount points are not traversed.

nad mv
     Move files and directories.

     Move files around within an AFP  volume,  updating  the  CNID  database  as
     needed. If either condition below is true, the files are copied and removed
     from the source.

     * source or destination is not an AFP volume

     * source AFP volume != destination AFP volume

     Options:

     -f

	    Do	not  prompt  for confirmation before overwriting the destination
	    path.  (The -f option overrides any previous -i or -n options.)

     -i

	    Cause mv to write a prompt to standard error before  moving  a  file
	    that  would  overwrite  an	existing  file. If the response from the
	    standard input begins with the character `y' or `Y', the move is at-
	    tempted.  (The -i option overrides any previous -f or -n options.)

     -n

	    Do not overwrite an existing file. (The -n option overrides any pre-
	    vious -f or -i options.)

     -v

	    Cause mv to be verbose, showing files after they are moved.

nad rm
     Remove files and directories in an AFP volume.

     The rm utility attempts to remove the non-directory type files specified on
     the command line.	The corresponding CNIDs are deleted  from  the	volume's
     database, and AppleDouble metadata is removed.

     The options are as follows:

     -R

	    Attempt to remove the file hierarchy rooted in each file argument.

     -v

	    Be verbose when deleting files, showing them as they are removed.

nad mkdir
     Create  directories in an AFP volume.  The corresponding CNIDs are added to
     the volume's database, and AppleDouble metadata is initialized.

     The options are as follows:

     -p

	    Create intermediate directories as required.  If an intermediate  or
	    the target directory already exists, it is not considered an error.

     -v

	    Be	verbose when creating directories, showing them as they are cre-
	    ated.

nad rmdir
     Remove empty directories in an AFP volume.   The  corresponding  CNIDs  are
     deleted from the volume's database, and AppleDouble metadata is removed.

     The volume root directory and its parent directories cannot be removed.

     The options are as follows:

     -p

	    Each  operand  is treated as a pathname of which all components will
	    be removed, if they are empty, starting with the  last  most  compo-
	    nent.  Will not remove the volume root directory or its parents.

     -v

	    Be	verbose  when removing directories, showing them as they are re-
	    moved.

nad set
     Set metadata on files.

     The set utility alters metadata on files within an AFP volume.

     The options are as follows:

     -t type

	    Change a file's four character file type.

     -c creator

	    Change a file's four character creator type.

     -l label

	    Change a file's color label. See list below for available colors.

     -f flags

	    Change a file's Finder flags. See list below  for  available  flags.
	    Uppercase letter sets the flag, lowercase removes the flag.

     -a attributes

	    Change a file's attributes. See list below for available attributes.
	    Uppercase letter sets the flag, lowercase removes the flag.

   Flag descriptions
	    Color Labels:

	      none | grey | green | violet | blue | yellow | red | orange

	    Finder Flags (valid for (f)iles and/or (d)irectories):

	      d = On Desktop			  (f/d)
	      e = Hidden extension		  (f/d)
	      m = Shared (can run multiple times) (f)
	      n = No INIT resources		  (f)
	      i = Inited			  (f/d)
	      c = Custom icon			  (f/d)
	      t = Stationery			  (f)
	      s = Name locked			  (f/d)
	      b = Bundle			  (f/d)
	      v = Invisible			  (f/d)
	      a = Alias file			  (f/d)

	    AFP Attributes:

	      y = System			  (f/d)
	      w = No write			  (f)
	      p = Needs backup			  (f/d)
	      r = No rename			  (f/d)
	      l = No delete			  (f/d)
	      o = No copy			  (f)

nad find
     Find files and directories in an AFP volume.

     This returns a list of paths that wholly or partially match the given name.

     It takes one option:

     -v path

	    Use  path  to  the	shared	volume to search rather than the current
	    working directory.

Examples
     List files in a shared AFP volume:

	    $ nad ls -al /srv/afpshare
	    ---Nic-s--- ------ --- ---- ----	       2   .
	    ----------- ------ --- ---- ----	       1   ..
	    ----i---b-- ------ --- APPL SBMC	      40   AppleShare IP Browser
	    ---------v- ------ --- ---- ----	      36   Network Trash Folder
	    -------s-v- ------ --- ---- ----	      35   TheVolumeSettingsFolder
	    ----ic-s--- ------ gre PNGf GKON	      39   picture 1.png
	    ----ic----- ------ --- PNGf GKON	      41   picture 2.png
	    ----ic----- ------ --- PNGf GKON	      42   picture 3.png

     Legend:

     * column 1: Finder flags

     * column 2: AFP attributes

     * column 3: color label

     * column 4: type

     * column 5: creator

     * column 6: CNID from AppleDouble

     * column 7: file name

     Find files with "Report" in the name in the shared AFP volume at  /srv/afp-
     share:

	    $ nad find -v /srv/afpshare Report
	    /srv/afpshare/Documents/2025/Report January 2025.doc
	    /srv/afpshare/Documents/2024/Report December 2024.doc
	    /srv/afpshare/Documents/Report Template.doc

See also
     dbd(1), addump(1)

Author
     Contributors to the Netatalk Project (https://netatalk.io/contributors)

Netatalk 4.5.0								  NAD(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nad&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help