Skip to content

Commit b5b937c

Browse files
committed
README: unify command line instructions
* Unify the convention for which `#` and `$` indicate whether the command requires super-user permission * Break off `apt install` instructions on multiple lines, and sort package names.
1 parent 1e4b6d1 commit b5b937c

File tree

1 file changed

+41
-17
lines changed

1 file changed

+41
-17
lines changed

README

+41-17
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,31 @@ list is available below.
2222

2323
[source, console]
2424
----
25-
$ sudo apt install libpam-u2f pamu2fcfg
25+
# apt install libpam-u2f pamu2fcfg
2626
----
2727

2828
Additionally, Yubico maintains a PPA with up-to-date versions of pam-u2f.
2929

3030
[source, console]
3131
----
32-
$ sudo apt install software-properties-common
33-
$ sudo apt-add-repository ppa:yubico/stable
34-
$ sudo apt update
35-
$ sudo apt install libpam-u2f pamu2fcfg
32+
# apt install software-properties-common
33+
# apt-add-repository ppa:yubico/stable
34+
# apt update
35+
# apt install libpam-u2f pamu2fcfg
3636
----
3737

3838
=== Fedora
3939

4040
[source, console]
4141
----
42-
$ sudo dnf install pam-u2f pamu2fcfg
42+
# dnf install pam-u2f pamu2fcfg
4343
----
4444

4545
=== macOS
4646

4747
[source, console]
4848
----
49-
$ brew install pam-u2f
49+
brew install pam-u2f
5050
----
5151

5252
[[building]]
@@ -62,16 +62,23 @@ installed using
6262

6363
[source, console]
6464
----
65-
# apt install --no-install-recommends autoconf automake libtool pkg-config \
66-
libfido2-dev libpam-dev libssl-dev
65+
# apt install --no-install-recommends \
66+
autoconf \
67+
automake \
68+
libfido2-dev \
69+
libpam-dev \
70+
libssl-dev \
71+
libtool \
72+
pkg-config \
73+
;
6774
----
6875

6976
If you downloaded a tarball, build it as follows.
7077

7178
[source, console]
7279
----
73-
$ ./configure
74-
$ make
80+
./configure
81+
make
7582
----
7683

7784
Once the module is built, copy the file `pam_u2f.so` to the correct
@@ -102,18 +109,35 @@ $ cd pam-u2f
102109
the necessary dependencies can be installed using
103110

104111
[source, console]
105-
----
106-
# apt install --no-install-recommends autoconf automake libtool \
107-
pkg-config libfido2-dev libpam-dev libssl-dev asciidoc xsltproc \
108-
libxml2-utils docbook-xml
112+
----sh
113+
# apt install --no-install-recommends
114+
asciidoc \
115+
autoconf \
116+
automake \
117+
docbook-xml \
118+
libfido2-dev \
119+
libpam-dev \
120+
libssl-dev \
121+
libtool \
122+
libxml2-utils \
123+
pkg-config \
124+
xsltproc \
125+
;
109126
----
110127

111128
On Fedora, the necessary dependencies can be installed using
112129

113130
[source, console]
114131
----
115-
# dnf -y install autoconf automake libtool libfido2-devel pam-devel \
116-
openssl-devel asciidoc
132+
# dnf -y install \
133+
asciidoc \
134+
autoconf \
135+
automake \
136+
libfido2-devel \
137+
libtool \
138+
openssl-devel \
139+
pam-devel \
140+
;
117141
----
118142

119143
Generate the build system using:

0 commit comments

Comments
 (0)