nostr/nostril
1
0
Fork 0
mirror of https://github.com/jb55/nostril.git synced 2024-11-21 08:19:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

include manpage

Browse Source 
so scdoc isn't a requirement
This commit is contained in:
William Casarin 2022-11-18 16:22:47 -08:00
parent 0aaf9eb263
commit 7bd4cb1d08
2 changed files with 148 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -14,7 +14,6 @@ libsecp256k1.a
Cargo.lock Cargo.lock
Cargo.toml Cargo.toml
doc/nostril.1
*.json *.json
scripts/jb55-post scripts/jb55-post
scripts/nostr-follows scripts/nostr-follows

148
doc/nostril.1 Normal file
View File

@ -0,0 +1,148 @@
.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "nostril" "1" "1980-01-01"
.P
.SH NAME
.P
nostril - generate nostr events
.P
.SH SYNPOSIS
.P
\fBnostril\fR [OPTIONS.\&.\&.\&]
.P
.SH DESCRIPTION
.P
\fBnostril\fR is a tool that creates and signs nostr events.\&
.P
.SH OPTIONS
.P
\fB--content\fR
.RS 4
The text contents of the note
.P
.RE
\fB--dm\fR <hex pubkey>
.RS 4
Create a direct message.\& This will create a kind-4 note with the
contents encrypted>
.P
.RE
\fB--envelope\fR
.RS 4
Wrap the event with `["EVENT", .\&.\&.\& ]` for easy relaying
.P
.RE
\fB--kind\fR <number>
.RS 4
Set the kind of the note
.P
.RE
\fB--created-at\fR <unix timestamp>
.RS 4
Set the created at.\& Optional, this is set automatically.\&
.P
.RE
\fB--mine-pubkey\fR
.RS 4
Mine a pubkey.\& This may or may not be cryptographically dubious.\&
.P
.RE
\fB--pow\fR <difficulty>
.RS 4
Number of leading 0 bits of the id the mine for proof-of-work.\&
.P
.RE
\fB--tag\fR <key> <value>
.RS 4
Add a tag with a single value
.P
.RE
\fB-t\fR
.RS 4
Shorthand for --tag t <hashtag>
.P
.RE
\fB-p\fR
.RS 4
Shorthand for --tag p <hex pubkey>
.P
.RE
\fB-e\fR
.RS 4
Shorthand for --tag e <note id>
.P
.P
.RE
.SH Examples
.P
\fBGenerate an event\fR
.P
.nf
.RS 4
$ \&./nostril --sec <key> --content "this is a message"
{
"id": "da9c36bb8206e748cf136af2a43613a5ee113cb5906a09a8d3df5386039d53ab",
"pubkey": "4f6fa8547cf2888415522918175ea0bc0eb473287c5bd7cc459ca440bdf87d97",
"created_at": 1660750302,
"kind": 1,
"tags": [],
"content": "this is a message",
"sig": "3e4d7d93522e54f201a22944d4d37eb4505ef1cf91c278a3f7d312b772a6c6509d1e11f146d5a003265ae10411a20057bade2365501872d2f2f24219730eed87"
}
.fi
.RE
.P
\fBWrap event to send to a relay\fR
.P
.nf
.RS 4
$ \&./nostril --envelope --sec <key> --content "hello"
[ "EVENT",
{
"id": "ed378d3fdda785c091e9311c6e6eeb075db349a163c5e38de95946f6013a8001",
"pubkey": "fd3fdb0d0d8d6f9a7667b53211de8ae3c5246b79bdaf64ebac849d5148b5615f",
"created_at": 1649948103,
"kind": 1,
"tags": [],
"content": "hello",
"sig": "9d9a49bbc66d4782030b24c71416965e790214d02a54ab132d960c2b02def0371c3d93e5a60a285c55e99721599d1332450731e2c6bb1114b96b591c6967f872"
} ]
.fi
.RE
.P
\fBSend to a relay\fR
.P
.nf
.RS 4
nostril --envelope --sec <key> --content "this is a message" | websocat wss://relay\&.damus\&.io
.fi
.RE
.P
\fBSend a nip04 DM\fR
.P
.nf
.RS 4
nostril --envelope --dm <pubkey> --sec <key> --content "this is a secret" | websocat wss://relay\&.damus\&.io
.fi
.RE
.P
\fBMine a pubkey\fR
.P
.nf
.RS 4
nostril --mine-pubkey --pow <difficulty>
.fi
.RE
.P
\fBReply to an event.\& nip10 compliant, includes the `thread_id`\fR
.P
.nf
.RS 4
\&./nostril --envelope --sec <key> --content "this is reply message" --tag e <thread_id> --tag e <note_id> | websocat wss://relay\&.damus\&.io
.fi
.RE