Skip to content

Commit 6171284

Browse files
committed
docs: standardize man page trailers with AUTHORS, COPYRIGHT, and SEE ALSO
Reorganize the trailing sections of all three man pages (bssh.1, bssh-keygen.1, bssh-server.8) into a consistent BUGS / AUTHORS / COPYRIGHT / SEE ALSO order matching common Unix manual conventions. Author attribution, contact email, Apache-2.0 license notice with the standard "no warranty" disclaimer, and the project homepage link are now uniform across all three pages.
1 parent b4e3195 commit 6171284

3 files changed

Lines changed: 61 additions & 34 deletions

File tree

docs/man/bssh-keygen.1

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -221,12 +221,6 @@ Successful key generation.
221221
.B 1
222222
Error occurred (invalid options, write failure, etc.)
223223

224-
.SH SEE ALSO
225-
.BR bssh (1),
226-
.BR bssh-server (8),
227-
.BR ssh-keygen (1),
228-
.BR ssh (1)
229-
230224
.SH COMPATIBILITY
231225
Keys generated by bssh-keygen are fully compatible with OpenSSH and can be used with:
232226
.IP \(bu 2
@@ -242,4 +236,22 @@ Any SSH implementation supporting OpenSSH key formats
242236
Report bugs at https://github.com/lablup/bssh/issues
243237

244238
.SH AUTHORS
245-
Lablup Inc. <https://lablup.com>
239+
Written by Jeongkyu Shin <inureyes@gmail.com> and the Lablup team.
240+
.br
241+
Developed and maintained by Lablup Inc. <https://lablup.com> as part of the Backend.AI project.
242+
243+
.SH COPYRIGHT
244+
Copyright (C) 2025 Lablup Inc. and Jeongkyu Shin.
245+
.br
246+
License: Apache-2.0
247+
.br
248+
This is free software: you are free to change and redistribute it.
249+
There is NO WARRANTY, to the extent permitted by law.
250+
251+
.SH SEE ALSO
252+
.BR bssh (1),
253+
.BR bssh-server (8),
254+
.BR ssh-keygen (1),
255+
.BR ssh (1)
256+
257+
Project homepage: https://github.com/lablup/bssh

docs/man/bssh-server.8

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,14 +280,26 @@ Successful operation.
280280
.B 1
281281
Error occurred (configuration error, runtime error, etc.)
282282

283+
.SH BUGS
284+
Report bugs at https://github.com/lablup/bssh/issues
285+
286+
.SH AUTHORS
287+
Written by Jeongkyu Shin <inureyes@gmail.com> and the Lablup team.
288+
.br
289+
Developed and maintained by Lablup Inc. <https://lablup.com> as part of the Backend.AI project.
290+
291+
.SH COPYRIGHT
292+
Copyright (C) 2025 Lablup Inc. and Jeongkyu Shin.
293+
.br
294+
License: Apache-2.0
295+
.br
296+
This is free software: you are free to change and redistribute it.
297+
There is NO WARRANTY, to the extent permitted by law.
298+
283299
.SH SEE ALSO
284300
.BR bssh (1),
285301
.BR bssh-keygen (1),
286302
.BR sshd (8),
287303
.BR ssh (1)
288304

289-
.SH BUGS
290-
Report bugs at https://github.com/lablup/bssh/issues
291-
292-
.SH AUTHORS
293-
Lablup Inc. <https://lablup.com>
305+
Project homepage: https://github.com/lablup/bssh

docs/man/bssh.1

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1844,26 +1844,6 @@ Backend.AI node role (main/sub)
18441844
SSH agent socket path. When set, bssh can automatically detect and use
18451845
the SSH agent for authentication without specifying the -A flag
18461846

1847-
.SH AUTHOR
1848-
Written by Jeongkyu Shin and the Lablup team.
1849-
.br
1850-
Developed and maintained as part of the Backend.AI project.
1851-
1852-
.SH REPORTING BUGS
1853-
Report bugs to: https://github.com/lablup/bssh/issues
1854-
1855-
.SH COPYRIGHT
1856-
Copyright � 2025 Lablup Inc. and Jeongkyu Shin
1857-
.br
1858-
Licensed under the Apache License, Version 2.0
1859-
1860-
.SH SEE ALSO
1861-
.BR ssh (1),
1862-
.BR scp (1),
1863-
.BR sftp (1),
1864-
.BR ssh-agent (1),
1865-
.BR ssh-keygen (1)
1866-
18671847
.SH NOTES
18681848
.SS Breaking Changes (v0.5.3+)
18691849
.TP
@@ -1928,6 +1908,29 @@ File transfers use SFTP protocol which provides secure and reliable transfers.
19281908
The parallel transfer capability allows simultaneous uploads/downloads to multiple nodes,
19291909
significantly reducing total transfer time for cluster-wide file distribution or collection.
19301910

1931-
For more information and documentation, visit:
1911+
.SH REPORTING BUGS
1912+
Report bugs to: https://github.com/lablup/bssh/issues
1913+
1914+
.SH AUTHORS
1915+
Written by Jeongkyu Shin <inureyes@gmail.com> and the Lablup team.
1916+
.br
1917+
Developed and maintained as part of the Backend.AI project.
1918+
1919+
.SH COPYRIGHT
1920+
Copyright (C) 2025 Lablup Inc. and Jeongkyu Shin.
1921+
.br
1922+
License: Apache-2.0
19321923
.br
1933-
https://github.com/lablup/bssh
1924+
This is free software: you are free to change and redistribute it.
1925+
There is NO WARRANTY, to the extent permitted by law.
1926+
1927+
.SH SEE ALSO
1928+
.BR ssh (1),
1929+
.BR scp (1),
1930+
.BR sftp (1),
1931+
.BR ssh-agent (1),
1932+
.BR ssh-keygen (1),
1933+
.BR bssh-keygen (1),
1934+
.BR bssh-server (8)
1935+
1936+
Project homepage: https://github.com/lablup/bssh

0 commit comments

Comments
 (0)