Skip to content

Commit

Permalink
docs: Touch up documentation for web publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
rdmark committed Jan 25, 2025
1 parent 0e99e05 commit dd35434
Show file tree
Hide file tree
Showing 62 changed files with 997 additions and 1,583 deletions.
12 changes: 6 additions & 6 deletions doc/manpages/man1/ad.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Set metadata on files.
Show version.

> `ad -v|--version`
> `ad -v | --version`
# ad ls

Expand Down Expand Up @@ -216,24 +216,24 @@ The set utility alters metadata on files within an AFP volume.

The options are as follows:

-t \<type\>
-t <type\>

> Change a file's four character file type.
-c \<creator\>
-c <creator\>

> Change a file's four character creator type.
-l \<label\>
-l <label\>

> Change a file's color label. See list below for available colors.
-f \<flags\>
-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\>
-a <attributes\>

> Change a file's attributes. See list below for available attributes.
Uppercase letter sets the flag, lowercase removes the flag.
Expand Down
26 changes: 13 additions & 13 deletions doc/manpages/man1/addump.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,30 @@ addump - Dump AppleSingle/AppleDouble format data
It can dump various AppleSingle/AppleDouble data created by mailers,
archivers, Mac OS X, Netatalk and so on.

With no \<FILE\>|\<DIR\>, or when \<FILE\>|\<DIR\> is '-', read standard
With no <FILE\>|<DIR\>, or when <FILE\>|<DIR\> is '-', read standard
input.

# Options

`-a` \[\<FILE\>|\<DIR\>\]
`-a` \[<FILE\>|<DIR\>\]

> This is the default. Dump AppleSingle/AppleDouble data for \<FILE\> or
\<DIR\> automatically. If FILE is not in AppleSingle/AppleDouble format,
look for extended attributes, \<.AppleDouble/FILE\> and \<.\_FILE\>. If
\<DIR\>, look for extended attributes, \<DIR/.AppleDouble/.Parent\> and
\<.\_DIR\>.
> This is the default. Dump AppleSingle/AppleDouble data for <FILE\> or
<DIR\> automatically. If FILE is not in AppleSingle/AppleDouble format,
look for extended attributes, <.AppleDouble/FILE\> and <.\_FILE\>. If
<DIR\>, look for extended attributes, <DIR/.AppleDouble/.Parent\> and
<.\_DIR\>.
`-e` \<FILE\>|\<DIR\>
`-e` <FILE\>|<DIR\>

> Dump extended attributes of \<FILE\> or \<DIR\>.
> Dump extended attributes of <FILE\> or <DIR\>.
`-f` \[\<FILE\>\]
`-f` \[<FILE\>\]

> Dump \<FILE\>. Assume FinderInfo to be FileInfo.
> Dump <FILE\>. Assume FinderInfo to be FileInfo.
`-d` \[\<FILE\>\]
`-d` \[<FILE\>\]

> Dump \<FILE\>. Assume FinderInfo to be DirInfo.
> Dump <FILE\>. Assume FinderInfo to be DirInfo.
`-h, -help, --help`

Expand Down
2 changes: 1 addition & 1 deletion doc/manpages/man1/aecho.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Check to see if a particular host is up and responding to AEP packets:

# Options

`-c` \<count\>
`-c` <count\>

> Stop after *count* packets.
Expand Down
12 changes: 6 additions & 6 deletions doc/manpages/man1/afpldaptest.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ in afp.conf.

# Options

`-u` \<USER\>
`-u` <USER\>

> Show uuid for \<USER\>.
> Show uuid for <USER\>.
`-g` \<GROUP\>
`-g` <GROUP\>

> Show uuid for \<GROUP\>.
> Show uuid for <GROUP\>.
`-i` \<UUID\>
`-i` <UUID\>

> Show user, group or local-uuid for \<UUID\>.
> Show user, group or local-uuid for <UUID\>.
`-h, -?, -:`

Expand Down
8 changes: 4 additions & 4 deletions doc/manpages/man1/afppasswd.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ User Authentication Modules.
user credentials, or by local system users with no parameters to change
their own AFP passwords.

> **Note**
> **NOTE**
> With this utility you can only change the passwords used by these two
Random Number UAMs. As they provide only weak password encryption, their
Expand Down Expand Up @@ -46,7 +46,7 @@ Local user changing their own password:

> Force the current action.
`-p` \<path\>
`-p` <path\>

> Path to `afppasswd` file.
Expand All @@ -56,12 +56,12 @@ Local user changing their own password:
cracklib checking to be disabled, if the superuser does not want to have
the password run against the cracklib dictionary.

`-u` \<minimum uid\>
`-u` <minimum uid\>

> This is the minimum *user id* (uid) that `afppasswd` will use when
creating users.

`-w` \<password string\>
`-w` <password string\>

> Use string as password, instead of typing it interactively. Please use
this option only if absolutely necessary, since the password may remain
Expand Down
4 changes: 2 additions & 2 deletions doc/manpages/man1/asip-status.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ asip-status — Queries an AFP server for its capabilities
# Description

`asip-status` sends an FPGetSrvrInfo request to an AFP server at
\<HOSTNAME\>:\<PORT\> and displays the results: "Machine type", the
<HOSTNAME\>:<PORT\> and displays the results: "Machine type", the
server's name, supported AFP versions, UAMs and AFP flags, the "server
signature" and the network addresses that the server provides AFP
services on.

When you don't supply \<PORT\>, then the default AFP port, 548, will be
When you don't supply <PORT\>, then the default AFP port, 548, will be
used.

Starting with Netatalk 3.1.9, `asip-status` supports both IPv4 and IPv6.
Expand Down
10 changes: 5 additions & 5 deletions doc/manpages/man1/nbp.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ nbplkup, nbprgstr, nbpunrgstr — tools for accessing the NBP database

# Description

`nbprgstr` registers \<nbpname\> with `atalkd(8)`, at the given
\<port\>. `nbpunrgstr` informs *atalkd* that \<nbpname\> is no longer to
`nbprgstr` registers <nbpname\> with `atalkd(8)`, at the given
<port\>. `nbpunrgstr` informs *atalkd* that <nbpname\> is no longer to
be advertised.

`nbplkup` displays up to \<maxresponses\> (default 1000) entities
registered on the AppleTalk internet. *\<nbpname\>* is parsed by
`nbplkup` displays up to <maxresponses\> (default 1000) entities
registered on the AppleTalk internet. *<nbpname\>* is parsed by
`nbp_name(3)`. An \`*=*' for the *object* or *type* matches anything,
and an \`*\**' for *zone* means the local zone. The default values are
taken from the *NBPLKUP* environment variable, parsed as an \<nbpname\>.
taken from the *NBPLKUP* environment variable, parsed as an <nbpname\>.

# Environment Variables

Expand Down
6 changes: 3 additions & 3 deletions doc/manpages/man1/pap.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ sending `lpd(8)` spooled print jobs to AppleTalk connected printers. See

# Options

`-A` \<address\>
`-A` <address\>

> Connect to the printer with Appletalk address *address* and do not
consult the `.paprc` file to find a printer name. See `atalk_aton(3)`
Expand Down Expand Up @@ -58,13 +58,13 @@ client side should wait for the printer to return EOF before closing the
connection. Some clients don't wait, and hence some printers have
related bugs in their implementation.

`-p` \<nbpname\>
`-p` <nbpname\>

> Connect to the printer named *nbpname* and do not consult the `.paprc`
file to find a printer name. See `nbp_name(3)` for the syntax of
*nbpname*.

`-s` \<statusfile\>
`-s` <statusfile\>

> Update the file called *statusfile* to contain the most recent status
message from the printer. `pap` gets the status from the printer when it
Expand Down
2 changes: 1 addition & 1 deletion doc/manpages/man4/atalk.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ libraries; and ADSP is planned.
# Addressing

AppleTalk addresses are three byte quantities, stored in network byte
order. The include file \<*netatalk/at.h*\> defines the AppleTalk
order. The include file <*netatalk/at.h*\> defines the AppleTalk
address format.

Sockets in the AppleTalk protocol family use the following address
Expand Down
Loading

0 comments on commit dd35434

Please sign in to comment.